1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mmf/common/mmfipc.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -0,0 +1,149 @@
1.4 +// Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// 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
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// include\mmf\common\mmfipc.h
1.18 +// Thin interface layer to use either V1 or V2 IPC calls as appropriate
1.19 +//
1.20 +//
1.21 +
1.22 +#ifndef __MMF_COMMON_MMFIPC_H__
1.23 +#define __MMF_COMMON_MMFIPC_H__
1.24 +
1.25 +#include <e32base.h>
1.26 +
1.27 +#ifdef __IPC_V2_PRESENT__
1.28 +// if V2 code present than use it
1.29 +#define __MMF_USE_IPC_V2__
1.30 +#endif //__IPC_V2_PRESENT__
1.31 +
1.32 +
1.33 +// The following declarations are used instead of the native ones on the particular system variant:
1.34 +// RMmfIpcMessage replaces RMessage or RMessage2
1.35 +// CMmfIpcServer replaces CServer or CServer2
1.36 +// CMmfIpcSession replaces CSharableSession or CSession2
1.37 +// They are used internally to the MMF component to provide configurability for the particular subsystem
1.38 +
1.39 +#ifdef __MMF_USE_IPC_V2__
1.40 +
1.41 +typedef RMessage2 RMmfIpcMessage;
1.42 +
1.43 +class CMmfIpcServer; // forward declaration
1.44 +
1.45 +/**
1.46 + * derive CMmfIpcSession from CSession2 so we can bridge the differences to old CSharableSession
1.47 + *
1.48 + * @internalTechnology
1.49 + */
1.50 +
1.51 +class CMmfIpcSession : public CSession2
1.52 + {
1.53 +protected:
1.54 + virtual void CreateL(const CMmfIpcServer& aServer);
1.55 + CMmfIpcSession() {}
1.56 + // from CSession2
1.57 + void CreateL();
1.58 + };
1.59 +
1.60 +/*
1.61 + * derive CMmfIpcServer from CServer2 so we can bridge difference to old CServer
1.62 + *
1.63 + * @internalTechnology
1.64 + */
1.65 +
1.66 +class CMmfIpcServer : public CServer2
1.67 + {
1.68 +protected:
1.69 + virtual CMmfIpcSession* NewSessionL(const TVersion& aVersion) const=0;
1.70 + CMmfIpcServer(TInt aPriority,TServerType aType=EUnsharableSessions);
1.71 +private:
1.72 + // derived from CServer2
1.73 + CSession2* NewSessionL(const TVersion& aVersion,const RMessage2& aMessage) const;
1.74 + };
1.75 +
1.76 +#else // __MMF_USE_IPC_V2__
1.77 +
1.78 +// otherwise always use V1
1.79 +typedef RMessage RMmfIpcMessage;
1.80 +typedef CServer CMmfIpcServer;
1.81 +typedef CSharableSession CMmfIpcSession;
1.82 +
1.83 +#endif // __MMF_USE_IPC_V2__
1.84 +
1.85 +#if defined(__VC32__)
1.86 +#pragma warning( disable : 4097 ) // typedef-name used as synonym for class-name
1.87 +#endif
1.88 +
1.89 +
1.90 +/**
1.91 + * RSessionBase adaptor layer
1.92 + * Provides typechecking for client-side calls.
1.93 + *
1.94 + * @internalTechnology
1.95 + */
1.96 +
1.97 +class RMmfSessionBase : public RSessionBase
1.98 + {
1.99 +protected:
1.100 + // no parameter variants
1.101 + TInt SendReceive(TInt aFunction) const;
1.102 + void SendReceive(TInt aFunction, TRequestStatus& aStatus) const;
1.103 + // send number of parameters - no "result" parameter, just error/status
1.104 + TInt SendReceive(TInt aFunction, TInt aParam0) const;
1.105 + TInt SendReceive(TInt aFunction, TInt aParam0, TInt aParam1) const;
1.106 + void SendReceive(TInt aFunction, TInt aParam0, TRequestStatus& aStatus) const;
1.107 + void SendReceive(TInt aFunction, TInt aParam0, TInt aParam1, TRequestStatus& aStatus) const;
1.108 + TInt SendReceive(TInt aFunction, const TDesC8& aParam0) const;
1.109 + TInt SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1) const;
1.110 + TInt SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2) const;
1.111 + void SendReceive(TInt aFunction, const TDesC8& aParam0, TRequestStatus& aStatus) const;
1.112 + void SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TRequestStatus& aStatus) const;
1.113 + void SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TRequestStatus& aStatus) const;
1.114 + // "last" parameter is result, so is passed as TDes8&
1.115 + TInt SendReceiveResult(TInt aFunction, TDes8& aResult) const;
1.116 + TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes8& aResult) const;
1.117 + TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult) const;
1.118 + void SendReceiveResult(TInt aFunction, TDes8& aResult, TRequestStatus& aStatus) const;
1.119 + void SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes8& aResult, TRequestStatus& aStatus) const;
1.120 + void SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult, TRequestStatus& aStatus) const;
1.121 +
1.122 + //TDesC versions
1.123 + void SendReceive(TInt aFunction, const TDesC& aParam0, TRequestStatus& aStatus) const;
1.124 + TInt SendReceive(TInt aFunction, const TDesC& aParam0) const;
1.125 + TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes& aResult) const;
1.126 +
1.127 + // custom command versions for non-UID commands
1.128 + TInt SendReceive(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2) const;
1.129 + TInt SendReceiveResult(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult) const;
1.130 + void SendReceive(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TRequestStatus& aStatus) const;
1.131 + void SendReceiveResult(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult, TRequestStatus& aStatus) const;
1.132 + };
1.133 +
1.134 +
1.135 +/**
1.136 + * Adapt RMessage calls between IPC variants
1.137 + *
1.138 + * @internalTechnology
1.139 + */
1.140 +
1.141 +class MmfMessageUtil
1.142 + {
1.143 +public:
1.144 + static TInt Read(const RMmfIpcMessage& aMessage, TInt aParam, TDes8& aResult);
1.145 + static TInt Write(const RMmfIpcMessage& aMessage, TInt aParam, const TDesC8& aValue);
1.146 + static void ReadL(const RMmfIpcMessage& aMessage, TInt aParam, TDes8& aResult);
1.147 + static void WriteL(const RMmfIpcMessage& aMessage, TInt aParam, const TDesC8& aValue);
1.148 + };
1.149 +
1.150 +#include <mmf/common/mmfipc.inl>
1.151 +
1.152 +#endif // __MMF_COMMON_MMFIPC_H__