|
1 // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
3 // This component and the accompanying materials are made available |
|
4 // 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 |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // include\mmf\common\mmfipc.h |
|
15 // Thin interface layer to use either V1 or V2 IPC calls as appropriate |
|
16 // |
|
17 // |
|
18 |
|
19 #ifndef __MMF_COMMON_MMFIPC_H__ |
|
20 #define __MMF_COMMON_MMFIPC_H__ |
|
21 |
|
22 #include <e32base.h> |
|
23 |
|
24 #ifdef __IPC_V2_PRESENT__ |
|
25 // if V2 code present than use it |
|
26 #define __MMF_USE_IPC_V2__ |
|
27 #endif //__IPC_V2_PRESENT__ |
|
28 |
|
29 |
|
30 // The following declarations are used instead of the native ones on the particular system variant: |
|
31 // RMmfIpcMessage replaces RMessage or RMessage2 |
|
32 // CMmfIpcServer replaces CServer or CServer2 |
|
33 // CMmfIpcSession replaces CSharableSession or CSession2 |
|
34 // They are used internally to the MMF component to provide configurability for the particular subsystem |
|
35 |
|
36 #ifdef __MMF_USE_IPC_V2__ |
|
37 |
|
38 typedef RMessage2 RMmfIpcMessage; |
|
39 |
|
40 class CMmfIpcServer; // forward declaration |
|
41 |
|
42 /** |
|
43 * derive CMmfIpcSession from CSession2 so we can bridge the differences to old CSharableSession |
|
44 * |
|
45 * @internalTechnology |
|
46 */ |
|
47 |
|
48 class CMmfIpcSession : public CSession2 |
|
49 { |
|
50 protected: |
|
51 virtual void CreateL(const CMmfIpcServer& aServer); |
|
52 CMmfIpcSession() {} |
|
53 // from CSession2 |
|
54 void CreateL(); |
|
55 }; |
|
56 |
|
57 /* |
|
58 * derive CMmfIpcServer from CServer2 so we can bridge difference to old CServer |
|
59 * |
|
60 * @internalTechnology |
|
61 */ |
|
62 |
|
63 class CMmfIpcServer : public CServer2 |
|
64 { |
|
65 protected: |
|
66 virtual CMmfIpcSession* NewSessionL(const TVersion& aVersion) const=0; |
|
67 CMmfIpcServer(TInt aPriority,TServerType aType=EUnsharableSessions); |
|
68 private: |
|
69 // derived from CServer2 |
|
70 CSession2* NewSessionL(const TVersion& aVersion,const RMessage2& aMessage) const; |
|
71 }; |
|
72 |
|
73 #else // __MMF_USE_IPC_V2__ |
|
74 |
|
75 // otherwise always use V1 |
|
76 typedef RMessage RMmfIpcMessage; |
|
77 typedef CServer CMmfIpcServer; |
|
78 typedef CSharableSession CMmfIpcSession; |
|
79 |
|
80 #endif // __MMF_USE_IPC_V2__ |
|
81 |
|
82 #if defined(__VC32__) |
|
83 #pragma warning( disable : 4097 ) // typedef-name used as synonym for class-name |
|
84 #endif |
|
85 |
|
86 |
|
87 /** |
|
88 * RSessionBase adaptor layer |
|
89 * Provides typechecking for client-side calls. |
|
90 * |
|
91 * @internalTechnology |
|
92 */ |
|
93 |
|
94 class RMmfSessionBase : public RSessionBase |
|
95 { |
|
96 protected: |
|
97 // no parameter variants |
|
98 TInt SendReceive(TInt aFunction) const; |
|
99 void SendReceive(TInt aFunction, TRequestStatus& aStatus) const; |
|
100 // send number of parameters - no "result" parameter, just error/status |
|
101 TInt SendReceive(TInt aFunction, TInt aParam0) const; |
|
102 TInt SendReceive(TInt aFunction, TInt aParam0, TInt aParam1) const; |
|
103 void SendReceive(TInt aFunction, TInt aParam0, TRequestStatus& aStatus) const; |
|
104 void SendReceive(TInt aFunction, TInt aParam0, TInt aParam1, TRequestStatus& aStatus) const; |
|
105 TInt SendReceive(TInt aFunction, const TDesC8& aParam0) const; |
|
106 TInt SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1) const; |
|
107 TInt SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2) const; |
|
108 void SendReceive(TInt aFunction, const TDesC8& aParam0, TRequestStatus& aStatus) const; |
|
109 void SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TRequestStatus& aStatus) const; |
|
110 void SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TRequestStatus& aStatus) const; |
|
111 // "last" parameter is result, so is passed as TDes8& |
|
112 TInt SendReceiveResult(TInt aFunction, TDes8& aResult) const; |
|
113 TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes8& aResult) const; |
|
114 TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult) const; |
|
115 void SendReceiveResult(TInt aFunction, TDes8& aResult, TRequestStatus& aStatus) const; |
|
116 void SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes8& aResult, TRequestStatus& aStatus) const; |
|
117 void SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult, TRequestStatus& aStatus) const; |
|
118 |
|
119 //TDesC versions |
|
120 void SendReceive(TInt aFunction, const TDesC& aParam0, TRequestStatus& aStatus) const; |
|
121 TInt SendReceive(TInt aFunction, const TDesC& aParam0) const; |
|
122 TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes& aResult) const; |
|
123 |
|
124 // custom command versions for non-UID commands |
|
125 TInt SendReceive(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2) const; |
|
126 TInt SendReceiveResult(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult) const; |
|
127 void SendReceive(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TRequestStatus& aStatus) const; |
|
128 void SendReceiveResult(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult, TRequestStatus& aStatus) const; |
|
129 }; |
|
130 |
|
131 |
|
132 /** |
|
133 * Adapt RMessage calls between IPC variants |
|
134 * |
|
135 * @internalTechnology |
|
136 */ |
|
137 |
|
138 class MmfMessageUtil |
|
139 { |
|
140 public: |
|
141 static TInt Read(const RMmfIpcMessage& aMessage, TInt aParam, TDes8& aResult); |
|
142 static TInt Write(const RMmfIpcMessage& aMessage, TInt aParam, const TDesC8& aValue); |
|
143 static void ReadL(const RMmfIpcMessage& aMessage, TInt aParam, TDes8& aResult); |
|
144 static void WriteL(const RMmfIpcMessage& aMessage, TInt aParam, const TDesC8& aValue); |
|
145 }; |
|
146 |
|
147 #include <mmf/common/mmfipc.inl> |
|
148 |
|
149 #endif // __MMF_COMMON_MMFIPC_H__ |