|
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 "Eclipse Public License v1.0" |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.eclipse.org/legal/epl-v10.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 #ifdef __MMF_USE_IPC_V2__ |
|
31 typedef RMessage2 RMmfIpcMessage; |
|
32 #else // __MMF_USE_IPC_V2__ |
|
33 // otherwise always use V1 |
|
34 typedef RMessage RMmfIpcMessage; |
|
35 #endif // __MMF_USE_IPC_V2__ |
|
36 |
|
37 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS |
|
38 #include <mmf/common/mmfipcserver.h> |
|
39 #endif |
|
40 |
|
41 |
|
42 // The following declarations are used instead of the native ones on the particular system variant: |
|
43 // RMmfIpcMessage replaces RMessage or RMessage2 |
|
44 // CMmfIpcServer replaces CServer or CServer2 |
|
45 // CMmfIpcSession replaces CSharableSession or CSession2 |
|
46 // They are used internally to the MMF component to provide configurability for the particular subsystem |
|
47 |
|
48 |
|
49 #if defined(__VC32__) |
|
50 #pragma warning( disable : 4097 ) // typedef-name used as synonym for class-name |
|
51 #endif |
|
52 |
|
53 |
|
54 /** |
|
55 * RSessionBase adaptor layer |
|
56 * Provides typechecking for client-side calls. |
|
57 * |
|
58 * @publishedAll |
|
59 */ |
|
60 |
|
61 class RMmfSessionBase : public RSessionBase |
|
62 { |
|
63 protected: |
|
64 // no parameter variants |
|
65 TInt SendReceive(TInt aFunction) const; |
|
66 void SendReceive(TInt aFunction, TRequestStatus& aStatus) const; |
|
67 // send number of parameters - no "result" parameter, just error/status |
|
68 TInt SendReceive(TInt aFunction, TInt aParam0) const; |
|
69 TInt SendReceive(TInt aFunction, TInt aParam0, TInt aParam1) const; |
|
70 void SendReceive(TInt aFunction, TInt aParam0, TRequestStatus& aStatus) const; |
|
71 void SendReceive(TInt aFunction, TInt aParam0, TInt aParam1, TRequestStatus& aStatus) const; |
|
72 TInt SendReceive(TInt aFunction, const TDesC8& aParam0) const; |
|
73 TInt SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1) const; |
|
74 TInt SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2) const; |
|
75 void SendReceive(TInt aFunction, const TDesC8& aParam0, TRequestStatus& aStatus) const; |
|
76 void SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TRequestStatus& aStatus) const; |
|
77 void SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TRequestStatus& aStatus) const; |
|
78 // "last" parameter is result, so is passed as TDes8& |
|
79 TInt SendReceiveResult(TInt aFunction, TDes8& aResult) const; |
|
80 TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes8& aResult) const; |
|
81 TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult) const; |
|
82 void SendReceiveResult(TInt aFunction, TDes8& aResult, TRequestStatus& aStatus) const; |
|
83 void SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes8& aResult, TRequestStatus& aStatus) const; |
|
84 void SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult, TRequestStatus& aStatus) const; |
|
85 |
|
86 //TDesC versions |
|
87 void SendReceive(TInt aFunction, const TDesC& aParam0, TRequestStatus& aStatus) const; |
|
88 TInt SendReceive(TInt aFunction, const TDesC& aParam0) const; |
|
89 TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes& aResult) const; |
|
90 |
|
91 // custom command versions for non-UID commands |
|
92 TInt SendReceive(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2) const; |
|
93 TInt SendReceiveResult(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult) const; |
|
94 void SendReceive(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TRequestStatus& aStatus) const; |
|
95 void SendReceiveResult(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult, TRequestStatus& aStatus) const; |
|
96 }; |
|
97 |
|
98 #include <mmf/common/mmfipc.inl> |
|
99 |
|
100 #endif // __MMF_COMMON_MMFIPC_H__ |