williamr@2: // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: // All rights reserved.
williamr@2: // This component and the accompanying materials are made available
williamr@2: // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: // which accompanies this distribution, and is available
williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: //
williamr@2: // Initial Contributors:
williamr@2: // Nokia Corporation - initial contribution.
williamr@2: //
williamr@2: // Contributors:
williamr@2: //
williamr@2: // Description:
williamr@2: // include\mmf\common\mmfipc.h
williamr@2: // Thin interface layer to use either V1 or V2 IPC calls as appropriate
williamr@2: // 
williamr@2: //
williamr@2: 
williamr@2: #ifndef __MMF_COMMON_MMFIPC_H__
williamr@2: #define __MMF_COMMON_MMFIPC_H__
williamr@2: 
williamr@2: #include <e32base.h>
williamr@2: 
williamr@2: #ifdef __IPC_V2_PRESENT__
williamr@2: // if V2 code present than use it
williamr@2: #define __MMF_USE_IPC_V2__
williamr@2: #endif //__IPC_V2_PRESENT__
williamr@2: 
williamr@2: 
williamr@2: // The following declarations are used instead of the native ones on the particular system variant:
williamr@2: //    RMmfIpcMessage replaces RMessage or RMessage2
williamr@2: //    CMmfIpcServer replaces CServer or CServer2
williamr@2: //    CMmfIpcSession replaces CSharableSession or CSession2
williamr@2: // They are used internally to the MMF component to provide configurability for the particular subsystem
williamr@2: 
williamr@2: #ifdef __MMF_USE_IPC_V2__
williamr@2: 
williamr@2: typedef RMessage2 RMmfIpcMessage;
williamr@2: 
williamr@2: class CMmfIpcServer; // forward declaration
williamr@2: 
williamr@2: /**
williamr@2:  * derive CMmfIpcSession from CSession2 so we can bridge the differences to old CSharableSession
williamr@2:  *
williamr@2:  * @internalTechnology
williamr@2:  */
williamr@2:  
williamr@2: class CMmfIpcSession : public CSession2
williamr@2: 	{
williamr@2: protected:
williamr@2: 	virtual void CreateL(const CMmfIpcServer& aServer);
williamr@2: 	CMmfIpcSession() {}
williamr@2: 	// from CSession2
williamr@2: 	void CreateL();
williamr@2: 	};
williamr@2: 
williamr@2: /*
williamr@2:  * derive CMmfIpcServer from CServer2 so we can bridge difference to old CServer
williamr@2:  *
williamr@2:  * @internalTechnology
williamr@2:  */
williamr@2:  
williamr@2: class CMmfIpcServer : public CServer2
williamr@2: 	{
williamr@2: protected:
williamr@2: 	virtual CMmfIpcSession* NewSessionL(const TVersion& aVersion) const=0;
williamr@2: 	CMmfIpcServer(TInt aPriority,TServerType aType=EUnsharableSessions);
williamr@2: private:
williamr@2: 	// derived from CServer2
williamr@2: 	CSession2* NewSessionL(const TVersion& aVersion,const RMessage2& aMessage) const;
williamr@2: 	};
williamr@2: 
williamr@2: #else // __MMF_USE_IPC_V2__
williamr@2: 
williamr@2: // otherwise always use V1
williamr@2: typedef RMessage RMmfIpcMessage;
williamr@2: typedef CServer CMmfIpcServer;
williamr@2: typedef CSharableSession CMmfIpcSession;
williamr@2: 
williamr@2: #endif // __MMF_USE_IPC_V2__
williamr@2: 
williamr@2: #if defined(__VC32__)
williamr@2: #pragma warning( disable : 4097 )	// typedef-name used as synonym for class-name 
williamr@2: #endif
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2:  * RSessionBase adaptor layer 
williamr@2:  * Provides typechecking for client-side calls. 
williamr@2:  *
williamr@2:  * @internalTechnology
williamr@2:  */
williamr@2: 
williamr@2: class RMmfSessionBase : public RSessionBase
williamr@2: 	{
williamr@2: protected:
williamr@2: 	// no parameter variants
williamr@2: 	TInt SendReceive(TInt aFunction) const;
williamr@2: 	void SendReceive(TInt aFunction, TRequestStatus& aStatus) const;
williamr@2: 	// send number of parameters - no "result" parameter, just error/status 
williamr@2: 	TInt SendReceive(TInt aFunction, TInt aParam0) const;
williamr@2: 	TInt SendReceive(TInt aFunction, TInt aParam0, TInt aParam1) const;
williamr@2: 	void SendReceive(TInt aFunction, TInt aParam0, TRequestStatus& aStatus) const;
williamr@2: 	void SendReceive(TInt aFunction, TInt aParam0, TInt aParam1, TRequestStatus& aStatus) const;
williamr@2: 	TInt SendReceive(TInt aFunction, const TDesC8& aParam0) const;
williamr@2: 	TInt SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1) const;
williamr@2: 	TInt SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2) const;
williamr@2: 	void SendReceive(TInt aFunction, const TDesC8& aParam0, TRequestStatus& aStatus) const;
williamr@2: 	void SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TRequestStatus& aStatus) const;
williamr@2: 	void SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TRequestStatus& aStatus) const;
williamr@2: 	// "last" parameter is result, so is passed as TDes8&
williamr@2: 	TInt SendReceiveResult(TInt aFunction, TDes8& aResult) const;
williamr@2: 	TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes8& aResult) const;
williamr@2: 	TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult) const;
williamr@2: 	void SendReceiveResult(TInt aFunction, TDes8& aResult, TRequestStatus& aStatus) const;
williamr@2: 	void SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes8& aResult, TRequestStatus& aStatus) const;
williamr@2: 	void SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult, TRequestStatus& aStatus) const;
williamr@2: 
williamr@2: 	//TDesC versions
williamr@2: 	void SendReceive(TInt aFunction, const TDesC& aParam0, TRequestStatus& aStatus) const;
williamr@2: 	TInt SendReceive(TInt aFunction, const TDesC& aParam0) const;
williamr@2: 	TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes& aResult) const;
williamr@2: 
williamr@2: 	// custom command versions for non-UID commands
williamr@2: 	TInt SendReceive(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2) const;
williamr@2: 	TInt SendReceiveResult(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult) const;
williamr@2: 	void SendReceive(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TRequestStatus& aStatus) const;
williamr@2: 	void SendReceiveResult(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult, TRequestStatus& aStatus) const;
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2:  * Adapt RMessage calls between IPC variants
williamr@2:  *
williamr@2:  * @internalTechnology
williamr@2:  */
williamr@2: 
williamr@2: class MmfMessageUtil 
williamr@2: 	{
williamr@2: public:
williamr@2: 	static TInt Read(const RMmfIpcMessage& aMessage, TInt aParam, TDes8& aResult);
williamr@2: 	static TInt Write(const RMmfIpcMessage& aMessage, TInt aParam, const TDesC8& aValue);
williamr@2: 	static void ReadL(const RMmfIpcMessage& aMessage, TInt aParam, TDes8& aResult);
williamr@2: 	static void WriteL(const RMmfIpcMessage& aMessage, TInt aParam, const TDesC8& aValue);
williamr@2: 	};
williamr@2: 	
williamr@2: #include <mmf/common/mmfipc.inl>
williamr@2: 
williamr@2: #endif // __MMF_COMMON_MMFIPC_H__