author | Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> |
Wed, 15 Sep 2010 13:26:06 +0300 | |
branch | RCL_3 |
changeset 59 | 34911529ee3c |
parent 55 | f28ada11abbf |
child 65 | 32fadeea4023 |
permissions | -rw-r--r-- |
55 | 1 |
/* |
2 |
* Copyright (c) 2007-2008 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: Class header for CWsfModel |
|
15 |
* |
|
16 |
*/ |
|
17 |
||
18 |
||
19 |
||
20 |
#ifndef C_WSFMODEL_H |
|
21 |
#define C_WSFMODEL_H |
|
22 |
||
23 |
||
24 |
// EXTERNAL INCLUDES |
|
25 |
#include <e32base.h> |
|
26 |
||
27 |
// INTERNAL INCLUDES |
|
28 |
#include "wsfsession.h" |
|
29 |
#include "wsfbrowserlaunchobserver.h" |
|
30 |
#include "wsfscreensaverstateobserver.h" |
|
31 |
#include "wsfbrowserlaunchadapter.h" |
|
32 |
#include "wsfwlaninfo.h" |
|
33 |
||
34 |
||
35 |
// FORWARD DECLARATIONS |
|
36 |
class CWsfAppLauncher; |
|
37 |
class MWsfModelObserver; |
|
38 |
class CWsfWlanInfoArray; |
|
39 |
class MWsfStateChangeObserver; |
|
40 |
class CEikonEnv; |
|
41 |
class CWsfScreenSaverWatcher; |
|
42 |
class CWsfAsyncOperationQueue; |
|
43 |
||
44 |
||
45 |
// CLASS DEFINITION |
|
46 |
/** |
|
47 |
* Class acts as an application level model and is also entry point to the |
|
48 |
* application engine which is implemented as server |
|
49 |
* |
|
50 |
* @lib wsfmodel.lib |
|
51 |
* @since S60 5.0 |
|
52 |
*/ |
|
53 |
NONSHARABLE_CLASS( CWsfModel ): public CBase, |
|
54 |
public MWsfBrowserLaunchObserver, |
|
55 |
public MWsfScreenSaverStateObserver, |
|
56 |
public MWsfBrowserLaunchAdapter |
|
57 |
{ |
|
58 |
public: // Constructors and destructor |
|
59 |
||
60 |
/** |
|
61 |
* Factory function. |
|
62 |
* @since S60 5.0 |
|
63 |
* @param aObserver The object to notify about server events |
|
64 |
* @param aScreenSaverAware Whether to react to screensaver events |
|
65 |
* @return Model instance |
|
66 |
*/ |
|
67 |
IMPORT_C static CWsfModel* NewL( MWsfStateChangeObserver& aObserver, |
|
68 |
const TBool aScreenSaverAware ); |
|
69 |
||
70 |
/** |
|
71 |
* Factory function. |
|
72 |
* @since S60 5.0 |
|
73 |
* @param aObserver The object to notify about server events |
|
74 |
* @param aScreenSaverAware Whether to react to screensaver events |
|
75 |
* @return Model instance |
|
76 |
*/ |
|
77 |
IMPORT_C static CWsfModel* NewLC( MWsfStateChangeObserver& aObserver, |
|
78 |
const TBool aScreenSaverAware ); |
|
79 |
||
80 |
IMPORT_C ~CWsfModel(); |
|
81 |
||
82 |
private: // Constructors |
|
83 |
CWsfModel(); |
|
84 |
||
85 |
/** |
|
86 |
* Factory function. |
|
87 |
* @since S60 5.0 |
|
88 |
* @param aObserver The object to notify about server events |
|
89 |
* @param aScreenSaverAware Whether to react to screensaver events |
|
90 |
*/ |
|
91 |
void ConstructL( MWsfStateChangeObserver& aObserver, |
|
92 |
const TBool aScreenSaverAware ); |
|
93 |
||
94 |
public: // New methods |
|
95 |
||
96 |
/** |
|
97 |
* Attach model observer |
|
98 |
* @since S60 5.0 |
|
99 |
* @param aObserver Pointer to the model observer |
|
100 |
*/ |
|
101 |
IMPORT_C void SetEngineObserver( MWsfModelObserver* aObserver ); |
|
102 |
||
103 |
/** |
|
59
34911529ee3c
Revision: 201034
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
55
diff
changeset
|
104 |
* Return pointer to the list of WLANs. Ownership not passed. |
34911529ee3c
Revision: 201034
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
55
diff
changeset
|
105 |
* @since S60 5.2 |
34911529ee3c
Revision: 201034
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
55
diff
changeset
|
106 |
* @return Array of WLANs |
34911529ee3c
Revision: 201034
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
55
diff
changeset
|
107 |
*/ |
34911529ee3c
Revision: 201034
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
55
diff
changeset
|
108 |
inline CWsfWlanInfoArray* WlanList(); |
34911529ee3c
Revision: 201034
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
55
diff
changeset
|
109 |
|
34911529ee3c
Revision: 201034
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
55
diff
changeset
|
110 |
/** |
55 | 111 |
* Return the latest list of found WLANs. Ownership not passed. |
112 |
* @since S60 5.0 |
|
113 |
* @return Array of WLANs |
|
114 |
*/ |
|
115 |
IMPORT_C CWsfWlanInfoArray* GetWlanListL(); |
|
116 |
||
59
34911529ee3c
Revision: 201034
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
55
diff
changeset
|
117 |
/** |
55 | 118 |
* Asyncronous request to the server to return wlan list size |
119 |
* @since S60 5.2 |
|
120 |
* @param aPckg request result |
|
121 |
* @param aStatus The request status object used to contain |
|
122 |
* the completion status of the request. |
|
123 |
*/ |
|
124 |
IMPORT_C void GetWlanListSize( TPckgBuf<TUint>& aPckg, |
|
125 |
TRequestStatus& aStatus ); |
|
126 |
||
59
34911529ee3c
Revision: 201034
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
55
diff
changeset
|
127 |
/** |
55 | 128 |
* Asyncronous request to the server to return wlan list |
129 |
* @since S60 5.2 |
|
130 |
* @param aPckg request result |
|
59
34911529ee3c
Revision: 201034
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
55
diff
changeset
|
131 |
* @param aPtr wlan list |
55 | 132 |
* @param aStatus The request status object used to contain |
133 |
* the completion status of the request. |
|
134 |
*/ |
|
135 |
IMPORT_C void GetWlanList( TPckgBuf<TUint>& aPckg, TPtr8& aPtr, |
|
136 |
TRequestStatus& aStatus ); |
|
137 |
||
138 |
/** |
|
139 |
* Store active views UID |
|
140 |
* @since S60 5.0 |
|
141 |
* @param aActiveViewId Active view's UID |
|
142 |
*/ |
|
143 |
IMPORT_C void SetActiveViewL( TInt aActiveViewId ); |
|
144 |
||
145 |
/** |
|
146 |
* Get UID of the active view |
|
147 |
* @since S60 5.0 |
|
148 |
* @return UID of active view |
|
149 |
*/ |
|
150 |
IMPORT_C TUid ActiveViewL(); |
|
151 |
||
152 |
/** |
|
153 |
* Store SSID of active WLAN |
|
154 |
* @since S60 5.0 |
|
155 |
* @param aSsid WLAN's name (SSID) |
|
156 |
*/ |
|
157 |
IMPORT_C void SetObservedWlanL( const TDesC8& aSsid ); |
|
158 |
||
159 |
/** |
|
160 |
* Get SSID of active WLAN |
|
161 |
* @since S60 5.0 |
|
162 |
* @return Active WLAN's name (SSID) |
|
163 |
*/ |
|
164 |
IMPORT_C const TDesC8& ObservedWlan(); |
|
165 |
||
166 |
/** |
|
167 |
* Connects to the given WLAN IAP |
|
168 |
* @since S60 5.0 |
|
169 |
* @param aIapId WLAN IAP id to connect to. |
|
170 |
* @param aConnectOnly ETrue if Connect selected |
|
171 |
* @param aPersistence The value of the persistence property |
|
172 |
*/ |
|
173 |
IMPORT_C int ConnectL( TUint32 aIapId, |
|
174 |
TBool aConnectOnly, |
|
175 |
TWsfIapPersistence aPersistence ); |
|
176 |
||
177 |
/** |
|
178 |
* Asyncronous request to the server to connect to the given WLAN IAP |
|
179 |
* @since S60 5.2 |
|
180 |
* @param aPckg request result |
|
181 |
* @param aIapId WLAN IAP id to connect to. |
|
182 |
* @param aConnectOnly ETrue if Connect selected |
|
183 |
* @param aPersistence The value of the persistence property |
|
184 |
* @param aStatus The request status object used to contain |
|
185 |
* the completion status of the request. |
|
186 |
*/ |
|
187 |
IMPORT_C void ConnectL( TPckgBuf<TBool>& aPckg, TUint32 aIapId, |
|
188 |
TBool aConnectOnly, |
|
189 |
TWsfIapPersistence aPersistence, |
|
190 |
TRequestStatus& aStatus ); |
|
191 |
||
192 |
/** |
|
193 |
* Sets connection result |
|
194 |
* @since S60 5.2 |
|
195 |
* @param aResult connection result |
|
196 |
* @param aIapId WLAN IAP |
|
197 |
*/ |
|
198 |
IMPORT_C void SetConnectResultL( TInt aResult, TUint aIapId ); |
|
199 |
||
200 |
/** |
|
201 |
* Disconnects WLAN |
|
202 |
* @since S60 5.0 |
|
203 |
*/ |
|
204 |
IMPORT_C void DisconnectL(); |
|
205 |
||
206 |
/** |
|
207 |
* Asyncronous request to the server to disconnect |
|
208 |
* @since S60 5.2 |
|
209 |
* @param aPckg request result |
|
210 |
* @param aStatus The request status object used to contain |
|
211 |
* the completion status of the request. |
|
212 |
*/ |
|
213 |
IMPORT_C void Disconnect( TPckgBuf<TBool>& aPckg, |
|
214 |
TRequestStatus& aStatus ); |
|
215 |
||
216 |
/** |
|
217 |
* Check if the engine is refreshing |
|
218 |
* @since S60 5.0 |
|
219 |
* @return ETrue if first refreshing |
|
220 |
*/ |
|
221 |
IMPORT_C TBool Refreshing(); |
|
222 |
||
223 |
/** |
|
224 |
* Change refreshing state |
|
225 |
* @since S60 5.0 |
|
226 |
* @param aRefreshing Refreshing state |
|
227 |
*/ |
|
228 |
IMPORT_C void SetRefreshState( TBool aRefreshing ); |
|
229 |
||
230 |
/** |
|
231 |
* Notifies server to start scanning if not scanning already |
|
232 |
* @since S60 5.0 |
|
233 |
* @return ETrue on success |
|
234 |
*/ |
|
235 |
IMPORT_C TBool EnableScanL(); |
|
236 |
||
237 |
/** |
|
238 |
* Notifies server to disable scanning |
|
239 |
* However, scanning will continue if some other client |
|
240 |
* has enabled scanning. |
|
241 |
* @since S60 5.0 |
|
242 |
* @return ETrue on success |
|
243 |
*/ |
|
244 |
IMPORT_C TBool DisableScanL(); |
|
245 |
||
246 |
/** |
|
247 |
* Checks if scanning is enabled in the server |
|
248 |
* @since S60 5.0 |
|
249 |
* @return EFalse if not scanning |
|
250 |
*/ |
|
251 |
IMPORT_C TBool IsScanEnabledL(); |
|
252 |
||
253 |
/** |
|
254 |
* Continues browsing |
|
255 |
* @since S60 5.0 |
|
256 |
*/ |
|
257 |
IMPORT_C void ContinueBrowsingL(); |
|
258 |
||
259 |
/** |
|
260 |
* Continues browsing (browser launched if needed) |
|
261 |
* @since S60 5.0 |
|
262 |
* @param aIapId The IAP id to use with the browser |
|
263 |
*/ |
|
264 |
IMPORT_C void ContinueBrowsingL( TUint32 aIapId ); |
|
265 |
||
266 |
/** |
|
267 |
* Creates new WLAN access point based on wlaninfo passed as parameter. |
|
268 |
* If aExplicitDefine is ETrue, the connection method is saved to the |
|
269 |
* destination selected by the user, otherwise it is put into the |
|
270 |
* Uncategorized folder. |
|
271 |
* @since S60 5.0 |
|
272 |
* @param aWlan Reference to Wlan which is used as base |
|
273 |
* for new access point |
|
274 |
* @param aExplicitDefine Should be ETrue in case of |
|
275 |
* 'Define access point' |
|
276 |
* @return ETrue if access point creation succeeds |
|
277 |
*/ |
|
278 |
IMPORT_C TBool CreateAccessPointL( TWsfWlanInfo& aWlan, |
|
279 |
TBool aExplicitDefine ); |
|
280 |
||
281 |
/** |
|
282 |
* Requests a rescan for available wlans |
|
283 |
* @since S60 5.0 |
|
284 |
* @return ETrue on success |
|
285 |
*/ |
|
286 |
IMPORT_C TBool RefreshScanL(); |
|
287 |
||
288 |
/** |
|
289 |
* Asyncronous request to the server to make a scan |
|
290 |
* @since S60 5.2 |
|
291 |
* @param aPckg request result |
|
292 |
* @param aStatus The request status object used to contain |
|
293 |
* the completion status of the request. |
|
294 |
*/ |
|
295 |
IMPORT_C void RefreshScan( TPckgBuf<TBool>& aPckg, |
|
296 |
TRequestStatus& aStatus ); |
|
297 |
||
298 |
/** |
|
299 |
* Closes helper application if it is launched |
|
300 |
* @since S60 5.2 |
|
301 |
* @return ETrue if helper application task was closed |
|
302 |
*/ |
|
303 |
IMPORT_C TBool CloseHelperApplication(); |
|
304 |
||
305 |
/** |
|
306 |
* Launches and helper application to create an accesspoint |
|
307 |
* @since S60 5.2 |
|
308 |
* @param aWlanInfo The WlanInfo object to be passed to the helper app |
|
309 |
*/ |
|
310 |
IMPORT_C void LaunchHelperApplicationL( TWsfWlanInfo& aWlanInfo ); |
|
311 |
||
312 |
/** |
|
313 |
* Cancel notify events from server |
|
314 |
* @since S60 5.0 |
|
315 |
*/ |
|
316 |
IMPORT_C void CancelNotifyEvents(); |
|
317 |
||
318 |
/** |
|
319 |
* Request notify events from server |
|
320 |
* @since S60 5.0 |
|
321 |
* @param aObserver Instance of MWsfStateChangeObserver to handle events |
|
322 |
*/ |
|
323 |
IMPORT_C void RequestNotifyEventsL( |
|
324 |
MWsfStateChangeObserver& aObserver ); |
|
325 |
||
326 |
/** |
|
327 |
* Queries if there is an active WLAN connection. |
|
328 |
* @since S60 5.0 |
|
329 |
* @return ETrue if there is an active WLAN connection, |
|
330 |
* EFalse otherwise. |
|
331 |
*/ |
|
332 |
IMPORT_C TBool IsConnectedL(); |
|
333 |
||
334 |
/** |
|
335 |
* If there is an active WLAN connection, returns its WLAN info. |
|
336 |
* @since S60 5.0 |
|
337 |
* @param aWlanInfo The wlaninfo object to fill |
|
338 |
* @return ETrue if success, EFalse otherwise. |
|
339 |
*/ |
|
340 |
IMPORT_C TBool GetConnectedWlanDetailsL( TWsfWlanInfo& aWlanInfo ); |
|
341 |
||
342 |
/** |
|
343 |
* Asyncronous request to the server to return connected network |
|
344 |
* @since S60 5.2 |
|
345 |
* @param aPckg request result |
|
346 |
* @param aWlanInfo The wlaninfo object to fill |
|
347 |
* @param aStatus The request status object used to contain |
|
348 |
* the completion status of the request. |
|
349 |
*/ |
|
350 |
IMPORT_C void GetConnectedWlanDetails( TPckgBuf<TBool>& aPckg, |
|
351 |
TWsfWlanInfo& aWlanInfo, |
|
352 |
TRequestStatus& aStatus ); |
|
353 |
||
354 |
/** |
|
355 |
* Queries whether a connecting process is going on |
|
356 |
* @since S60 5.0 |
|
357 |
* @return ETrue if connection is in progress |
|
358 |
*/ |
|
359 |
inline TBool IsConnecting() const; |
|
360 |
||
361 |
/** |
|
362 |
* Sets connecting status |
|
363 |
* @since S60 5.0 |
|
364 |
* @param aIsConnecting The new status of the connecting process |
|
365 |
*/ |
|
366 |
inline void SetConnecting( TBool aIsConnecting ); |
|
367 |
||
368 |
/** |
|
369 |
* Aborts the currently ongoing connecting process |
|
370 |
* @since S60 5.0 |
|
371 |
*/ |
|
372 |
IMPORT_C void AbortConnectingL(); |
|
373 |
||
374 |
/** |
|
375 |
* Aborts the currently ongoing scanning process |
|
376 |
* @since S60 5.0 |
|
377 |
*/ |
|
378 |
IMPORT_C void AbortScanningL(); |
|
379 |
||
380 |
/** |
|
381 |
* Check if Iap Id is valid |
|
382 |
* Leaves with system wide error code if Iap ID is |
|
383 |
* not valid or checking fails |
|
384 |
* @since S60 5.2 |
|
385 |
* @param aIapId IAP id passed as a parameter |
|
386 |
*/ |
|
387 |
IMPORT_C void CheckIsIapIdValidL( TUint aIapId ) const; |
|
388 |
||
389 |
public: // from MWsfBrowserLaunchAdapter |
|
390 |
/** |
|
391 |
* Launches Browser application using selected iap |
|
392 |
* @since S60 5.0 |
|
393 |
* @param aIapId IAP id passed as a parameter |
|
394 |
*/ |
|
395 |
IMPORT_C void LaunchBrowserL( TUint32 aIapId ); |
|
396 |
||
397 |
||
398 |
public: // From MWsfBrowserLaunchObserver |
|
399 |
||
400 |
/** |
|
401 |
* Called if browser launch succeeds |
|
402 |
* @since S60 5.0 |
|
403 |
*/ |
|
404 |
void BrowserLaunchCompleteL(); |
|
405 |
||
406 |
/** |
|
407 |
* Called if browser launch failed |
|
408 |
* @since S60 5.0 |
|
409 |
* @param aError System-wide error code |
|
410 |
*/ |
|
411 |
void BrowserLaunchFailed( TInt aError ); |
|
412 |
||
413 |
/** |
|
414 |
* Called when the previously launched browser exits |
|
415 |
* @since S60 5.0 |
|
416 |
*/ |
|
417 |
void BrowserExitL(); |
|
418 |
||
419 |
||
420 |
private: // from MWsfScreenSaverStateObserver |
|
421 |
||
422 |
/** |
|
423 |
* Called if the status of the screensaver has been changed |
|
424 |
* @since S60 5.0 |
|
425 |
* @param aScreenSaverActive Current status of the screensaver |
|
426 |
*/ |
|
427 |
void ScreenSaverStatusChangedL( const TBool aScreenSaverActive ); |
|
428 |
||
429 |
||
430 |
private: // New methods |
|
431 |
||
432 |
/** |
|
433 |
* Check if there is disk space left |
|
434 |
* Leaves with KErrDiskFull is space is below CL |
|
435 |
* @since S60 5.0 |
|
436 |
*/ |
|
437 |
void CheckSpaceBelowCriticalLevelL() const; |
|
438 |
||
439 |
/** |
|
440 |
* Check if access point to be created is |
|
441 |
* unknow and Network encryption is WAPI |
|
442 |
* Leaves with KErrWlanProtectedSetupSetupLocked |
|
443 |
* in the case of unknown WAPI AP. |
|
444 |
* @since S60 5.2 |
|
445 |
*/ |
|
446 |
void CheckUnknownWapiL( TWsfWlanInfo& aWlan ) const; |
|
447 |
||
448 |
private: // Data |
|
449 |
/** |
|
450 |
* Reference to the current UI environment (not owned) |
|
451 |
*/ |
|
452 |
CEikonEnv* iEikEnv; |
|
453 |
||
454 |
/** |
|
455 |
* Reference to the model observer (not owned) |
|
456 |
*/ |
|
457 |
MWsfModelObserver* iObserver; |
|
458 |
||
459 |
/** |
|
460 |
* Browser launcher class. Owned. |
|
461 |
*/ |
|
462 |
CWsfAppLauncher* iBrowserLauncher; |
|
463 |
||
464 |
/** |
|
465 |
* Screen saver watcher class. Owned. |
|
466 |
*/ |
|
467 |
CWsfScreenSaverWatcher* iScreenSaverWatcher; |
|
468 |
||
469 |
/** |
|
470 |
* Client-side handle for server session |
|
471 |
*/ |
|
472 |
RWsfSession iSession; |
|
473 |
||
474 |
/** |
|
475 |
* Array to store WLAN scan results. Owned. |
|
476 |
*/ |
|
477 |
CWsfWlanInfoArray* iArray; |
|
478 |
||
479 |
/** |
|
480 |
* UID of active view |
|
481 |
*/ |
|
482 |
TUid iActiveView; |
|
483 |
||
484 |
/** |
|
485 |
* Name of currently observed WLAN |
|
486 |
*/ |
|
487 |
HBufC8* iObservedWlan; |
|
488 |
||
489 |
/** |
|
490 |
* Id of currently connected IAP (if applicable) |
|
491 |
*/ |
|
492 |
TUint iConnectedIapId; |
|
493 |
||
494 |
/** |
|
495 |
* Refreshing status |
|
496 |
*/ |
|
497 |
TBool iRefreshing; |
|
498 |
||
499 |
/** |
|
500 |
* Indicates whether connection creation has been started but not |
|
501 |
* finished yet. |
|
502 |
*/ |
|
503 |
TBool iConnecting; |
|
504 |
||
505 |
}; |
|
506 |
||
507 |
||
508 |
#include "wsfmodel.inl" |
|
509 |
||
510 |
||
511 |
||
512 |
#endif // C_WSFMODEL_H |
|
513 |
||
514 |
// End of file |