29
|
1 |
/*
|
31
|
2 |
* Copyright (c) 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: Server class for handling commands from clients, and the
|
29
|
15 |
* central class in btnotif thread.
|
|
16 |
*
|
|
17 |
*/
|
|
18 |
|
|
19 |
#ifndef BTNOTIFSERVER_H
|
|
20 |
#define BTNOTIFSERVER_H
|
|
21 |
|
|
22 |
|
|
23 |
#include <e32base.h>
|
|
24 |
#include <btengsettings.h>
|
|
25 |
|
|
26 |
#include "bluetoothtrace.h"
|
|
27 |
|
|
28 |
class CBTNotifConnectionTracker;
|
|
29 |
class CBTNotifSettingsTracker;
|
|
30 |
class CBTNotificationManager;
|
|
31 |
class CBTNotifDeviceSelector;
|
57
|
32 |
class CBTNotifGenInfoNotifier;
|
|
33 |
class CBTNotifPowerNotifier;
|
29
|
34 |
class CBtDevRepository;
|
|
35 |
|
|
36 |
class CbtnotifServerTest; // ToDo: shall be refactored under compile flag?
|
|
37 |
|
|
38 |
/**
|
|
39 |
* Utility function for panicking the server.
|
|
40 |
*
|
|
41 |
* @since Symbian^4
|
|
42 |
* @param aReason The panic reason code.
|
|
43 |
*/
|
|
44 |
void PanicServer( TInt aReason );
|
|
45 |
|
|
46 |
/**
|
|
47 |
* Utility function for panicking the server.
|
|
48 |
*
|
|
49 |
* @since Symbian^4
|
|
50 |
* @param aMessage The handle to the client side.
|
|
51 |
* @param aReason The panic reason code.
|
|
52 |
*/
|
|
53 |
void PanicClient( const RMessage2& aMessage, TInt aReason );
|
|
54 |
|
|
55 |
/** BTNotif panic codes */
|
|
56 |
enum TBTNotifServerPanic
|
|
57 |
{
|
|
58 |
EBTNotifPanicUnknown,
|
|
59 |
EBTNotifPanicCorrupt,
|
|
60 |
EBTNotifPanicMissing,
|
|
61 |
EBTNotifPanicNullMember,
|
|
62 |
EBTNotifPanicBadState,
|
|
63 |
EBTNotifPanicBadArgument,
|
|
64 |
EBTNotifPanicBadResult
|
|
65 |
};
|
|
66 |
|
|
67 |
/** Convenience macro for indicating unimplemented events */
|
|
68 |
#define NOTIF_NOTIMPL
|
|
69 |
//{ __ASSERT_ALWAYS( 1, PanicServer( EBTNotifPanicNotImplemented ) ); }
|
|
70 |
/** Convenience macro for indicating unhandled events */
|
|
71 |
#define NOTIF_NOTHANDLED( cond )
|
|
72 |
//{ __ASSERT_ALWAYS( cond, PanicServer( EBTNotifPanicNotHandled ) ); }
|
|
73 |
|
|
74 |
|
|
75 |
/**
|
|
76 |
* CBTNotifServer handles notifications and also maintains state information related to
|
|
77 |
* the local device as well as remote devices.
|
|
78 |
*
|
|
79 |
* @since Symbian^4
|
|
80 |
*/
|
|
81 |
NONSHARABLE_CLASS( CBTNotifServer ) : public CPolicyServer
|
|
82 |
{
|
|
83 |
|
|
84 |
public:
|
|
85 |
|
|
86 |
/**
|
|
87 |
* Two-phased constructor.
|
|
88 |
*/
|
|
89 |
static CBTNotifServer* NewLC();
|
|
90 |
|
|
91 |
/**
|
|
92 |
* Destructor.
|
|
93 |
*/
|
|
94 |
virtual ~CBTNotifServer();
|
|
95 |
|
|
96 |
/**
|
|
97 |
* Called when the BT power state changes.
|
|
98 |
*
|
|
99 |
* @since Symbian^4
|
|
100 |
* @param aState The new BT power state.
|
|
101 |
*/
|
|
102 |
void HandlePowerStateChangeL( TBTPowerStateValue aState );
|
|
103 |
|
|
104 |
/**
|
|
105 |
* Called by a session during creation, to keep track of the number
|
|
106 |
* of active sessions.
|
|
107 |
*
|
|
108 |
* @since Symbian^4
|
|
109 |
*/
|
|
110 |
void AddSession();
|
|
111 |
|
|
112 |
/**
|
|
113 |
* Called by a session during destruction, to keep track of the number
|
|
114 |
* of active sessions.
|
|
115 |
*
|
|
116 |
* @since Symbian^4
|
|
117 |
*/
|
|
118 |
void RemoveSession();
|
|
119 |
|
|
120 |
/**
|
|
121 |
* Returns a handle to the settings tracker.
|
|
122 |
*
|
|
123 |
* @since Symbian^4
|
|
124 |
* @param Pointer to the settings tracker.
|
|
125 |
*/
|
|
126 |
inline CBTNotifSettingsTracker* SettingsTracker() const
|
|
127 |
{ return iSettingsTracker; }
|
|
128 |
|
|
129 |
/**
|
|
130 |
* Returns a handle to the connection tracker.
|
|
131 |
*
|
|
132 |
* @since Symbian^4
|
|
133 |
* @param Pointer to the connection tracker.
|
|
134 |
*/
|
|
135 |
inline CBTNotifConnectionTracker* ConnectionTracker() const
|
|
136 |
{ return iConnectionTracker; }
|
|
137 |
|
|
138 |
/**
|
|
139 |
* Returns a handle to the notification manager.
|
|
140 |
*
|
|
141 |
* @since Symbian^4
|
|
142 |
* @param Pointer to the notification manager.
|
|
143 |
*/
|
|
144 |
inline CBTNotificationManager* NotificationManager() const
|
|
145 |
{ return iNotificationMgr; }
|
|
146 |
|
|
147 |
CBtDevRepository& DevRepository();
|
|
148 |
|
|
149 |
CBTNotifDeviceSelector& DeviceSelectorL();
|
57
|
150 |
|
|
151 |
/**
|
|
152 |
* Returns a handle to the Generic info notifier.
|
|
153 |
*
|
|
154 |
* @since Symbian^4
|
|
155 |
* @param Pointer to the Generic info notifier.
|
|
156 |
*/
|
|
157 |
inline CBTNotifGenInfoNotifier* GenericInfoNotifier() const
|
|
158 |
{ return iGenInfoNotifier; }
|
29
|
159 |
|
|
160 |
// from base class CPolicyServer
|
|
161 |
|
|
162 |
/**
|
|
163 |
* From CPolicyServer.
|
|
164 |
* Creates and returns a server-side session object.
|
|
165 |
*
|
|
166 |
* @since Symbian^4
|
|
167 |
* @param aVersion The version information supplied by the client.
|
|
168 |
* @param aMessage Represents the details of the client request that
|
|
169 |
* is requesting the creation of the session.
|
|
170 |
* @return A pointer to the newly created server-side session object.
|
|
171 |
*/
|
|
172 |
virtual CSession2* NewSessionL( const TVersion& aVersion, const RMessage2& aMessage ) const;
|
57
|
173 |
|
|
174 |
/**
|
|
175 |
* Returns a handle to the BT poser notifier.
|
|
176 |
* @since Symbian^4
|
|
177 |
* @return A pointer to the newly created server-side session object.
|
|
178 |
*/
|
|
179 |
inline CBTNotifPowerNotifier* BTPowerNotifier() const
|
|
180 |
{ return iBTPowerNotifier; }
|
|
181 |
|
29
|
182 |
private:
|
|
183 |
|
|
184 |
CBTNotifServer();
|
|
185 |
|
|
186 |
void ConstructL();
|
|
187 |
|
|
188 |
/**
|
|
189 |
* Asynchronous second-phase constructor. This function is called asynchronously
|
|
190 |
* from ConstructL, to facilitate short initial construction, and allow construction
|
|
191 |
* of e.g. session to BTEngine. So in fact this is a third-phase constructor.
|
|
192 |
*
|
|
193 |
* @since Symbian^4
|
|
194 |
*/
|
|
195 |
void AsyncConstructL();
|
|
196 |
|
|
197 |
void CheckIdle( TBTPowerStateValue aState );
|
|
198 |
|
|
199 |
/**
|
|
200 |
* Callback function for asynchronous construction.
|
|
201 |
*
|
|
202 |
* @since Symbian^4
|
|
203 |
* @param aPtr Pointer to server instance.
|
|
204 |
*/
|
|
205 |
static TInt AsyncConstructCb( TAny* aPtr );
|
|
206 |
|
|
207 |
static TInt ShutdownTimeout( TAny* aPtr );
|
|
208 |
|
|
209 |
private: // data
|
|
210 |
|
|
211 |
/**
|
|
212 |
* Counter for the number of active sessions.
|
|
213 |
*/
|
|
214 |
TInt iSessionCount;
|
|
215 |
|
|
216 |
/**
|
|
217 |
* Helper class for tracking settings.
|
|
218 |
* Own.
|
|
219 |
*/
|
|
220 |
CBTNotifSettingsTracker* iSettingsTracker;
|
|
221 |
|
|
222 |
/**
|
|
223 |
* Helper class for tracking connections.
|
|
224 |
* Own.
|
|
225 |
*/
|
|
226 |
CBTNotifConnectionTracker* iConnectionTracker;
|
|
227 |
|
|
228 |
/**
|
|
229 |
* Helper class for managing the actual notifications.
|
|
230 |
* Own.
|
|
231 |
*/
|
|
232 |
CBTNotificationManager* iNotificationMgr;
|
|
233 |
|
|
234 |
/**
|
|
235 |
* Remote device repository.
|
|
236 |
* Singleton in btnotifsrv. This is useful
|
|
237 |
* for getting the correct name for displaying in UI
|
|
238 |
* without the need getting the device everytime
|
|
239 |
* when a name is needed.
|
|
240 |
* Pairing handling also needs this repository to drive
|
|
241 |
* the logic flow.
|
|
242 |
*/
|
|
243 |
CBtDevRepository* iDevRep;
|
|
244 |
|
|
245 |
/**
|
|
246 |
* Helper class for device searching and selection.
|
|
247 |
* Own.
|
|
248 |
*/
|
|
249 |
CBTNotifDeviceSelector* iDevSelector;
|
57
|
250 |
|
|
251 |
/**
|
|
252 |
* Generic info notifier.
|
|
253 |
*/
|
|
254 |
CBTNotifGenInfoNotifier* iGenInfoNotifier;
|
29
|
255 |
|
|
256 |
/**
|
|
257 |
* Callback for asynchronous processing.
|
|
258 |
* Own.
|
|
259 |
*/
|
|
260 |
CAsyncCallBack* iAsyncCb;
|
|
261 |
|
|
262 |
/**
|
|
263 |
* Timer for various timeouts.
|
|
264 |
* Own.
|
|
265 |
*/
|
|
266 |
CDeltaTimer* iTimer;
|
|
267 |
|
31
|
268 |
/**
|
|
269 |
* The function entry of shutdown timeout.
|
|
270 |
*/
|
29
|
271 |
TDeltaTimerEntry iShutdownTimerEntry;
|
|
272 |
|
57
|
273 |
/**
|
|
274 |
* BT power notifier
|
|
275 |
*/
|
|
276 |
CBTNotifPowerNotifier* iBTPowerNotifier;
|
|
277 |
|
29
|
278 |
BTUNITTESTHOOK
|
|
279 |
|
|
280 |
};
|
|
281 |
|
|
282 |
#endif // BTNOTIFSERVER_H
|