|
1 /* |
|
2 * Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: Access handler of the network session |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef __CPENGACCESSHANDLER_H__ |
|
19 #define __CPENGACCESSHANDLER_H__ |
|
20 |
|
21 // INCLUDES |
|
22 #include <E32Base.h> |
|
23 #include <ImpsAccessCli.h> |
|
24 #include "PEngPresenceEngineConsts2.h" |
|
25 #include "PEngWVServices2.h" |
|
26 |
|
27 #include "MPEngAccessHandler.h" |
|
28 |
|
29 // FORWARD DECLARATIONS |
|
30 class CPEngSessionSlotId; |
|
31 class MPEngSessionStatusObserver; |
|
32 class MPEngSessionManager; |
|
33 |
|
34 /** |
|
35 * NWSessionSlotID implementation. |
|
36 * |
|
37 * @since 3.0 |
|
38 */ |
|
39 NONSHARABLE_CLASS( CPEngAccessHandler ) : |
|
40 public CBase, |
|
41 public MPEngAccessHandler, |
|
42 public MImpsAccessHandler2, |
|
43 public MImpsErrorHandler2, |
|
44 public MImpsStatusHandler2 |
|
45 { |
|
46 public: /* Construction */ |
|
47 |
|
48 |
|
49 /** |
|
50 * Instantiates CPEngAccessHandler object. |
|
51 * |
|
52 * @return New CPEngAccessHandler instance. |
|
53 */ |
|
54 static CPEngAccessHandler* NewL( RImpsEng& aSessClient, |
|
55 MPEngSessionManager& aSessManager, |
|
56 const CPEngSessionSlotId& aSessionId ); |
|
57 |
|
58 |
|
59 /** |
|
60 * Destructor. |
|
61 */ |
|
62 ~CPEngAccessHandler(); |
|
63 |
|
64 //----------------------------------------------------------------------- |
|
65 public: // from MPEngAccessHandler |
|
66 /** |
|
67 * Close reference to the Access handler |
|
68 * @see <MPEngAccessHandler.h> |
|
69 */ |
|
70 void Close(); |
|
71 |
|
72 /** |
|
73 * Open new reference to the object |
|
74 * @see <MPEngAccessHandler.h> |
|
75 */ |
|
76 void Open(); |
|
77 |
|
78 /** |
|
79 * Log in to the presence server |
|
80 * @see <MPEngAccessHandler.h> |
|
81 */ |
|
82 void LogInL( TRequestStatus& aStatus, HBufC8* aLoginBuffer ); |
|
83 |
|
84 /** |
|
85 * Log out from the presence server |
|
86 * @see <MPEngAccessHandler.h> |
|
87 */ |
|
88 void LogOutL( TRequestStatus& aStatus ); |
|
89 |
|
90 /** |
|
91 * Returns data which was used for log in. |
|
92 * @see <MPEngAccessHandler.h> |
|
93 */ |
|
94 const TDesC8& LogInData( ) const; |
|
95 |
|
96 /** |
|
97 * Cancels active asynchronous operation |
|
98 * @see <MPEngAccessHandler.h> |
|
99 */ |
|
100 void Cancel(); |
|
101 |
|
102 /** |
|
103 * Register session status observer |
|
104 * @see <MPEngAccessHandler.h> |
|
105 */ |
|
106 void RegisterSessionObserverL( |
|
107 MPEngSessionStatusObserver& aObserver ); |
|
108 |
|
109 /** |
|
110 * UnRegister session status observer |
|
111 * @see <MPEngAccessHandler.h> |
|
112 */ |
|
113 void UnregisterSessionObserver( |
|
114 MPEngSessionStatusObserver& aObserver ); |
|
115 |
|
116 /** |
|
117 * Get session service capabilities |
|
118 * @see <MPEngAccessHandler.h> |
|
119 */ |
|
120 TPEngWVCspServicesTree2& ServiceCapabilities(); |
|
121 |
|
122 /** |
|
123 * Assert log in data of opened session with the passed data |
|
124 * @see <MPEngAccessHandler.h> |
|
125 */ |
|
126 void AssertLoginDataL( TDesC8& aLogInData ); |
|
127 |
|
128 |
|
129 public: // MImpsAccessHandler |
|
130 |
|
131 /** |
|
132 * Observer method for Login and Open event. |
|
133 * @see <impspurecli.h> |
|
134 */ |
|
135 void HandleLoginL( TInt aId, |
|
136 TImpsCspIdentifier& aCspId ); |
|
137 |
|
138 /** |
|
139 * Observer method for Logout event. |
|
140 * @see <impspurecli.h> |
|
141 */ |
|
142 void HandleLogoutL( TInt aId, |
|
143 TImpsCspIdentifier& aCspId ); |
|
144 |
|
145 /** |
|
146 * Observer method for CancelLogin event. |
|
147 * @see <impspurecli.h> |
|
148 */ |
|
149 void HandleLoginCancelL( TInt aCancelledOpId, |
|
150 TImpsCspIdentifier& aCspId ); |
|
151 |
|
152 /** |
|
153 * Observer for NumberOfSessions and NumberOfSubSessions response |
|
154 * @see <impspurecli.h> |
|
155 */ |
|
156 void HandleNbrSessionsL( TInt aId, |
|
157 TInt aNbr, |
|
158 TImpsCspIdentifier& aCspId ); |
|
159 |
|
160 public: // MImpsErrorHandler |
|
161 |
|
162 /** |
|
163 * Observer method for error messages. |
|
164 * @see <impspurecli.h> |
|
165 */ |
|
166 void HandleErrorL( TInt aStatus, |
|
167 TInt aOpId, |
|
168 const TDesC* aDescription, |
|
169 const CImpsDetailed* aDetailedRes, |
|
170 TImpsCspIdentifier& aCspId ); |
|
171 |
|
172 public: // MImpsStatusHandler |
|
173 /** |
|
174 * Observer method for changes in service status. |
|
175 * @see <MImpsStatusHandler.h> |
|
176 */ |
|
177 void HandleStatusChangeL( TImpsServiceStatus aStatus, |
|
178 TImpsCspIdentifier& aCspId ); |
|
179 |
|
180 private: // new private functions |
|
181 |
|
182 /** |
|
183 * Copy service tree |
|
184 * |
|
185 * @since 3.0 |
|
186 * @param WV Engine service tree |
|
187 */ |
|
188 void CopyServiceTree( TImpsServices& aFrom ); |
|
189 |
|
190 /** |
|
191 * Notify if new state |
|
192 * |
|
193 * @since 3.0 |
|
194 * @param aNewState |
|
195 * @param aEvent |
|
196 */ |
|
197 void NotifyIfNewStateL( TPEngNWSessionSlotState aNewState, |
|
198 TPEngNWSessionSlotEvent aEvent ); |
|
199 |
|
200 |
|
201 /** |
|
202 * Handle completion of the log in request |
|
203 * |
|
204 * @since 3.0 |
|
205 */ |
|
206 void HandleLogInCompletionL( ); |
|
207 |
|
208 |
|
209 |
|
210 protected: // construction |
|
211 |
|
212 /** |
|
213 * C++ constructor. protected |
|
214 */ |
|
215 CPEngAccessHandler( MPEngSessionManager& aSessManager, |
|
216 const CPEngSessionSlotId& aSessionId ); |
|
217 |
|
218 /** |
|
219 * Symbian Second phase constructor |
|
220 */ |
|
221 void ConstructL( RImpsEng& aSessClient ); |
|
222 |
|
223 private: //Data |
|
224 enum TPEngOperation |
|
225 { |
|
226 EIdle = 0, |
|
227 EDoingLogIn = 1, |
|
228 EDoingLogOut = 2, |
|
229 ECanceling = 3 |
|
230 }; |
|
231 |
|
232 /// OWN: Access count |
|
233 TInt iCount; |
|
234 |
|
235 /// REF: Session manager |
|
236 MPEngSessionManager& iSessionManager; |
|
237 |
|
238 /// REF: Session Slot Id |
|
239 const CPEngSessionSlotId& iSessionId; |
|
240 |
|
241 /// OWN: State of the session |
|
242 TPEngNWSessionSlotState iSessStatus; |
|
243 |
|
244 /// OWN: Buffer with log in Data |
|
245 HBufC8* iLogInData; |
|
246 |
|
247 /// OWN: Service tree of the session |
|
248 TPEngWVCspServicesTree2 iServices; |
|
249 |
|
250 /// OWN: TBool service tree fetched |
|
251 TBool iServiceFetched; |
|
252 |
|
253 /// REF: Session state observer |
|
254 RPointerArray<MPEngSessionStatusObserver> iObservers; |
|
255 |
|
256 /// OWN: Access client of WV Engine |
|
257 RImpsAccessClient2 iAccessClient; |
|
258 |
|
259 /// OWN: Operation Id from the WV Server |
|
260 TInt iOpId; |
|
261 |
|
262 /// REF: Request Status of the active request |
|
263 TRequestStatus* iStatus; |
|
264 |
|
265 /// OWN: Active operation |
|
266 TPEngOperation iOperation; |
|
267 |
|
268 }; |
|
269 |
|
270 #endif //__CPENGACCESSHANDLER_H__ |
|
271 |
|
272 // End of File |