sl@0: // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Implementation of CActiveBackupClient class.
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file
sl@0: */
sl@0: 
sl@0: #include "abachandler.h"
sl@0: #include "abclientsession.h"
sl@0: #include "panic.h"
sl@0: 
sl@0: namespace conn
sl@0: 	{
sl@0: 	CActiveBackupCallbackHandler* CActiveBackupCallbackHandler::NewL(MActiveBackupDataClient* aABDC,
sl@0: 		RABClientSession& aClientSession)
sl@0: 	/**
sl@0: 	Symbian first phase constructor
sl@0: 	@param aABDC pointer to the client's callback implementation
sl@0: 	@param aClientSession reference to the client's session
sl@0: 	@return Pointer to a created CActiveBackupCallbackHandler object
sl@0: 	*/
sl@0: 		{
sl@0: 		CActiveBackupCallbackHandler* self = new (ELeave) CActiveBackupCallbackHandler(aABDC, aClientSession);
sl@0: 		CleanupStack::PushL(self);
sl@0: 		self->ConstructL();
sl@0: 		CleanupStack::Pop(self);
sl@0: 		return self;
sl@0: 		}
sl@0: 	
sl@0: 	CActiveBackupCallbackHandler::CActiveBackupCallbackHandler(MActiveBackupDataClient* aABDC,
sl@0: 		RABClientSession& aClientSession) : CActive(EPriorityNormal), iActiveBackupDataClient(aABDC), 
sl@0: 		iClientSession(aClientSession), iTransferBuffer(NULL)
sl@0: 	/**
sl@0: 	C++ Constructor
sl@0: 	@param aABDC pointer to the client's callback implementation
sl@0: 	@param aClientSession reference to the client's session
sl@0: 	@panic KErrArgument if the pointer aABDC is NULL
sl@0: 	*/
sl@0: 		{
sl@0: 		__ASSERT_DEBUG(aABDC, Panic(KErrArgument));
sl@0: 		}
sl@0: 
sl@0: 	CActiveBackupCallbackHandler::~CActiveBackupCallbackHandler()
sl@0: 	/**
sl@0: 	C++ Destructor
sl@0: 	*/
sl@0: 		{
sl@0: 		// Cancel any outstanding Async requests (i.e. close down the callback interface)
sl@0: 		Cancel();
sl@0: 		delete iTransferBuffer;
sl@0: 		iTransferBuffer = 0;
sl@0: 		}
sl@0: 		
sl@0: 	void CActiveBackupCallbackHandler::RunL()
sl@0: 	/**
sl@0: 	Handle messages "initiated" by the server. Because of IPC limitations, the client primes the 
sl@0: 	server with a message containing modifiable package buffers that are filled with identifiers 
sl@0: 	and arguments for the callback interface
sl@0: 	*/
sl@0: 		{
sl@0: 		if (iStatus == KErrNone)
sl@0: 			{
sl@0: 			switch(iCallbackCommand())
sl@0: 				{
sl@0: 				case EABCallbackAllSnapshotsSupplied:
sl@0: 					{
sl@0:   					iActiveBackupDataClient->AllSnapshotsSuppliedL();
sl@0: 				
sl@0: 					PrimeServerForCallbackL();
sl@0: 					} break;
sl@0: 				case EABCallbackReceiveSnapshotData:
sl@0: 					{
sl@0: 					TDriveNumber driveNum = EDriveC;		// Initialise to keep the compiler happy
sl@0: 
sl@0: 					HBufC8* pReceivedData = iClientSession.GetDataFromServerLC(iCallbackArg1(),
sl@0: 						EABCallbackReceiveSnapshotData, driveNum);
sl@0: 						
sl@0: 					// Call the client method for handling receipt of the snapshot
sl@0: 					iActiveBackupDataClient->ReceiveSnapshotDataL(driveNum, 
sl@0: 						*pReceivedData, static_cast<TBool>(iCallbackArg2()));
sl@0: 						
sl@0: 					// Reprime the server
sl@0: 					PrimeServerForCallbackL();
sl@0: 					
sl@0: 					CleanupStack::PopAndDestroy(pReceivedData);
sl@0: 					} break;
sl@0: 				case EABCallbackGetExpectedDataSize:
sl@0: 					{
sl@0: 					TUint dataSize = iActiveBackupDataClient->GetExpectedDataSize(static_cast<TDriveNumber>(iCallbackArg1()));
sl@0: 					
sl@0: 					// Reprime the server
sl@0: 					PrimeServerForCallbackWithResponseL(dataSize);
sl@0: 					} break;
sl@0: 				case EABCallbackGetSnapshotData:
sl@0: 					{
sl@0: 					// Create an empty TPtr8 to point at the buffer to fill
sl@0: 					TPtr8 bufferToSend(CreateFixedBufferL());
sl@0: 					
sl@0: 					TBool finished = ETrue;
sl@0: 					
sl@0: 					// Zero our descriptor so that it can be refilled
sl@0: 					bufferToSend.Zero();
sl@0: 					
sl@0: 					// Callback the AB client to populate our descriptor
sl@0: 					iActiveBackupDataClient->GetSnapshotDataL(static_cast<TDriveNumber>(iCallbackArg1()), 
sl@0: 						bufferToSend, finished);
sl@0: 					
sl@0: 					// Send the length and some other info to the server to allow it to prepare for the actual transfer
sl@0: 					iClientSession.SendDataLengthToServerL(bufferToSend, finished, EABCallbackGetSnapshotData);
sl@0: 					
sl@0: 					iTransferBuffer->Des().SetLength(bufferToSend.Length());
sl@0: 					
sl@0: 					// Send the actual data back to the server and prime for the next callback
sl@0: 					PrimeServerForCallbackWithResponseL(*iTransferBuffer);
sl@0: 					} break;
sl@0: 				case EABCallbackInitialiseGetBackupData:
sl@0: 					{
sl@0: 					iActiveBackupDataClient->InitialiseGetBackupDataL(static_cast<TDriveNumber>(iCallbackArg1()));
sl@0: 
sl@0: 					// Reprime the server
sl@0: 					PrimeServerForCallbackL();
sl@0: 					} break;
sl@0: 				case EABCallbackGetBackupDataSection:
sl@0: 					{
sl@0: 					// Create an empty TPtr8 to point at the buffer to fill
sl@0: 					TPtr8 bufferToSend(CreateFixedBufferL());
sl@0: 					
sl@0: 					TBool finished = ETrue;
sl@0: 
sl@0: 					// Zero our descriptor so that it can be refilled
sl@0: 					bufferToSend.Zero();
sl@0: 					
sl@0: 					// Callback the AB client to populate our descriptor
sl@0: 					iActiveBackupDataClient->GetBackupDataSectionL(bufferToSend, finished);
sl@0: 					
sl@0: 					// Send the length and some other info to the server to allow it to prepare for the actual transfer
sl@0: 					iClientSession.SendDataLengthToServerL(bufferToSend, finished, EABCallbackGetBackupDataSection);
sl@0: 					
sl@0: 					iTransferBuffer->Des().SetLength(bufferToSend.Length());
sl@0: 					
sl@0: 					// Send the actual data back to the server and prime for the next callback
sl@0: 					PrimeServerForCallbackWithResponseL(*iTransferBuffer);
sl@0: 					} break;
sl@0: 				case EABCallbackInitialiseRestoreBaseDataSection:
sl@0: 					{
sl@0: 					iActiveBackupDataClient->InitialiseRestoreBaseDataL(static_cast<TDriveNumber>(iCallbackArg1()));
sl@0: 
sl@0: 					// Reprime the server
sl@0: 					PrimeServerForCallbackL();
sl@0: 					} break;
sl@0: 				case EABCallbackRestoreBaseDataSection:
sl@0: 					{
sl@0: 					HBufC8* pReceivedData = iClientSession.GetDataFromServerLC(iCallbackArg1(),
sl@0: 						EABCallbackRestoreBaseDataSection);
sl@0: 					
sl@0: 					// Call the client method for handling receipt of the snapshot
sl@0: 					iActiveBackupDataClient->RestoreBaseDataSectionL(*pReceivedData, 
sl@0: 						static_cast<TBool>(iCallbackArg2()));
sl@0: 						
sl@0: 					// Reprime the server
sl@0: 					PrimeServerForCallbackL();
sl@0: 					
sl@0: 					CleanupStack::PopAndDestroy(pReceivedData);
sl@0: 					} break;
sl@0: 				case EABCallbackInitialiseRestoreIncrementData:
sl@0: 					{
sl@0: 					iActiveBackupDataClient->InitialiseRestoreIncrementDataL(static_cast<TDriveNumber>(iCallbackArg1()));
sl@0: 
sl@0: 					// Reprime the server
sl@0: 					PrimeServerForCallbackL();
sl@0: 					} break;
sl@0: 				case EABCallbackRestoreIncrementDataSection:
sl@0: 					{
sl@0: 					HBufC8* pReceivedData = iClientSession.GetDataFromServerLC(iCallbackArg1(),
sl@0: 						EABCallbackRestoreIncrementDataSection);
sl@0: 					
sl@0: 					// Call the client method for handling receipt of the snapshot
sl@0: 					iActiveBackupDataClient->RestoreIncrementDataSectionL(*pReceivedData, 
sl@0: 						static_cast<TBool>(iCallbackArg2()));
sl@0: 						
sl@0: 					// Reprime the server
sl@0: 					PrimeServerForCallbackL();
sl@0: 					
sl@0: 					CleanupStack::PopAndDestroy(pReceivedData);
sl@0: 					} break;
sl@0: 				case EABCallbackRestoreComplete:
sl@0: 					{
sl@0: 					iActiveBackupDataClient->RestoreComplete(static_cast<TDriveNumber>(iCallbackArg1()));
sl@0: 
sl@0: 					// Reprime the server
sl@0: 					PrimeServerForCallbackL();
sl@0: 					} break;
sl@0: 				case EABCallbackTerminateMultiStageOperation:
sl@0: 					{
sl@0: 					iActiveBackupDataClient->TerminateMultiStageOperation();
sl@0: 
sl@0: 					// Reprime the server
sl@0: 					PrimeServerForCallbackL();
sl@0: 					} break;
sl@0: 				case EABCallbackGetDataChecksum:
sl@0: 					{
sl@0: 					iActiveBackupDataClient->GetDataChecksum(static_cast<TDriveNumber>(iCallbackArg1()));
sl@0: 
sl@0: 					// Reprime the server
sl@0: 					PrimeServerForCallbackL();
sl@0: 					} break;
sl@0: 				case EABCallbackInitialiseGetProxyBackupData:
sl@0: 					{
sl@0: 					iActiveBackupDataClient->InitialiseGetProxyBackupDataL(static_cast<TSecureId>(iCallbackArg1()),
sl@0: 						static_cast<TDriveNumber>(iCallbackArg2()));
sl@0: 					
sl@0: 					// Reprime the server
sl@0: 					PrimeServerForCallbackL();
sl@0: 					} break;
sl@0: 				case EABCallbackInitialiseRestoreProxyBaseData:
sl@0: 					{
sl@0: 					iActiveBackupDataClient->InitialiseRestoreProxyBaseDataL(static_cast<TSecureId>(
sl@0: 						iCallbackArg1()), static_cast<TDriveNumber>(iCallbackArg2()));
sl@0: 
sl@0: 					// Reprime the server				
sl@0: 					PrimeServerForCallbackL();
sl@0: 					} break;
sl@0: 				default:
sl@0: 					{
sl@0: 					// Call the server to leave with KErrNotSupported
sl@0: 					User::Leave(KErrNotSupported);
sl@0: 					}
sl@0: 				}
sl@0: 				
sl@0: 			// Set us up for another call
sl@0: 			SetActive();
sl@0: 
sl@0: 			}
sl@0: 		}
sl@0: 		
sl@0: 	void CActiveBackupCallbackHandler::PrimeServerForCallbackL()
sl@0: 	/**
sl@0: 	Reprime the server with a new IPC message to respond to
sl@0: 	*/
sl@0: 		{
sl@0: 		iClientSession.PrimeServerForCallbackL(iCallbackCommand, iCallbackArg1, iCallbackArg2, iStatus);
sl@0: 		}
sl@0: 		
sl@0: 	void CActiveBackupCallbackHandler::PrimeServerForCallbackWithResponseL(TInt aResponse)
sl@0: 	/**
sl@0: 	Reprime the server with a new IPC message to respond to, sending the result of the previous callback
sl@0: 	
sl@0: 	@param aResponse The response to send back to the server i.e. the result of the last callback made
sl@0: 	*/
sl@0: 		{
sl@0: 		iClientSession.PrimeServerForCallbackWithResponseL(iCallbackCommand, iCallbackArg1, iCallbackArg2, aResponse, iStatus);
sl@0: 		}
sl@0: 
sl@0: 	void CActiveBackupCallbackHandler::PrimeServerForCallbackWithResponseL(TDesC8& aResponse)
sl@0: 	/**
sl@0: 	Reprime the server with a new IPC message to respond to, sending the result of the previous callback
sl@0: 	
sl@0: 	@param aResponse The response to send back to the server i.e. the result of the last callback made
sl@0: 	*/
sl@0: 		{
sl@0: 		iClientSession.PrimeServerForCallbackWithResponseL(iCallbackCommand, iCallbackArg1, iCallbackArg2, aResponse, iStatus);
sl@0: 		}
sl@0: 	
sl@0: 	TInt CActiveBackupCallbackHandler::RunError(TInt aError)
sl@0: 	/**
sl@0: 	Handle any leaves that occur from within the RunL and hence from the callback methods. In order 
sl@0: 	to propagate leaves over to the PC client, they must be sent to the backup engine to leave to the 
sl@0: 	client
sl@0: 	
sl@0: 	@param aError The leave code that has been trapped from within the RunL. Propagate this code to the engine
sl@0: 	@return Any unhandled leave code
sl@0: 	*/
sl@0: 		{
sl@0: 		iClientSession.PropagateLeave(aError);
sl@0: 		
sl@0: 		PrimeServerForCallbackL();
sl@0: 		SetActive();
sl@0: 		
sl@0: 		return KErrNone;	// Is this correct or do we return the error code even though it's been handled?
sl@0: 		}
sl@0: 		
sl@0: 	void CActiveBackupCallbackHandler::DoCancel()
sl@0: 	/**
sl@0: 	Immediately cancel any outstanding calls to the backup engine
sl@0: 	*/
sl@0: 		{
sl@0: 		// we can't do anything with the error code here
sl@0: 		TRAP_IGNORE(iClientSession.CancelServerCallbackL());
sl@0: 		}
sl@0: 		
sl@0: 	void CActiveBackupCallbackHandler::ConstructL()
sl@0: 	/**
sl@0: 	Add this object to the scheduler
sl@0: 	
sl@0: 	@panic KErrNotFound Debug only - If an ActiveScheduler is not installed
sl@0: 	@leave Release only - If an ActiveScheduler is not installed
sl@0: 	*/
sl@0: 		{
sl@0: 		if (!CActiveScheduler::Current())
sl@0: 			{
sl@0: 			__ASSERT_DEBUG(0, Panic(KErrNotFound));
sl@0: 			}
sl@0: 		
sl@0: 		// Add this AO to the scheduler
sl@0: 		CActiveScheduler::Add(this);
sl@0: 		SetActive();
sl@0: 		}
sl@0: 		
sl@0: 	void CActiveBackupCallbackHandler::StartListeningForServerMessagesL()
sl@0: 	/**
sl@0: 	Send an asynchronous IPC message to the server in order that it has a vehicle for "initiating" 
sl@0: 	a callback on iActiveBackupDataClient. This should only be called once as it will start the 
sl@0: 	active scheduler
sl@0: 	*/
sl@0: 		{
sl@0: 		// Prime the server with the first prime for callback IPC message
sl@0: 		PrimeServerForCallbackL();
sl@0: 		}
sl@0: 
sl@0: 	TPtr8 CActiveBackupCallbackHandler::CreateFixedBufferL()
sl@0: 	/**
sl@0: 	Creates a buffer of the exact size.
sl@0: 	*/
sl@0: 		{
sl@0: 		delete iTransferBuffer;
sl@0: 		iTransferBuffer = NULL;
sl@0: 					
sl@0: 		iTransferBuffer = HBufC8::NewL(iCallbackArg1());
sl@0: 		
sl@0: 		return TPtr8(const_cast<TUint8*>(iTransferBuffer->Ptr()), iCallbackArg1());
sl@0: 		}
sl@0: 	}
sl@0: