1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/genericservices/activebackupclient/src/abachandler.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,347 @@
1.4 +// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// Implementation of CActiveBackupClient class.
1.18 +//
1.19 +//
1.20 +
1.21 +/**
1.22 + @file
1.23 +*/
1.24 +
1.25 +#include "abachandler.h"
1.26 +#include "abclientsession.h"
1.27 +#include "panic.h"
1.28 +
1.29 +namespace conn
1.30 + {
1.31 + CActiveBackupCallbackHandler* CActiveBackupCallbackHandler::NewL(MActiveBackupDataClient* aABDC,
1.32 + RABClientSession& aClientSession)
1.33 + /**
1.34 + Symbian first phase constructor
1.35 + @param aABDC pointer to the client's callback implementation
1.36 + @param aClientSession reference to the client's session
1.37 + @return Pointer to a created CActiveBackupCallbackHandler object
1.38 + */
1.39 + {
1.40 + CActiveBackupCallbackHandler* self = new (ELeave) CActiveBackupCallbackHandler(aABDC, aClientSession);
1.41 + CleanupStack::PushL(self);
1.42 + self->ConstructL();
1.43 + CleanupStack::Pop(self);
1.44 + return self;
1.45 + }
1.46 +
1.47 + CActiveBackupCallbackHandler::CActiveBackupCallbackHandler(MActiveBackupDataClient* aABDC,
1.48 + RABClientSession& aClientSession) : CActive(EPriorityNormal), iActiveBackupDataClient(aABDC),
1.49 + iClientSession(aClientSession), iTransferBuffer(NULL)
1.50 + /**
1.51 + C++ Constructor
1.52 + @param aABDC pointer to the client's callback implementation
1.53 + @param aClientSession reference to the client's session
1.54 + @panic KErrArgument if the pointer aABDC is NULL
1.55 + */
1.56 + {
1.57 + __ASSERT_DEBUG(aABDC, Panic(KErrArgument));
1.58 + }
1.59 +
1.60 + CActiveBackupCallbackHandler::~CActiveBackupCallbackHandler()
1.61 + /**
1.62 + C++ Destructor
1.63 + */
1.64 + {
1.65 + // Cancel any outstanding Async requests (i.e. close down the callback interface)
1.66 + Cancel();
1.67 + delete iTransferBuffer;
1.68 + iTransferBuffer = 0;
1.69 + }
1.70 +
1.71 + void CActiveBackupCallbackHandler::RunL()
1.72 + /**
1.73 + Handle messages "initiated" by the server. Because of IPC limitations, the client primes the
1.74 + server with a message containing modifiable package buffers that are filled with identifiers
1.75 + and arguments for the callback interface
1.76 + */
1.77 + {
1.78 + if (iStatus == KErrNone)
1.79 + {
1.80 + switch(iCallbackCommand())
1.81 + {
1.82 + case EABCallbackAllSnapshotsSupplied:
1.83 + {
1.84 + iActiveBackupDataClient->AllSnapshotsSuppliedL();
1.85 +
1.86 + PrimeServerForCallbackL();
1.87 + } break;
1.88 + case EABCallbackReceiveSnapshotData:
1.89 + {
1.90 + TDriveNumber driveNum = EDriveC; // Initialise to keep the compiler happy
1.91 +
1.92 + HBufC8* pReceivedData = iClientSession.GetDataFromServerLC(iCallbackArg1(),
1.93 + EABCallbackReceiveSnapshotData, driveNum);
1.94 +
1.95 + // Call the client method for handling receipt of the snapshot
1.96 + iActiveBackupDataClient->ReceiveSnapshotDataL(driveNum,
1.97 + *pReceivedData, static_cast<TBool>(iCallbackArg2()));
1.98 +
1.99 + // Reprime the server
1.100 + PrimeServerForCallbackL();
1.101 +
1.102 + CleanupStack::PopAndDestroy(pReceivedData);
1.103 + } break;
1.104 + case EABCallbackGetExpectedDataSize:
1.105 + {
1.106 + TUint dataSize = iActiveBackupDataClient->GetExpectedDataSize(static_cast<TDriveNumber>(iCallbackArg1()));
1.107 +
1.108 + // Reprime the server
1.109 + PrimeServerForCallbackWithResponseL(dataSize);
1.110 + } break;
1.111 + case EABCallbackGetSnapshotData:
1.112 + {
1.113 + // Create an empty TPtr8 to point at the buffer to fill
1.114 + TPtr8 bufferToSend(CreateFixedBufferL());
1.115 +
1.116 + TBool finished = ETrue;
1.117 +
1.118 + // Zero our descriptor so that it can be refilled
1.119 + bufferToSend.Zero();
1.120 +
1.121 + // Callback the AB client to populate our descriptor
1.122 + iActiveBackupDataClient->GetSnapshotDataL(static_cast<TDriveNumber>(iCallbackArg1()),
1.123 + bufferToSend, finished);
1.124 +
1.125 + // Send the length and some other info to the server to allow it to prepare for the actual transfer
1.126 + iClientSession.SendDataLengthToServerL(bufferToSend, finished, EABCallbackGetSnapshotData);
1.127 +
1.128 + iTransferBuffer->Des().SetLength(bufferToSend.Length());
1.129 +
1.130 + // Send the actual data back to the server and prime for the next callback
1.131 + PrimeServerForCallbackWithResponseL(*iTransferBuffer);
1.132 + } break;
1.133 + case EABCallbackInitialiseGetBackupData:
1.134 + {
1.135 + iActiveBackupDataClient->InitialiseGetBackupDataL(static_cast<TDriveNumber>(iCallbackArg1()));
1.136 +
1.137 + // Reprime the server
1.138 + PrimeServerForCallbackL();
1.139 + } break;
1.140 + case EABCallbackGetBackupDataSection:
1.141 + {
1.142 + // Create an empty TPtr8 to point at the buffer to fill
1.143 + TPtr8 bufferToSend(CreateFixedBufferL());
1.144 +
1.145 + TBool finished = ETrue;
1.146 +
1.147 + // Zero our descriptor so that it can be refilled
1.148 + bufferToSend.Zero();
1.149 +
1.150 + // Callback the AB client to populate our descriptor
1.151 + iActiveBackupDataClient->GetBackupDataSectionL(bufferToSend, finished);
1.152 +
1.153 + // Send the length and some other info to the server to allow it to prepare for the actual transfer
1.154 + iClientSession.SendDataLengthToServerL(bufferToSend, finished, EABCallbackGetBackupDataSection);
1.155 +
1.156 + iTransferBuffer->Des().SetLength(bufferToSend.Length());
1.157 +
1.158 + // Send the actual data back to the server and prime for the next callback
1.159 + PrimeServerForCallbackWithResponseL(*iTransferBuffer);
1.160 + } break;
1.161 + case EABCallbackInitialiseRestoreBaseDataSection:
1.162 + {
1.163 + iActiveBackupDataClient->InitialiseRestoreBaseDataL(static_cast<TDriveNumber>(iCallbackArg1()));
1.164 +
1.165 + // Reprime the server
1.166 + PrimeServerForCallbackL();
1.167 + } break;
1.168 + case EABCallbackRestoreBaseDataSection:
1.169 + {
1.170 + HBufC8* pReceivedData = iClientSession.GetDataFromServerLC(iCallbackArg1(),
1.171 + EABCallbackRestoreBaseDataSection);
1.172 +
1.173 + // Call the client method for handling receipt of the snapshot
1.174 + iActiveBackupDataClient->RestoreBaseDataSectionL(*pReceivedData,
1.175 + static_cast<TBool>(iCallbackArg2()));
1.176 +
1.177 + // Reprime the server
1.178 + PrimeServerForCallbackL();
1.179 +
1.180 + CleanupStack::PopAndDestroy(pReceivedData);
1.181 + } break;
1.182 + case EABCallbackInitialiseRestoreIncrementData:
1.183 + {
1.184 + iActiveBackupDataClient->InitialiseRestoreIncrementDataL(static_cast<TDriveNumber>(iCallbackArg1()));
1.185 +
1.186 + // Reprime the server
1.187 + PrimeServerForCallbackL();
1.188 + } break;
1.189 + case EABCallbackRestoreIncrementDataSection:
1.190 + {
1.191 + HBufC8* pReceivedData = iClientSession.GetDataFromServerLC(iCallbackArg1(),
1.192 + EABCallbackRestoreIncrementDataSection);
1.193 +
1.194 + // Call the client method for handling receipt of the snapshot
1.195 + iActiveBackupDataClient->RestoreIncrementDataSectionL(*pReceivedData,
1.196 + static_cast<TBool>(iCallbackArg2()));
1.197 +
1.198 + // Reprime the server
1.199 + PrimeServerForCallbackL();
1.200 +
1.201 + CleanupStack::PopAndDestroy(pReceivedData);
1.202 + } break;
1.203 + case EABCallbackRestoreComplete:
1.204 + {
1.205 + iActiveBackupDataClient->RestoreComplete(static_cast<TDriveNumber>(iCallbackArg1()));
1.206 +
1.207 + // Reprime the server
1.208 + PrimeServerForCallbackL();
1.209 + } break;
1.210 + case EABCallbackTerminateMultiStageOperation:
1.211 + {
1.212 + iActiveBackupDataClient->TerminateMultiStageOperation();
1.213 +
1.214 + // Reprime the server
1.215 + PrimeServerForCallbackL();
1.216 + } break;
1.217 + case EABCallbackGetDataChecksum:
1.218 + {
1.219 + iActiveBackupDataClient->GetDataChecksum(static_cast<TDriveNumber>(iCallbackArg1()));
1.220 +
1.221 + // Reprime the server
1.222 + PrimeServerForCallbackL();
1.223 + } break;
1.224 + case EABCallbackInitialiseGetProxyBackupData:
1.225 + {
1.226 + iActiveBackupDataClient->InitialiseGetProxyBackupDataL(static_cast<TSecureId>(iCallbackArg1()),
1.227 + static_cast<TDriveNumber>(iCallbackArg2()));
1.228 +
1.229 + // Reprime the server
1.230 + PrimeServerForCallbackL();
1.231 + } break;
1.232 + case EABCallbackInitialiseRestoreProxyBaseData:
1.233 + {
1.234 + iActiveBackupDataClient->InitialiseRestoreProxyBaseDataL(static_cast<TSecureId>(
1.235 + iCallbackArg1()), static_cast<TDriveNumber>(iCallbackArg2()));
1.236 +
1.237 + // Reprime the server
1.238 + PrimeServerForCallbackL();
1.239 + } break;
1.240 + default:
1.241 + {
1.242 + // Call the server to leave with KErrNotSupported
1.243 + User::Leave(KErrNotSupported);
1.244 + }
1.245 + }
1.246 +
1.247 + // Set us up for another call
1.248 + SetActive();
1.249 +
1.250 + }
1.251 + }
1.252 +
1.253 + void CActiveBackupCallbackHandler::PrimeServerForCallbackL()
1.254 + /**
1.255 + Reprime the server with a new IPC message to respond to
1.256 + */
1.257 + {
1.258 + iClientSession.PrimeServerForCallbackL(iCallbackCommand, iCallbackArg1, iCallbackArg2, iStatus);
1.259 + }
1.260 +
1.261 + void CActiveBackupCallbackHandler::PrimeServerForCallbackWithResponseL(TInt aResponse)
1.262 + /**
1.263 + Reprime the server with a new IPC message to respond to, sending the result of the previous callback
1.264 +
1.265 + @param aResponse The response to send back to the server i.e. the result of the last callback made
1.266 + */
1.267 + {
1.268 + iClientSession.PrimeServerForCallbackWithResponseL(iCallbackCommand, iCallbackArg1, iCallbackArg2, aResponse, iStatus);
1.269 + }
1.270 +
1.271 + void CActiveBackupCallbackHandler::PrimeServerForCallbackWithResponseL(TDesC8& aResponse)
1.272 + /**
1.273 + Reprime the server with a new IPC message to respond to, sending the result of the previous callback
1.274 +
1.275 + @param aResponse The response to send back to the server i.e. the result of the last callback made
1.276 + */
1.277 + {
1.278 + iClientSession.PrimeServerForCallbackWithResponseL(iCallbackCommand, iCallbackArg1, iCallbackArg2, aResponse, iStatus);
1.279 + }
1.280 +
1.281 + TInt CActiveBackupCallbackHandler::RunError(TInt aError)
1.282 + /**
1.283 + Handle any leaves that occur from within the RunL and hence from the callback methods. In order
1.284 + to propagate leaves over to the PC client, they must be sent to the backup engine to leave to the
1.285 + client
1.286 +
1.287 + @param aError The leave code that has been trapped from within the RunL. Propagate this code to the engine
1.288 + @return Any unhandled leave code
1.289 + */
1.290 + {
1.291 + iClientSession.PropagateLeave(aError);
1.292 +
1.293 + PrimeServerForCallbackL();
1.294 + SetActive();
1.295 +
1.296 + return KErrNone; // Is this correct or do we return the error code even though it's been handled?
1.297 + }
1.298 +
1.299 + void CActiveBackupCallbackHandler::DoCancel()
1.300 + /**
1.301 + Immediately cancel any outstanding calls to the backup engine
1.302 + */
1.303 + {
1.304 + // we can't do anything with the error code here
1.305 + TRAP_IGNORE(iClientSession.CancelServerCallbackL());
1.306 + }
1.307 +
1.308 + void CActiveBackupCallbackHandler::ConstructL()
1.309 + /**
1.310 + Add this object to the scheduler
1.311 +
1.312 + @panic KErrNotFound Debug only - If an ActiveScheduler is not installed
1.313 + @leave Release only - If an ActiveScheduler is not installed
1.314 + */
1.315 + {
1.316 + if (!CActiveScheduler::Current())
1.317 + {
1.318 + __ASSERT_DEBUG(0, Panic(KErrNotFound));
1.319 + }
1.320 +
1.321 + // Add this AO to the scheduler
1.322 + CActiveScheduler::Add(this);
1.323 + SetActive();
1.324 + }
1.325 +
1.326 + void CActiveBackupCallbackHandler::StartListeningForServerMessagesL()
1.327 + /**
1.328 + Send an asynchronous IPC message to the server in order that it has a vehicle for "initiating"
1.329 + a callback on iActiveBackupDataClient. This should only be called once as it will start the
1.330 + active scheduler
1.331 + */
1.332 + {
1.333 + // Prime the server with the first prime for callback IPC message
1.334 + PrimeServerForCallbackL();
1.335 + }
1.336 +
1.337 + TPtr8 CActiveBackupCallbackHandler::CreateFixedBufferL()
1.338 + /**
1.339 + Creates a buffer of the exact size.
1.340 + */
1.341 + {
1.342 + delete iTransferBuffer;
1.343 + iTransferBuffer = NULL;
1.344 +
1.345 + iTransferBuffer = HBufC8::NewL(iCallbackArg1());
1.346 +
1.347 + return TPtr8(const_cast<TUint8*>(iTransferBuffer->Ptr()), iCallbackArg1());
1.348 + }
1.349 + }
1.350 +