0
|
1 |
/*
|
|
2 |
* Copyright (c) 2005-2009 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:
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
|
|
20 |
/********************************************************************************
|
|
21 |
*
|
|
22 |
* System Includes
|
|
23 |
*
|
|
24 |
********************************************************************************/
|
|
25 |
#include <e32std.h>
|
|
26 |
#include <e32base.h>
|
|
27 |
|
|
28 |
/********************************************************************************
|
|
29 |
*
|
|
30 |
* Local Includes
|
|
31 |
*
|
|
32 |
********************************************************************************/
|
|
33 |
#include "assert.h"
|
|
34 |
#include "stat.h"
|
|
35 |
#include "stat_engine.h"
|
|
36 |
|
|
37 |
/********************************************************************************
|
|
38 |
*
|
|
39 |
* Macro functions
|
|
40 |
*
|
|
41 |
********************************************************************************/
|
|
42 |
|
|
43 |
/********************************************************************************
|
|
44 |
*
|
|
45 |
* Definitions
|
|
46 |
*
|
|
47 |
********************************************************************************/
|
|
48 |
const TUint KSyncMax = 5;
|
|
49 |
|
|
50 |
/********************************************************************************
|
|
51 |
*
|
|
52 |
* CStatEngine -- construction
|
|
53 |
*
|
|
54 |
********************************************************************************/
|
|
55 |
CStatEngine *CStatEngine::NewL( MNotifyStatController *aController, RFs *const aSession, MNotifyLogMessage *const aMsg )
|
|
56 |
{
|
|
57 |
CStatEngine *self = new (ELeave) CStatEngine();
|
|
58 |
CleanupStack::PushL( self );
|
|
59 |
self->ConstructL( aController, aSession, aMsg );
|
|
60 |
CleanupStack::Pop();
|
|
61 |
return self;
|
|
62 |
}
|
|
63 |
|
|
64 |
void CStatEngine::ConstructL( MNotifyStatController *aController, RFs *const aSession, MNotifyLogMessage *const aMsg )
|
|
65 |
{
|
|
66 |
// check params
|
|
67 |
asserte( aController != NULL );
|
|
68 |
|
|
69 |
// setup all params
|
|
70 |
iController = aController;
|
|
71 |
iEngineStatus = EIdle;
|
|
72 |
iRemoteHost = NULL;
|
|
73 |
iResyncCount = 0;
|
|
74 |
iFs = aSession;
|
|
75 |
iMsg = aMsg;
|
|
76 |
iCommandDecoder = CStatApiCommandDecoder::NewL( iFs, iMsg );
|
|
77 |
}
|
|
78 |
|
|
79 |
CStatEngine::CStatEngine() : iDataSupplier( NULL ), iMsg( NULL ), iFs( NULL ), iDeleteLastFile(EFalse)
|
|
80 |
{
|
|
81 |
}
|
|
82 |
|
|
83 |
CStatEngine::~CStatEngine()
|
|
84 |
{
|
|
85 |
// clean up all params
|
|
86 |
if( iRemoteHost != NULL ) {
|
|
87 |
delete iRemoteHost;
|
|
88 |
}
|
|
89 |
delete iCommandDecoder;
|
|
90 |
|
|
91 |
if(iDataSupplier)
|
|
92 |
{
|
|
93 |
iDataSupplier->Delete( );
|
|
94 |
iDataSupplier = NULL;
|
|
95 |
}
|
|
96 |
}
|
|
97 |
|
|
98 |
/********************************************************************************
|
|
99 |
*
|
|
100 |
* CStatEngine -- MStatEngine implementation
|
|
101 |
*
|
|
102 |
********************************************************************************/
|
|
103 |
void CStatEngine::StartEngine( MStatApiTransport *aStatTransport,
|
|
104 |
TStatConnectType aConnectType, TDesC *aRemoteHost )
|
|
105 |
{
|
|
106 |
TInt exception, ret = KErrNone;
|
|
107 |
iTransport = aStatTransport;
|
|
108 |
|
|
109 |
// save the remote host address string
|
|
110 |
iRemoteHost = new TPtrC( *aRemoteHost );
|
|
111 |
|
|
112 |
// create the message log
|
|
113 |
|
|
114 |
// start the initialisation procedure the ugly second line means that if an
|
|
115 |
// exception is thrown the ret will have the exception, otherwise it will have
|
|
116 |
// the return code. Exceptions are always -ve and return values are always +ve
|
|
117 |
// so the two number spaces don't overlap (as zero means success in both).
|
|
118 |
iMsg->Msg( _L("ENGINE: Calling InitialiseL, %d (%S)."), aConnectType, aRemoteHost );
|
|
119 |
SetState( EInitialising );
|
|
120 |
TRAP( exception, (ret = iTransport->InitialiseL()) );
|
|
121 |
ret = ((exception == KErrNone) ? ret : exception);
|
|
122 |
HandleStateChange( KOpInitialise, ret );
|
|
123 |
}
|
|
124 |
|
|
125 |
// the controller calls stop whenever he (yes the controller is male) wants the engine
|
|
126 |
// to arrange itself and the transport into a state where he can safetly shut it down. It
|
|
127 |
// can be called at any time -- i.e. when the engine is in any state.
|
|
128 |
void CStatEngine::StopEngine( void )
|
|
129 |
{
|
|
130 |
TInt exception, ret = KErrNone;
|
|
131 |
|
|
132 |
switch( iEngineStatus ) {
|
|
133 |
|
|
134 |
case EIdle:
|
|
135 |
;
|
|
136 |
break;
|
|
137 |
|
|
138 |
case EConnecting:
|
|
139 |
case EConnected:
|
|
140 |
case EReceivePending:
|
|
141 |
case ESendPending:
|
|
142 |
iMsg->Msg( _L("ENGINE: Calling Disconnect.") );
|
|
143 |
SetState( EDisconnecting );
|
|
144 |
TRAP( exception, (ret = iTransport->Disconnect()) );
|
|
145 |
ret = ((exception == KErrNone) ? ret : exception);
|
|
146 |
HandleStateChange( KOpDisconnect, ret );
|
|
147 |
break;
|
|
148 |
|
|
149 |
case EDisconnecting:
|
|
150 |
case EDisconnected:
|
|
151 |
case EReleasing:
|
|
152 |
// nothing I can really do -- there is already a disconnect call
|
|
153 |
// pending -- just return and wait for notification -- or force
|
|
154 |
// disconnect by just deleting the object
|
|
155 |
break;
|
|
156 |
|
|
157 |
case EInitialising:
|
|
158 |
case EInitialised:
|
|
159 |
;
|
|
160 |
break;
|
|
161 |
case ELast:
|
|
162 |
;
|
|
163 |
break;
|
|
164 |
}
|
|
165 |
}
|
|
166 |
|
|
167 |
/********************************************************************************
|
|
168 |
*
|
|
169 |
* CStatEngine - Higher level transport handling code. All errors and startup
|
|
170 |
* shutdown issues are handled by the MNotifyStatEngine implementation.
|
|
171 |
*
|
|
172 |
********************************************************************************/
|
|
173 |
void CStatEngine::OnConnect( void )
|
|
174 |
{
|
|
175 |
iMsg->Msg( _L("ENGINE: Waiting for next command.") );
|
|
176 |
SetState( EReceivePending );
|
|
177 |
TInt err = iTransport->RequestReceive();
|
|
178 |
asserte( err == KSTErrAsynchronous );
|
|
179 |
}
|
|
180 |
|
|
181 |
void CStatEngine::OnRecvCommand( TUint aCommand, MDataConsumer *const aDataConsumer )
|
|
182 |
{
|
|
183 |
TInt err = KErrNone;
|
|
184 |
TInt dataLength = 0;
|
|
185 |
|
|
186 |
if (aCommand == 'B')
|
|
187 |
iDeleteLastFile = EFalse;
|
|
188 |
else if (aCommand == 'S' || aCommand == 'X')
|
|
189 |
iDeleteLastFile = ETrue;
|
|
190 |
|
|
191 |
// Clean up the old data supplier.
|
|
192 |
// If we are getting a command then it is safe to assume
|
|
193 |
// that everyone has finished with the old data supplier as
|
|
194 |
// they are valid only for the context of the current
|
|
195 |
// command.
|
|
196 |
if(iDataSupplier)
|
|
197 |
{
|
|
198 |
iDataSupplier->Delete( );
|
|
199 |
iDataSupplier = NULL;
|
|
200 |
}
|
|
201 |
|
|
202 |
// if this is a resync command then we have already done all we need to do so
|
|
203 |
// just return and wait for the next command. If we reach the maximum of
|
|
204 |
// resync commands disconnect and reset.
|
|
205 |
if( aCommand == RESYNC_ID ) {
|
|
206 |
iResyncCount++;
|
|
207 |
if( iResyncCount > KSyncMax ) {
|
|
208 |
iMsg->Msg( _L("ENGINE: Resync limit reached, calling Disconnect().") );
|
|
209 |
SetState( EDisconnecting );
|
|
210 |
err = iTransport->Disconnect();
|
|
211 |
iMsg->Msg( _L("ENGINE: Synchronous response from Disconnect(%d)."), err );
|
|
212 |
HandleStateChange( KOpDisconnect, err );
|
|
213 |
}
|
|
214 |
SetState( ESendPending );
|
|
215 |
return;
|
|
216 |
}
|
|
217 |
iResyncCount = 0;
|
|
218 |
|
|
219 |
if(aCommand == REFRESH_ID)
|
|
220 |
{
|
|
221 |
SetState( EDisconnecting );
|
|
222 |
err = iTransport->Disconnect();
|
|
223 |
HandleStateChange( KOpDisconnect, err );
|
|
224 |
SetState( ESendPending );
|
|
225 |
|
|
226 |
return;
|
|
227 |
}
|
|
228 |
|
|
229 |
// otherwise execute the command
|
|
230 |
err = iCommandDecoder->ExecuteCommand( aCommand, aDataConsumer, &iDataSupplier );
|
|
231 |
|
|
232 |
if( err == KErrNone )
|
|
233 |
{
|
|
234 |
if(iDataSupplier)
|
|
235 |
{
|
|
236 |
err = iDataSupplier->GetTotalSize( dataLength );
|
|
237 |
}
|
|
238 |
}
|
|
239 |
|
|
240 |
// if there was an error then the result code is FAILED_ID
|
|
241 |
if( err != KErrNone )
|
|
242 |
{
|
|
243 |
aCommand = FAILED_ID;
|
|
244 |
}
|
|
245 |
|
|
246 |
// now send the response and return
|
|
247 |
iMsg->Msg( _L("ENGINE: Sending reply (%c, %d)."), (char)aCommand, dataLength );
|
|
248 |
SetState( ESendPending );
|
|
249 |
err = iTransport->RequestSend( aCommand, iDataSupplier );
|
|
250 |
asserte( err == KSTErrAsynchronous );
|
|
251 |
|
|
252 |
return;
|
|
253 |
}
|
|
254 |
|
|
255 |
/********************************************************************************
|
|
256 |
*
|
|
257 |
* CStatEngine -- MNotifyStatEngine implementation -- this is the lower level
|
|
258 |
* which maintains the startup / shutdown protocol with the transport to keep
|
|
259 |
* them happy and deal with the asynchronous behaviour.
|
|
260 |
*
|
|
261 |
********************************************************************************/
|
|
262 |
void CStatEngine::HandleStateChange( TStateOp aOperation, TInt aResult )
|
|
263 |
{
|
|
264 |
TPtrC opname[] = { _L("ENGINE: <null> - response (%d)."),
|
|
265 |
_L("ENGINE: InitialiseL - response (%d)."),
|
|
266 |
_L("ENGINE: ConnectL - response (%d)."),
|
|
267 |
_L("ENGINE: Disconnect - response (%d)."),
|
|
268 |
_L("ENGINE: Release - response (%d).") };
|
|
269 |
|
|
270 |
iMsg->Msg( opname[aOperation], aResult );
|
|
271 |
while( (aResult != KSTErrAsynchronous) ) {
|
|
272 |
if( aResult != KSTErrSuccess )
|
|
273 |
iController->HandleError( aResult, NULL );
|
|
274 |
HandleSingleStateChange( &aOperation, &aResult );
|
|
275 |
iMsg->Msg( opname[aOperation], aResult );
|
|
276 |
}
|
|
277 |
}
|
|
278 |
|
|
279 |
void CStatEngine::HandleSingleStateChange( TStateOp *aOperation, TInt *aResult )
|
|
280 |
{
|
|
281 |
TStateOp thisOperation = *aOperation;
|
|
282 |
TInt exception, ret = KErrNone, thisResult = *aResult;
|
|
283 |
|
|
284 |
// should never get in here with a result of async
|
|
285 |
asserte( *aResult != KSTErrAsynchronous );
|
|
286 |
|
|
287 |
// set the operation to none by default and asynchronous which will break out of the above loop
|
|
288 |
*aOperation = KOpNone;
|
|
289 |
*aResult = KSTErrAsynchronous;
|
|
290 |
|
|
291 |
// handle each operation
|
|
292 |
switch( thisOperation ) {
|
|
293 |
|
|
294 |
// if initialise failed then call release, otherwise call connect
|
|
295 |
case KOpInitialise:
|
|
296 |
if( thisResult == KSTErrSuccess ) {
|
|
297 |
SetState( EInitialised );
|
|
298 |
*aOperation = KOpConnect;
|
|
299 |
SetState( EConnecting );
|
|
300 |
TRAP( exception, (ret = iTransport->ConnectL(iRemoteHost)) );
|
|
301 |
*aResult = ((exception == KErrNone) ? ret : exception);
|
|
302 |
} else {
|
|
303 |
*aOperation = KOpRelease;
|
|
304 |
SetState( EReleasing );
|
|
305 |
*aResult = iTransport->Release();
|
|
306 |
}
|
|
307 |
break;
|
|
308 |
|
|
309 |
// if connect failed call disconnect, otherwise call the internal OnConnect function
|
|
310 |
case KOpConnect:
|
|
311 |
if( thisResult != KSTErrSuccess ) {
|
|
312 |
SetState( EDisconnecting );
|
|
313 |
*aOperation = KOpDisconnect;
|
|
314 |
*aResult = iTransport->Disconnect();
|
|
315 |
} else {
|
|
316 |
SetState( EConnected );
|
|
317 |
OnConnect();
|
|
318 |
}
|
|
319 |
break;
|
|
320 |
|
|
321 |
// call release after disconnect regardless of result
|
|
322 |
case KOpDisconnect:
|
|
323 |
*aOperation = KOpRelease;
|
|
324 |
SetState( EReleasing );
|
|
325 |
*aResult = iTransport->Release();
|
|
326 |
break;
|
|
327 |
|
|
328 |
// exit after release
|
|
329 |
case KOpRelease:
|
|
330 |
SetState( EIdle );
|
|
331 |
break;
|
|
332 |
|
|
333 |
case KOpNone:
|
|
334 |
;
|
|
335 |
break;
|
|
336 |
}
|
|
337 |
}
|
|
338 |
|
|
339 |
void CStatEngine::HandleInitialise( TInt aResult )
|
|
340 |
{
|
|
341 |
HandleStateChange( KOpInitialise, aResult );
|
|
342 |
}
|
|
343 |
|
|
344 |
void CStatEngine::HandleConnect( TInt aResult )
|
|
345 |
{
|
|
346 |
HandleStateChange( KOpConnect, aResult );
|
|
347 |
}
|
|
348 |
|
|
349 |
void CStatEngine::HandleDisconnect( TInt aResult )
|
|
350 |
{
|
|
351 |
HandleStateChange( KOpDisconnect, aResult );
|
|
352 |
}
|
|
353 |
|
|
354 |
void CStatEngine::HandleRelease( TInt aResult )
|
|
355 |
{
|
|
356 |
HandleStateChange( KOpRelease, aResult );
|
|
357 |
}
|
|
358 |
|
|
359 |
void CStatEngine::HandleSend( TInt aResult )
|
|
360 |
{
|
|
361 |
TInt err;
|
|
362 |
|
|
363 |
// we must either be sending an ack or a response
|
|
364 |
asserte( iEngineStatus == ESendPending );
|
|
365 |
|
|
366 |
if (iDeleteLastFile)
|
|
367 |
{
|
|
368 |
iCommandDecoder->DeleteLastFile();
|
|
369 |
iDeleteLastFile = EFalse;
|
|
370 |
}
|
|
371 |
// now that the reply has been sent wait for the next command
|
|
372 |
iMsg->Msg( _L("ENGINE: Reply sent (%d)."), aResult );
|
|
373 |
iMsg->Msg( _L("ENGINE: Waiting for next command.") );
|
|
374 |
asserte( iEngineStatus == ESendPending );
|
|
375 |
SetState( EReceivePending );
|
|
376 |
err = iTransport->RequestReceive();
|
|
377 |
asserte( err == KSTErrAsynchronous );
|
|
378 |
}
|
|
379 |
|
|
380 |
void CStatEngine::HandleReceive( TInt aResult, const TUint aCommand,
|
|
381 |
MDataConsumer *const aDataConsumer )
|
|
382 |
{
|
|
383 |
// log the receipt
|
|
384 |
TInt dataLength = 0;
|
|
385 |
|
|
386 |
if(aDataConsumer)
|
|
387 |
{
|
|
388 |
aDataConsumer->GetTotalSize( dataLength );
|
|
389 |
}
|
|
390 |
iMsg->Msg( _L("ENGINE: Command Received (%d, %c, %d)."), aResult, (char)(aCommand), dataLength );
|
|
391 |
|
|
392 |
// verify that the engine state is as expected
|
|
393 |
asserte( iEngineStatus == EReceivePending );
|
|
394 |
|
|
395 |
// process the command
|
|
396 |
iMsg->Msg( _L("ENGINE: Processing command (%c)."), (char)(aCommand) );
|
|
397 |
OnRecvCommand( aCommand, aDataConsumer );
|
|
398 |
}
|
|
399 |
|
|
400 |
void CStatEngine::HandleError( TInt aError, void* aErrorData )
|
|
401 |
{
|
|
402 |
// log the error
|
|
403 |
iMsg->Msg( _L("ENGINE: Error encountered (%d)."), aError );
|
|
404 |
|
|
405 |
// call the upper layers so that the UI can notify the user that an error has
|
|
406 |
// occured.
|
|
407 |
iController->HandleError( aError, aErrorData );
|
|
408 |
|
|
409 |
// on an error the engine takes the responsibility of closing itself down -- and
|
|
410 |
// then informing the controller than it can clean up the objects.
|
|
411 |
SetState( EDisconnecting );
|
|
412 |
TInt err = iTransport->Disconnect();
|
|
413 |
HandleStateChange( KOpDisconnect, err );
|
|
414 |
}
|
|
415 |
|
|
416 |
void CStatEngine::HandleInfo( const TDesC *aInfo )
|
|
417 |
{
|
|
418 |
iController->HandleInfo( aInfo );
|
|
419 |
}
|
|
420 |
|
|
421 |
void CStatEngine::SetState( TCommStatus aNewStatus )
|
|
422 |
{
|
|
423 |
// change the internal status and notify the controller of the change
|
|
424 |
iEngineStatus = aNewStatus;
|
|
425 |
asserte( iController != NULL );
|
|
426 |
iController->HandleStatusChange( iEngineStatus );
|
|
427 |
}
|
|
428 |
|