author | Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> |
Tue, 14 Sep 2010 21:37:10 +0300 | |
branch | RCL_3 |
changeset 61 | 269724087bed |
parent 56 | 9386f31cc85b |
child 72 | 4b59561a31c0 |
permissions | -rw-r--r-- |
56 | 1 |
/* |
2 |
* Copyright (c) 2002 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: Declares Bluetooth notifiers base class. |
|
15 |
* |
|
16 |
*/ |
|
17 |
||
18 |
||
19 |
#ifndef BTNOTIFIERBASE_H |
|
20 |
#define BTNOTIFIERBASE_H |
|
21 |
||
22 |
// INCLUDES |
|
23 |
||
24 |
#include "btnotif.h" |
|
25 |
#include "btnotifuiutil.h" |
|
26 |
#include <eikenv.h> |
|
27 |
#include <btdevice.h> |
|
28 |
#include <btengdevman.h> |
|
29 |
||
30 |
// CONSTANTS |
|
31 |
||
32 |
// Literals for resource and bitmap files ( drive, directory, filename(s) ) |
|
33 |
||
34 |
const TUid KBTInquiryChannel = {0x00000601}; // Channel for inquiry notifier |
|
35 |
const TUid KBTAuthorisationChannel = {0x00000602}; // Channel for PIN query notifier |
|
36 |
const TUid KBTAuthenticationChannel = {0x00000603}; // Channel for authorisation notifier |
|
37 |
const TUid KBTBBEventChannel = {0x00000604}; // Channel for baseband event notifier |
|
38 |
const TUid KBTObexPINChannel = {0x00000605}; // Channel for OBEX PIN notifier |
|
39 |
const TUid KBTPowerModeChannel = {0x00000606}; // Channel for power mode notifier |
|
40 |
const TUid KBTAudioAccessoryChannel = {0x00000607}; // Channel for audio accessory notifier |
|
41 |
const TUid KBTLowMemoryChannel = {0x00000608}; // Channel for low memory notifier |
|
42 |
const TUid KBTPairedDeviceSettingChannel = {0x00000610}; |
|
43 |
||
44 |
// FORWARD DECLARATIONS |
|
45 |
class CBTEngSettings; |
|
46 |
||
47 |
enum TBTRegistryQueryState |
|
48 |
{ |
|
49 |
ENoQuery=0, |
|
50 |
EQueryPaired=1, |
|
51 |
EQueryUsed=2, |
|
52 |
ESetDeviceAuthorizeState, |
|
53 |
ESetDeviceBlocked, |
|
54 |
ESetDeviceUnblocked, |
|
55 |
}; |
|
56 |
||
57 |
// CLASS DECLARATION |
|
58 |
/** |
|
59 |
* This class is the base class for all notifiers. |
|
60 |
*/ |
|
61 |
NONSHARABLE_CLASS(CBTNotifierBase): public CBase, public MEikSrvNotifierBase2, MBTEngDevManObserver |
|
62 |
{ |
|
63 |
public: // Constructors and destructor |
|
64 |
||
65 |
/** |
|
66 |
* Destructor. |
|
67 |
*/ |
|
68 |
virtual ~CBTNotifierBase(); |
|
69 |
||
70 |
/** |
|
71 |
* A utility function for checking whether autolock is on. |
|
72 |
* @param None. |
|
73 |
* @return A boolean according to autolock state. |
|
74 |
*/ |
|
75 |
TBool AutoLockOnL(); |
|
76 |
||
77 |
protected: // Constructors and destructor |
|
78 |
||
79 |
/** |
|
80 |
* C++ default constructor. |
|
81 |
*/ |
|
82 |
CBTNotifierBase(); |
|
83 |
||
84 |
protected: // New functions |
|
85 |
||
86 |
/** |
|
87 |
* Symbian 2nd phase constructor. |
|
88 |
*/ |
|
89 |
virtual void ConstructL(); |
|
90 |
||
91 |
/** |
|
61
269724087bed
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
56
diff
changeset
|
92 |
* Used in asynchronous notifier launch to start the actual processing |
269724087bed
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
56
diff
changeset
|
93 |
* of parameters received in StartL. StartL just stores a copy of the |
269724087bed
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
56
diff
changeset
|
94 |
* parameter buffer, schedules a callback to call this method and returns |
269724087bed
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
56
diff
changeset
|
95 |
* ASAP, so the actual work begins here, safely outside of the StartL |
269724087bed
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
56
diff
changeset
|
96 |
* context so that waiting dialogs can be freely used if need be. |
56 | 97 |
* @return None. |
98 |
*/ |
|
61
269724087bed
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
56
diff
changeset
|
99 |
virtual void ProcessStartParamsL() = 0; |
56 | 100 |
|
101 |
/** |
|
102 |
* A utility function for setting the power status of Bluetooth. |
|
103 |
* If the power is not on the user will be presented a query. |
|
104 |
* @return ETrue if BT is turned on successfully; EFalse otherwise |
|
105 |
*/ |
|
106 |
TBool CheckAndSetPowerOnL(); |
|
107 |
||
108 |
/** |
|
109 |
* A function for setting BT name |
|
110 |
* @return ETrue if BT name is set successfully; EFalse otherwise |
|
111 |
*/ |
|
112 |
TBool AskLocalBTNameQueryL(); |
|
113 |
||
114 |
/** |
|
115 |
* Check if there is any existing connection to audio profiles from |
|
116 |
* the same device |
|
117 |
* @return ETrue if the device is connected. |
|
118 |
*/ |
|
119 |
TBool IsExistingConnectionToAudioL(const TBTDevAddr& aDevAddr); |
|
120 |
||
121 |
/** |
|
122 |
* Complete Client/Server message and Nulled the reply slot. |
|
123 |
* @param aErr Error code for client notification. |
|
124 |
* @return None |
|
125 |
*/ |
|
126 |
void CompleteMessage(TInt aErr); |
|
127 |
||
128 |
/** |
|
129 |
* Complete Client/Server message and Nulled the reply slot. |
|
130 |
* @param aErr Error code for client notification. |
|
131 |
* @return None |
|
132 |
*/ |
|
133 |
void CompleteMessage(TInt aValueToReplySlot, TInt aErr); |
|
134 |
||
135 |
/** |
|
136 |
* Complete Client/Server message and Nulled the reply slot. |
|
137 |
* @param aErr Error code for client notification. |
|
138 |
* @return None |
|
139 |
*/ |
|
140 |
void CompleteMessage(const TDesC8& aDesToReplySlot, TInt aErr); |
|
141 |
||
142 |
/** |
|
143 |
* Checks from central repository whether the Bluetooth friendly name |
|
144 |
* has been modified . |
|
145 |
* @return ETure if the name has been modified. |
|
146 |
*/ |
|
147 |
TBool IsLocalNameModifiedL(); |
|
148 |
||
149 |
/** |
|
150 |
* Get the device information from BT Registry by the given address. |
|
151 |
*/ |
|
152 |
void GetDeviceFromRegL(const TBTDevAddr& aAddr); |
|
153 |
||
154 |
/** |
|
155 |
* virtual function to be ovewritten by sub-classes. |
|
156 |
* Will be called when Getting Device by BTEng DevMan is completed. |
|
157 |
* @param aDev the device from registry if it is not null. indicates either a failure |
|
158 |
* or the device is not available in registry. |
|
159 |
*/ |
|
160 |
virtual void HandleGetDeviceCompletedL(const CBTDevice* aDev); |
|
161 |
||
162 |
/** |
|
163 |
* Asks the user if s/he want's to block the device in question |
|
164 |
* Does not block the device. That is left to the caller. |
|
165 |
* NOTE: Cannot be called while iAuthQueryDlg is active. |
|
166 |
*/ |
|
167 |
void QueryBlockDeviceL(); |
|
168 |
||
169 |
/** |
|
170 |
* Set BTDevice's security setting to blocked and modify device |
|
171 |
* @param None |
|
172 |
* @return None |
|
173 |
*/ |
|
174 |
void DoBlockDevice(); |
|
175 |
||
176 |
/** |
|
177 |
* Set BTDevice's security setting to un/authorized and modify device |
|
178 |
* @param aTrust Set authorized if ETrue; otherwise, unauthorized. |
|
179 |
* @return None |
|
180 |
*/ |
|
181 |
void ChangeAuthorizeState( TBool aTrust); |
|
182 |
||
183 |
/** |
|
184 |
* Checks if the user is queried too often, and handle the result. |
|
185 |
* @return None |
|
186 |
*/ |
|
187 |
void CheckAndHandleQueryIntervalL(); |
|
188 |
||
189 |
private: |
|
190 |
||
191 |
void DoHandleGetDevicesCompleteL(TInt aErr, CBTDeviceArray* aDeviceArray ); |
|
192 |
||
193 |
protected: // Functions from base classes |
|
194 |
||
195 |
/** |
|
196 |
* From MEikSrvNotifierBase2 Called when a notifier is first loaded |
|
197 |
* to allow any initial construction that is required. |
|
198 |
* @param None. |
|
199 |
* @return A structure containing priority and channel info. |
|
200 |
*/ |
|
201 |
virtual TNotifierInfo RegisterL()=0; |
|
202 |
||
203 |
/** |
|
204 |
* From MEikSrvNotifierBase2 The notifier has been deactivated |
|
205 |
* so resources can be freed and outstanding messages completed. |
|
206 |
* @param None. |
|
207 |
* @return None. |
|
208 |
*/ |
|
209 |
virtual void Cancel(); |
|
210 |
||
211 |
#ifdef __SERIES60_HELP |
|
212 |
/** This is used to create TCallBack to help. |
|
213 |
* @param TCoeHelpContext. Must be instance TCoeHelpContext, or NULL. |
|
214 |
* If null this will open help about blocked devices., |
|
215 |
* @return KErrNone |
|
216 |
*/ |
|
217 |
static TInt LaunchHelp(TAny *TCoeHelpContext=NULL); |
|
218 |
#endif |
|
219 |
||
220 |
private: // Functions from base classes |
|
221 |
||
222 |
/** |
|
223 |
* From MEikSrvNotifierBase2 Called when all resources allocated |
|
224 |
* by notifiers should be freed. |
|
225 |
* @param None. |
|
226 |
* @return None. |
|
227 |
*/ |
|
228 |
virtual void Release(); |
|
229 |
||
230 |
/** |
|
231 |
* From MEikSrvNotifierBase2 Return the priority a notifier takes |
|
232 |
* and the channels it acts on. |
|
233 |
* @param None. |
|
234 |
* @return A structure containing priority and channel info. |
|
235 |
*/ |
|
236 |
virtual TNotifierInfo Info() const; |
|
237 |
||
238 |
/** |
|
239 |
* From MEikSrvNotifierBase2 Synchronic notifier launch. |
|
240 |
* @param aBuffer Received parameter data. |
|
241 |
* @return A pointer to return value. |
|
242 |
*/ |
|
243 |
virtual TPtrC8 StartL(const TDesC8& aBuffer); |
|
244 |
||
245 |
/** |
|
246 |
* From MEikSrvNotifierBase2 Asynchronic notifier launch. |
|
247 |
* @param aBuffer A buffer containing received parameters |
|
248 |
* @param aReturnVal The return value to be passed back. |
|
249 |
* @param aMessage Should be completed when the notifier is deactivated. |
|
250 |
* @return A pointer to return value. |
|
251 |
*/ |
|
252 |
virtual void StartL(const TDesC8& aBuffer, TInt aReplySlot, const RMessagePtr2& aMessage); |
|
253 |
||
254 |
/** |
|
255 |
* From MEikSrvNotifierBase2 Updates a currently active notifier. |
|
256 |
* @param aBuffer The updated data. |
|
257 |
* @return A pointer to return value. |
|
258 |
*/ |
|
259 |
virtual TPtrC8 UpdateL(const TDesC8& aBuffer); |
|
260 |
||
261 |
/** |
|
262 |
* From MBTEngDevManObserver |
|
263 |
* Indicates to the caller that adding, deleting or modifying a device |
|
264 |
* has completed. |
|
265 |
*/ |
|
266 |
virtual void HandleDevManComplete(TInt aErr); |
|
267 |
||
268 |
/** |
|
269 |
* From MBTEngDevManObserver |
|
270 |
* Call back function when GetDevices() request is completed. |
|
271 |
* @param aErr Status information, if there is an error. |
|
272 |
* @param aDeviceArray Array of devices that match the given criteria |
|
273 |
* (the array provided by the calller). |
|
274 |
*/ |
|
275 |
void HandleGetDevicesComplete( TInt aErr, CBTDeviceArray* aDeviceArray ); |
|
276 |
||
277 |
/** |
|
278 |
* Checks the timestamp since last query. |
|
279 |
* @return true if too often |
|
280 |
*/ |
|
281 |
TBool CheckQueryInterval(); |
|
282 |
||
61
269724087bed
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
56
diff
changeset
|
283 |
static TInt ProcessStartParamsCallBack(TAny* aNotif); |
269724087bed
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
56
diff
changeset
|
284 |
|
56 | 285 |
protected: // Data |
286 |
||
287 |
RMessagePtr2 iMessage; // Received message |
|
288 |
TInt iReplySlot; // Reply slot |
|
61
269724087bed
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
56
diff
changeset
|
289 |
HBufC8* iParamBuffer; // Copy of the param buffer received in StartL |
269724087bed
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
56
diff
changeset
|
290 |
|
269724087bed
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
56
diff
changeset
|
291 |
CAsyncCallBack* iProcessStartParamsCallBack; |
269724087bed
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
56
diff
changeset
|
292 |
|
56 | 293 |
TNotifierInfo iInfo; // Notifier parameters structure |
294 |
TBTRegistryQueryState iBTRegistryQueryState; |
|
295 |
CBTDeviceArray* iDeviceArray; // for getting device from registry |
|
296 |
CBTDevice* iDevice; // Current Bluetooth device |
|
297 |
TBTDevAddr iBTAddr; // Gotten from PckBuffer, constant no matter how iDevice changes. |
|
298 |
CBTNotifUIUtil* iNotifUiUtil; // Utility to show UI notes & queries |
|
61
269724087bed
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
56
diff
changeset
|
299 |
CBTNotifUIUtil* iAuthoriseDialog; // to show Authorisation dialogs |
56 | 300 |
CBTEngSettings* iBTEngSettings; |
301 |
TBool iIsCoverUI; |
|
302 |
||
303 |
private: |
|
304 |
CBTEngDevMan* iDevMan; // for BT registry manipulation |
|
305 |
}; |
|
306 |
||
307 |
#endif |
|
308 |
||
309 |
// End of File |