32
|
1 |
/*
|
|
2 |
* Copyright (c) 2002-2010 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: Service starter
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
|
|
20 |
#ifndef BT_SERVICE_STARTER_H
|
|
21 |
#define BT_SERVICE_STARTER_H
|
|
22 |
|
|
23 |
// INCLUDES
|
|
24 |
#include "BTServiceAPI.h"
|
|
25 |
#include "BTServiceUtils.h"
|
|
26 |
#include "BTServiceParameterList.h"
|
42
|
27 |
#include "BTServiceDelayedDestroyer.h"
|
32
|
28 |
|
|
29 |
#include <btengdiscovery.h>
|
|
30 |
#include <btengsettings.h>
|
|
31 |
#include <obexutilsdialog.h>
|
|
32 |
#include <msvapi.h>
|
|
33 |
|
|
34 |
// DATA TYPES
|
|
35 |
|
|
36 |
enum TBTServiceProfile
|
|
37 |
{
|
|
38 |
EBTSNone,
|
|
39 |
EBTSBPP,
|
|
40 |
EBTSOPP,
|
|
41 |
EBTSBIP
|
|
42 |
};
|
|
43 |
|
|
44 |
enum TBTActiveNotifier
|
|
45 |
{
|
|
46 |
ENoneQuery = 0,
|
|
47 |
EOfflineQuery,
|
|
48 |
ENameQuery
|
|
49 |
};
|
|
50 |
|
|
51 |
// FORWARD DECLARATIONS
|
|
52 |
class CObexUtilsUiLayer;
|
|
53 |
class MBTServiceProgressGetter;
|
|
54 |
class CBTSController;
|
|
55 |
|
|
56 |
|
|
57 |
const TUint KBTSdpObjectPush = 0x1105;
|
|
58 |
const TUint KBTSdpBasicImaging = 0x111b;
|
|
59 |
const TUint KBTSdpBasicPrinting = 0x1120;
|
|
60 |
|
|
61 |
|
|
62 |
// CLASS DECLARATION
|
|
63 |
|
|
64 |
/**
|
|
65 |
* An observer interface for service controllers.
|
|
66 |
*/
|
|
67 |
class MBTServiceObserver
|
|
68 |
{
|
|
69 |
public: // New functions
|
|
70 |
|
|
71 |
/**
|
|
72 |
* Informs the observer that the handler has completed its tasks.
|
|
73 |
* @param aStatus The the completion status of the handler.
|
|
74 |
* @return None.
|
|
75 |
*/
|
|
76 |
virtual void ControllerComplete( TInt aStatus ) = 0;
|
|
77 |
|
|
78 |
/**
|
|
79 |
* Informs the observer that a progress note should be shown.
|
|
80 |
* @param aGetter A pointer to a progess status getter object.
|
|
81 |
* @return None.
|
|
82 |
*/
|
42
|
83 |
//todo reusing the second param aTotalsize to aFileCount as it wass no longer used check it being used in other places
|
|
84 |
virtual void LaunchProgressNoteL( MBTServiceProgressGetter* aGetter, TInt aFileCount) = 0;
|
32
|
85 |
|
|
86 |
|
|
87 |
/**
|
|
88 |
* Informs the observer that a progress note should be shown.
|
|
89 |
* @param aGetter A pointer to a progess status getter object.
|
|
90 |
* @return None.
|
|
91 |
*/
|
|
92 |
virtual void UpdateProgressNoteL(TInt aFileSize,TInt aFileIndex, const TDesC& aFileName ) = 0;
|
|
93 |
|
|
94 |
/**
|
|
95 |
* Informs the observer that a confirmation query for sending
|
42
|
96 |
* should be shouwn for BIP sending
|
32
|
97 |
* @return
|
|
98 |
*/
|
42
|
99 |
virtual void LaunchConfirmationQuery(const TDesC& aConfirmText)=0;
|
32
|
100 |
|
|
101 |
/**
|
|
102 |
* Informs the observer that a connect is timedout
|
|
103 |
* @return
|
|
104 |
*/
|
|
105 |
virtual void ConnectTimedOut()=0;
|
|
106 |
|
|
107 |
};
|
|
108 |
|
|
109 |
|
|
110 |
/**
|
|
111 |
* A starter class for Bluetooth services.
|
|
112 |
*/
|
|
113 |
NONSHARABLE_CLASS (CBTServiceStarter) : public CActive,
|
|
114 |
public MBTServiceObserver,
|
|
115 |
public MObexUtilsDialogObserver,
|
|
116 |
public MObexUtilsProgressObserver,
|
|
117 |
public MBTEngSdpResultReceiver,
|
57
|
118 |
public MBTEngSettingsObserver,
|
|
119 |
public MHbDeviceDialogObserver
|
32
|
120 |
{
|
|
121 |
public: // Constructors and destructor
|
|
122 |
|
|
123 |
/**
|
|
124 |
* Two-phased constructor.
|
|
125 |
*/
|
|
126 |
static CBTServiceStarter* NewL();
|
|
127 |
|
|
128 |
/**
|
|
129 |
* Destructor.
|
|
130 |
*/
|
|
131 |
virtual ~CBTServiceStarter();
|
|
132 |
|
|
133 |
public: // New functions
|
|
134 |
|
|
135 |
/**
|
|
136 |
* Starts the given service.
|
|
137 |
* @param aService The service to be started.
|
|
138 |
* @param aList Parameters for the service.
|
|
139 |
* @param aWaiter A pointer to a waiter object.
|
|
140 |
* @return None.
|
|
141 |
*/
|
|
142 |
void StartServiceL( TBTServiceType aService,
|
|
143 |
CBTServiceParameterList* aList,
|
|
144 |
CActiveSchedulerWait* aWaiter = NULL );
|
|
145 |
|
|
146 |
private: // Functions from base classes
|
|
147 |
|
|
148 |
|
|
149 |
|
|
150 |
/**
|
|
151 |
* From MBTServiceObserver A controller has completed.
|
|
152 |
* @param aStatus The completion status of the controller.
|
|
153 |
* @return None.
|
|
154 |
*/
|
|
155 |
void ControllerComplete( TInt aStatus );
|
|
156 |
|
|
157 |
/**
|
|
158 |
* From MBTServiceObserver A progress note should be shown.
|
|
159 |
* @param aGetter A pointer to a progess status getter object.
|
|
160 |
* @param aTotalSize Max size of the progress bar.
|
42
|
161 |
* @param aFileCount Total Number of files to be sent
|
32
|
162 |
* @return None.
|
|
163 |
*/
|
42
|
164 |
//todo reuse the second param as it is no longer used check it being used in other places
|
|
165 |
void LaunchProgressNoteL( MBTServiceProgressGetter* aGetter, TInt aFileCount);
|
32
|
166 |
|
|
167 |
|
|
168 |
/**
|
|
169 |
* From MBTServiceObserver Updating progress note when multiple files are sent.
|
|
170 |
* @param aFileSize Size of the file to be send.
|
|
171 |
* @param aFileIndex index of the file to be send.
|
|
172 |
* @param aFileName name of the file to be send.
|
|
173 |
* @return None.
|
|
174 |
*/
|
|
175 |
void UpdateProgressNoteL(TInt aFileSize,TInt aFileIndex, const TDesC& aFileName );
|
|
176 |
|
|
177 |
|
|
178 |
/**
|
|
179 |
* From MObexUtilsWaitDialogObserver The wait note has been dismissed.
|
|
180 |
* @param aButtonId The button id that was used to dismiss the dialog.
|
|
181 |
* @return None.
|
|
182 |
*/
|
42
|
183 |
void DialogDismissed(TInt aButtonId);
|
32
|
184 |
|
|
185 |
/**
|
|
186 |
* From MObexUtilsProgressObserver request for number of bytes sent
|
|
187 |
* @Param None.
|
|
188 |
* @return Number of bytes sent.
|
|
189 |
*/
|
|
190 |
TInt GetProgressStatus();
|
|
191 |
|
|
192 |
/**
|
|
193 |
* From MBTServiceObserver A confirmation query for BIP
|
|
194 |
* profile should be shown.
|
|
195 |
* @return key
|
|
196 |
*/
|
|
197 |
TInt LaunchConfirmationQuery(TInt aResourceId);
|
|
198 |
|
42
|
199 |
|
|
200 |
/**
|
|
201 |
* From MBTServiceObserver A confirmation query for BIP
|
|
202 |
* profile should be shown.
|
|
203 |
*/
|
|
204 |
void LaunchConfirmationQuery(const TDesC& aConfirmText);
|
|
205 |
|
32
|
206 |
/**
|
|
207 |
* From MBTServiceObserver a connect request is timedout
|
|
208 |
* @return
|
|
209 |
*/
|
|
210 |
void ConnectTimedOut();
|
|
211 |
|
|
212 |
|
|
213 |
/**
|
|
214 |
* Provides notification of the result of a service search that matches
|
|
215 |
* the requested UUID (through CBTEngDiscovery::RemoteSdpQuery).
|
|
216 |
* This method indicates that the search has completed, and returns
|
|
217 |
* all the results to the caller at once.
|
|
218 |
*
|
|
219 |
* @since S60 v3.2
|
|
220 |
* @param aResult Array of record handles that match the requested UUID.
|
|
221 |
* Note: the array will not be available anymore after
|
|
222 |
* this method returns.
|
|
223 |
* @param aTotalRecordsCount The total number of records returned.
|
|
224 |
* @param aErr Error code of the service search operation; KErrNone if
|
|
225 |
* sucessful, KErrEof if no record matched the requested UUID,
|
|
226 |
* KErrCouldNotConnect and KErrCouldDisconnected in case of
|
|
227 |
* Bluetooth connection errors; otherwise one of the
|
|
228 |
* system-wide error codes.
|
|
229 |
*/
|
|
230 |
void ServiceSearchComplete( const RSdpRecHandleArray& aResult,
|
|
231 |
TUint aTotalRecordsCount, TInt aErr );
|
|
232 |
|
|
233 |
/**
|
|
234 |
* Provides notification of the result of an attribute search that matches
|
|
235 |
* the requested attribute (through CBTEngDiscovery::RemoteSdpQuery).
|
|
236 |
* This method indicates that the search has completed, and returns
|
|
237 |
* all the results to the caller at once.
|
|
238 |
*
|
|
239 |
* @since S60 v3.2
|
|
240 |
* @param aHandle Record handle of the service record containing the result.
|
|
241 |
* @param aAttr Array containing the attribute that matches the
|
|
242 |
* requested attribute.
|
|
243 |
* Note: the array will not be available anymore after
|
|
244 |
* this method returns.
|
|
245 |
* @param aErr Error code of the service search operation; KErrNone if
|
|
246 |
* sucessful, KErrEof if the requested attribute was not
|
|
247 |
* contained in the specified service record,
|
|
248 |
* KErrCouldNotConnect and KErrCouldDisconnected in case of
|
|
249 |
* Bluetooth connection errors; otherwise one of the
|
|
250 |
* system-wide error codes.
|
|
251 |
*/
|
|
252 |
void AttributeSearchComplete( TSdpServRecordHandle aHandle,
|
|
253 |
const RSdpResultArray& aAttr,
|
|
254 |
TInt aErr );
|
|
255 |
|
|
256 |
/**
|
|
257 |
* Provides notification of the result of an combination of a service
|
|
258 |
* and attribute search (through CBTEngDiscovery::RemoteSdpQuery).
|
|
259 |
* This method is called for each service and attribute combination for
|
|
260 |
* which a match was found. The last result (which could be empty if no
|
|
261 |
* match was found) contain error code KErrEof to indicate that the
|
|
262 |
* search has completed.
|
|
263 |
*
|
|
264 |
* @since S60 v3.2
|
|
265 |
* @param aHandle Record handle of the service record containing the result.
|
|
266 |
* @param aAttr Array containing the attribute that matches the
|
|
267 |
* requested attribute.
|
|
268 |
* Note: the array will not be available anymore after
|
|
269 |
* this method returns.
|
|
270 |
* @param aErr Error code of the service search operation; KErrNone if
|
|
271 |
* sucessful and more results follow, KErrEof indicates that
|
|
272 |
* this is the last result (which could be empty if no match
|
|
273 |
* was found), KErrCouldNotConnect and KErrCouldDisconnected
|
|
274 |
* in case of Bluetooth connection errors; otherwise one of
|
|
275 |
* the system-wide error codes.
|
|
276 |
*/
|
|
277 |
void ServiceAttributeSearchComplete( TSdpServRecordHandle aHandle,
|
|
278 |
const RSdpResultArray& aAttr,
|
|
279 |
TInt aErr );
|
|
280 |
|
|
281 |
/**
|
|
282 |
* Provides notification of the result of the discovery of nearby
|
|
283 |
* Bluetooth devices.
|
|
284 |
*
|
|
285 |
* @since S60 v3.2
|
|
286 |
* @param aDevice The data structure encapsulates all information
|
|
287 |
* about the selected device. Ownership of the data
|
|
288 |
* structure has not been transfered and is still with
|
|
289 |
* the API client.
|
|
290 |
* @param aErr Error code of the device search operation; KErrNone if
|
|
291 |
* sucessful, KErrCancel if the user cancelled the
|
|
292 |
* dialog, KErrCancel if CBTEngDiscovery::CancelSearchRemoteDevice
|
|
293 |
* was called; otherwise one of the system-wide error codes.
|
|
294 |
*/
|
|
295 |
void DeviceSearchComplete( CBTDevice* aDevice, TInt aErr );
|
|
296 |
|
|
297 |
/**
|
|
298 |
* From MBTEngSettingsObserver.
|
|
299 |
* Provides notification of changes in the power state
|
|
300 |
* of the Bluetooth hardware.
|
|
301 |
*
|
|
302 |
* @since S60 v3.2
|
|
303 |
* @param aState EBTPowerOff if the BT hardware has been turned off,
|
|
304 |
* EBTPowerOn if it has been turned off.
|
|
305 |
*/
|
|
306 |
void PowerStateChanged( TBTPowerStateValue aState );
|
|
307 |
|
|
308 |
/**
|
|
309 |
* From MBTEngSettingsObserver.
|
|
310 |
* Provides notification of changes in the discoverability
|
|
311 |
* mode of the Bluetooth hardware.
|
|
312 |
*
|
|
313 |
* @since S60 v3.2
|
|
314 |
* @param aState EBTDiscModeHidden if the BT hardware is in hidden mode,
|
|
315 |
* EBTDiscModeGeneral if it is in visible mode.
|
|
316 |
*/
|
|
317 |
void VisibilityModeChanged( TBTVisibilityMode aState );
|
|
318 |
|
|
319 |
/**
|
|
320 |
* From CActive.
|
|
321 |
* Called by the active scheduler when the request has been cancelled.
|
|
322 |
*
|
|
323 |
* @since S60 v3.2
|
|
324 |
*/
|
|
325 |
void DoCancel();
|
|
326 |
|
|
327 |
/**
|
|
328 |
* From CActive.
|
|
329 |
* Called by the active scheduler when the request has been completed.
|
|
330 |
*
|
|
331 |
* @since S60 v3.2
|
|
332 |
*/
|
|
333 |
void RunL();
|
|
334 |
|
|
335 |
/**
|
|
336 |
* From CActive.
|
|
337 |
* Called by the active scheduler when an error in RunL has occurred.
|
|
338 |
*
|
|
339 |
* @since S60 v3.2
|
|
340 |
*/
|
|
341 |
TInt RunError( TInt aError );
|
|
342 |
|
|
343 |
private:
|
|
344 |
|
|
345 |
/**
|
|
346 |
* C++ default constructor.
|
|
347 |
*/
|
|
348 |
CBTServiceStarter();
|
|
349 |
|
|
350 |
/**
|
|
351 |
* By default Symbian 2nd phase constructor is private.
|
|
352 |
*/
|
|
353 |
void ConstructL();
|
|
354 |
|
|
355 |
/**
|
|
356 |
* Check that the parameters are valid for a given service.
|
|
357 |
* @param aService The requested service.
|
|
358 |
* @param aList Parameters for the service.
|
|
359 |
* @return None.
|
|
360 |
*/
|
|
361 |
TBool ValidParameters( TBTServiceType aService,
|
|
362 |
const CBTServiceParameterList* aList) const;
|
|
363 |
|
|
364 |
/**
|
|
365 |
* Starts finding a Bluetooth profile suitable for requested service.
|
|
366 |
* @param aService The requested service.
|
|
367 |
* @return None.
|
|
368 |
*/
|
|
369 |
void StartProfileSelectL( TBTServiceType aService );
|
|
370 |
|
|
371 |
/**
|
|
372 |
* Start a controller for the given Bluetooth profile.
|
|
373 |
* @param aProfile The profile to be started.
|
|
374 |
* @return None.
|
|
375 |
*/
|
|
376 |
void StartProfileL( TBTServiceProfile aProfile );
|
|
377 |
|
|
378 |
/**
|
|
379 |
* Launches a connecting wait note
|
|
380 |
* @param None.
|
|
381 |
* @return None.
|
|
382 |
*/
|
|
383 |
void LaunchWaitNoteL();
|
|
384 |
|
|
385 |
/**
|
|
386 |
* Cancel connecting wait note
|
|
387 |
* @param None.
|
|
388 |
* @return None.
|
|
389 |
*/
|
|
390 |
void CancelWaitNote();
|
|
391 |
|
|
392 |
/**
|
|
393 |
* Show a note with given error value
|
|
394 |
* @param aReason Error value
|
|
395 |
* @return None.
|
|
396 |
*/
|
57
|
397 |
void ShowErrorNote( TInt aReason );
|
32
|
398 |
|
|
399 |
/**
|
|
400 |
* Cancel progress note
|
|
401 |
* @param None.
|
|
402 |
* @return None.
|
|
403 |
*/
|
|
404 |
void CancelProgressNote();
|
|
405 |
|
|
406 |
/**
|
|
407 |
* StopTransfer and show information note
|
|
408 |
* @param aError Error code if error exist.
|
|
409 |
* @return None.
|
|
410 |
*/
|
|
411 |
void StopTransfer( TInt aError );
|
|
412 |
|
|
413 |
/**
|
|
414 |
* Check if phone is in offline mode, and ask the user if it is..
|
|
415 |
* @return ETrue if the phone is in offline mode, otherwise EFalse.
|
|
416 |
*/
|
|
417 |
TBool CheckOfflineModeL();
|
|
418 |
|
|
419 |
/**
|
|
420 |
* Start BT device discovery.
|
|
421 |
* @return None.
|
|
422 |
*/
|
|
423 |
void StartDiscoveryL();
|
|
424 |
|
|
425 |
/**
|
|
426 |
* Turn BT power on.
|
|
427 |
* @param aState The current BT power state.
|
|
428 |
* @return None.
|
|
429 |
*/
|
|
430 |
void TurnBTPowerOnL( const TBTPowerStateValue aState );
|
|
431 |
|
57
|
432 |
/**
|
|
433 |
* Shows appropriate result of the send request using the BTDeviceDialogPlugin
|
|
434 |
* The dialog shown will be of discreet notifcation type
|
|
435 |
* @param aDialogTitle The notification dialog title
|
|
436 |
*/
|
|
437 |
void ShowSendCompleteNoteL( const TInt aDialogTitle );
|
|
438 |
|
|
439 |
/**
|
|
440 |
* Shows appropriate result of the send request using the BTDeviceDialogPlugin
|
|
441 |
* The dialog shown will be of message box type
|
|
442 |
* @param aDialogTitle The notification dialog title
|
|
443 |
* */
|
|
444 |
void ShowErrorMessageL( const TInt aDialogTitle,
|
|
445 |
const TDesC& aConfirmText = KNullDesC);
|
|
446 |
|
|
447 |
|
|
448 |
void AddDataL(CHbSymbianVariantMap* aMap, const TInt aKey,
|
|
449 |
const TAny* aData, CHbSymbianVariant::TType aDataType);
|
|
450 |
|
|
451 |
private: // From MHbDeviceDialogObserver
|
|
452 |
void DataReceived(CHbSymbianVariantMap& aData);
|
|
453 |
|
|
454 |
void DeviceDialogClosed(TInt aCompletionCode);
|
|
455 |
|
32
|
456 |
private: // Data definitions
|
|
457 |
|
|
458 |
enum TBTServiceStarterState
|
|
459 |
{
|
|
460 |
EBTSStarterIdle,
|
|
461 |
EBTSStarterFindingBPP,
|
|
462 |
EBTSStarterFindingOPP,
|
|
463 |
EBTSStarterFindingBIP,
|
|
464 |
EBTSStarterStoppingService
|
|
465 |
};
|
|
466 |
|
|
467 |
private: // Data
|
|
468 |
|
|
469 |
CBTDevice* iDevice;
|
|
470 |
CBTEngDiscovery* iBTEngDiscovery;
|
|
471 |
CBTServiceParameterList* iList;
|
42
|
472 |
CObexUtilsDialog* iDialog;
|
32
|
473 |
CBTSController* iController;
|
|
474 |
|
|
475 |
TBTServiceType iService;
|
|
476 |
TInt iClientChannel;
|
|
477 |
TBTServiceStarterState iState;
|
42
|
478 |
//todo verify the usage of below variable when file sending to mulitple devices or
|
|
479 |
//when files from different applications are sent simultaneously
|
32
|
480 |
TBool iServiceStarted;
|
|
481 |
TMsvId iMessageServerIndex;
|
|
482 |
|
|
483 |
MBTServiceProgressGetter* iProgressGetter;
|
|
484 |
CActiveSchedulerWait* iWaiter;
|
|
485 |
TBool iAllSend;
|
|
486 |
TInt iBytesSendWithBIP;
|
42
|
487 |
//todo verify the usage of below variable as this part of legacy code
|
|
488 |
//and false condition will never be hit.
|
32
|
489 |
TBool iProgressDialogActive;
|
|
490 |
TBool iUserCancel;
|
|
491 |
CBTEngSettings* iBTEngSettings;
|
|
492 |
TBool iWaitingForBTPower;
|
|
493 |
RNotifier iNotifier; // Handle to the generic notifier.
|
|
494 |
TPckgBuf<TBool> iOffline;
|
|
495 |
TPckgBuf<TBool> iName;
|
|
496 |
TBool iSendToBIPOnlyDevice;
|
|
497 |
TBTActiveNotifier iActiveNotifier;
|
|
498 |
TBool iFeatureManagerInitialized;
|
|
499 |
TBool iTriedBIP;
|
|
500 |
TBool iTriedOPP;
|
42
|
501 |
CBTServiceDelayedDestroyer* iDelayedDestroyer;
|
57
|
502 |
CHbDeviceDialogSymbian* iNotificationDialog;
|
|
503 |
RBuf iRemoteDeviceName;
|
|
504 |
TUint32 iRemoteDeviceClass;
|
|
505 |
TBool iShowDialogNote;
|
32
|
506 |
};
|
|
507 |
|
|
508 |
#endif // BT_SERVICE_CONTROLLER_H
|
|
509 |
|
|
510 |
// End of File
|
|
511 |
|