// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

//

/**

 @file

 @internalComponent

*/

#ifndef REMCONSESSION_H

#define REMCONSESSION_H

#include <e32base.h>

#include <remconserverpanic.h>

#include <remconaddress.h>

#include <remcon/clientinfo.h>

#include <remcon/clienttype.h>

#include <remcon/playertype.h>

#include <remcon/clientid.h>

class CRemConServer;

class CBearerManager;

class CRemConMessage;

class CMessageQueue;

class CRemConInterfaceDetailsArray;

class CRemConInterfaceDetails;

/**

Rem Con session.

*/

NONSHARABLE_CLASS(CRemConSession) : public CSession2

	{

public:

	~CRemConSession();

public: // called by the server

	/** 

	@return The number of remotes the current 'send' has gone to successfully.

	*/

	inline TUint& NumRemotes();

	/** 

	@return The number of remotes the current 'send' is supposed to be going 

	to. NB This is decremented as the sends actually occur.

	*/

	inline TInt& NumRemotesToTry();

	/** 

	@return The error the current 'send' will be completed with.

	*/

	inline TInt& SendError();

	/** 

	@return Information about the client using this session.

	*/

	inline TClientInfo& ClientInfo();

	/** 

	@return Information about the client using this session.

	*/

	inline const TClientInfo& ClientInfo() const;

	/**

	@return This session's unique identifier.

	*/

	inline TUint Id() const;

	/**

	Used by the server to complete a client send request. 

	@param aError Error.					

	*/

	void CompleteSend();

	/**

	Used by the server to complete a client send notify request.

	*/

	void CompleteSendNotify();

	/** 

	Checks if this message is supported by the session

	@return ETrue if it is, EFalse otherwise

	*/

	/**

	Writes aMsg to the client's Receive message (NB RMessage2::Write may fail) 

	and completes the client's Receive message with any error.

	@return Error.

	*/

	TInt WriteMessageToClient(const CRemConMessage& aMsg);

	/**

	Accessor for the currently outstanding client Send message. This is used 

	to check the client's capabilities to send over a particular bearer.

	@return Handle to client's send message.

	*/

	inline const RMessage2& CurrentSendMessage() const;

	/**

	Accessor for the currently outstanding client Receive message.

	@return Handle to client's receive message.

	*/

	inline const RMessage2& CurrentReceiveMessage() const;

	TInt SupportedInterfaces(RArray<TUid>& aUids);

	TInt SupportedBulkInterfaces(RArray<TUid>& aUids);

	TInt SupportedOperations(TUid aInterfaceUid, RArray<TUint>& aOperations);

	/**

	Panics the client's current Send message with the given code.

	*/

	void PanicSend(TRemConClientPanic aCode);

	/**

	*/

	/**

	Indicates that a connection has come up or down. If the session has a 

	'connections notification' outstanding, it should be completed. Note that, 

	when a connection comes up or down, ConnectionsChanged is called before 

	CompleteConnect or DisconnectComplete. These functions are called 

	synchronously by the connection-handling code.

	*/

	void ConnectionsChanged();

	/**

	Utility to complete the given message with the given error code.

	@param aMessage Message to complete.

	@param aError Error to complete with.

	*/

	void CompleteClient(const RMessage2& aMessage, TInt aError);

	static TInt SendNextCb(TAny* aThis);

	CRemConServer& iServer;

	CBearerManager& iBearerManager;

	RMessage2 iSendMsg;

	RMessage2 iReceiveMsg;

	RMessage2 iNotifyConnectionsChangeMsg;

	CMessageQueue* iSendQueue;

	// The client's process ID, secure ID and caps.

	TClientInfo iClientInfo;

	// Unique session identifier.

	const TUint iId;

	// Used to control the completion of the client's send request until we 

	// know the correct values of iNumSuccessfulRemotes and iSendError to use.

	// Generally 0. 

	// 1 when sending a connection-oriented command or a response.

	// N when sending a connectionless command (where N is the number of 

	// remotes the TSP addressed it to). 

	// While processing outgoing commands to multiple remotes, 

	// iNumRemotesToTry is decremented each time we finish trying to address a 

	// remote. This may be at the connection stage or the actual send stage.

	TInt iNumRemotesToTry;

	// For completion of the current send request. NB A send may be completed 

	// only after numerous asynchronous stages.

	TUint iNumRemotes;

	TInt iSendError;

	CRemConInterfaceDetailsArray* iInterestedAPIs;

	CAsyncCallBack* iSendNextCallBack;

	enum TRemConSessionSending

		{

		ENotSending,

		ESendingReliable,

		ESendingUnreliable

		};

	TRemConSessionSending iSending;

	};

// Inlines

TInt& CRemConSession::NumRemotesToTry()

	{

	return iNumRemotesToTry;

	}

TUint& CRemConSession::NumRemotes()

	{

	return iNumRemotes;

	}

TInt& CRemConSession::SendError()

	{

	return iSendError;

	}

TClientInfo& CRemConSession::ClientInfo()

	{

	return iClientInfo;

	}

const TClientInfo& CRemConSession::ClientInfo() const

	{

	return iClientInfo;

	}

TUint CRemConSession::Id() const

	{

	return iId;

	}

const RMessage2& CRemConSession::CurrentSendMessage() const

	{

	return iSendMsg;

	}

const RMessage2& CRemConSession::CurrentReceiveMessage() const

	{

	return iReceiveMsg;

	}

	{

	}

#endif // REMCONSESSION_H