sl@0: // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // include\mmf\common\mmfipc.h
sl@0: // Thin interface layer to use either V1 or V2 IPC calls as appropriate
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __MMF_COMMON_MMFIPC_H__
sl@0: #define __MMF_COMMON_MMFIPC_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: 
sl@0: #ifdef __IPC_V2_PRESENT__
sl@0: // if V2 code present than use it
sl@0: #define __MMF_USE_IPC_V2__
sl@0: #endif //__IPC_V2_PRESENT__
sl@0: 
sl@0: 
sl@0: #ifdef __MMF_USE_IPC_V2__
sl@0: typedef RMessage2 RMmfIpcMessage;
sl@0: #else // __MMF_USE_IPC_V2__
sl@0: // otherwise always use V1
sl@0: typedef RMessage RMmfIpcMessage;
sl@0: #endif // __MMF_USE_IPC_V2__
sl@0: 
sl@0: #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0: #include <mmf/common/mmfipcserver.h>
sl@0: #endif
sl@0: 
sl@0: 
sl@0: // The following declarations are used instead of the native ones on the particular system variant:
sl@0: //    RMmfIpcMessage replaces RMessage or RMessage2
sl@0: //    CMmfIpcServer replaces CServer or CServer2
sl@0: //    CMmfIpcSession replaces CSharableSession or CSession2
sl@0: // They are used internally to the MMF component to provide configurability for the particular subsystem
sl@0: 
sl@0: 
sl@0: #if defined(__VC32__)
sl@0: #pragma warning( disable : 4097 )	// typedef-name used as synonym for class-name 
sl@0: #endif
sl@0: 
sl@0: 
sl@0: /**
sl@0:  * RSessionBase adaptor layer 
sl@0:  * Provides typechecking for client-side calls. 
sl@0:  *
sl@0:  * @publishedAll
sl@0:  */
sl@0: 
sl@0: class RMmfSessionBase : public RSessionBase
sl@0: 	{
sl@0: protected:
sl@0: 	// no parameter variants
sl@0: 	TInt SendReceive(TInt aFunction) const;
sl@0: 	void SendReceive(TInt aFunction, TRequestStatus& aStatus) const;
sl@0: 	// send number of parameters - no "result" parameter, just error/status 
sl@0: 	TInt SendReceive(TInt aFunction, TInt aParam0) const;
sl@0: 	TInt SendReceive(TInt aFunction, TInt aParam0, TInt aParam1) const;
sl@0: 	void SendReceive(TInt aFunction, TInt aParam0, TRequestStatus& aStatus) const;
sl@0: 	void SendReceive(TInt aFunction, TInt aParam0, TInt aParam1, TRequestStatus& aStatus) const;
sl@0: 	TInt SendReceive(TInt aFunction, const TDesC8& aParam0) const;
sl@0: 	TInt SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1) const;
sl@0: 	TInt SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2) const;
sl@0: 	void SendReceive(TInt aFunction, const TDesC8& aParam0, TRequestStatus& aStatus) const;
sl@0: 	void SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TRequestStatus& aStatus) const;
sl@0: 	void SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TRequestStatus& aStatus) const;
sl@0: 	// "last" parameter is result, so is passed as TDes8&
sl@0: 	TInt SendReceiveResult(TInt aFunction, TDes8& aResult) const;
sl@0: 	TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes8& aResult) const;
sl@0: 	TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult) const;
sl@0: 	void SendReceiveResult(TInt aFunction, TDes8& aResult, TRequestStatus& aStatus) const;
sl@0: 	void SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes8& aResult, TRequestStatus& aStatus) const;
sl@0: 	void SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult, TRequestStatus& aStatus) const;
sl@0: 
sl@0: 	//TDesC versions
sl@0: 	void SendReceive(TInt aFunction, const TDesC& aParam0, TRequestStatus& aStatus) const;
sl@0: 	TInt SendReceive(TInt aFunction, const TDesC& aParam0) const;
sl@0: 	TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes& aResult) const;
sl@0: 
sl@0: 	// custom command versions for non-UID commands
sl@0: 	TInt SendReceive(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2) const;
sl@0: 	TInt SendReceiveResult(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult) const;
sl@0: 	void SendReceive(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TRequestStatus& aStatus) const;
sl@0: 	void SendReceiveResult(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult, TRequestStatus& aStatus) const;
sl@0: 	};
sl@0: 	
sl@0: #include <mmf/common/mmfipc.inl>
sl@0: 
sl@0: #endif // __MMF_COMMON_MMFIPC_H__