sl@0: /**
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: * Declaration of CActiveBackupCallbackHandler
sl@0: * 
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0:  @file
sl@0: */
sl@0: #ifndef __ACTIVEBACKUPCALLBACKHANDLER_H__
sl@0: #define __ACTIVEBACKUPCALLBACKHANDLER_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <connect/abclient.h>
sl@0: #include <connect/abclientserver.h>
sl@0: 
sl@0: namespace conn
sl@0: 	{ 
sl@0: 	class MActiveBackupDataClient;
sl@0: 	class RABClientSession;
sl@0: 	
sl@0: 	class CActiveBackupCallbackHandler : public CActive
sl@0: 		/**
sl@0: 		CActiveBackupCallbackHandler is used to handle the asynchronous calls back from the
sl@0: 		active backup server. IPC only allows client initiated message transfer and hence the 
sl@0: 		Active Backup Callback Handler must prime the server with an initial message and use 
sl@0: 		the async response to "send" a message to the client side.
sl@0: 		
sl@0: 		@internal component
sl@0: 		*/
sl@0: 		{
sl@0: 	public:
sl@0: 
sl@0: 		/** 
sl@0: 		Empty virtual destructor to avoid memory leaks
sl@0: 		*/
sl@0: 		virtual ~CActiveBackupCallbackHandler();
sl@0: 		
sl@0: 		static CActiveBackupCallbackHandler* NewL(MActiveBackupDataClient* aABDC, 
sl@0: 			RABClientSession& aClientSession);
sl@0: 		
sl@0: 		/**
sl@0: 		RunL will synchronously call the callback implementation passed in to this object
sl@0: 		*/
sl@0: 		void RunL();
sl@0: 		
sl@0: 		/**
sl@0: 		*/
sl@0: 		void DoCancel();
sl@0: 		
sl@0: 		/**
sl@0: 		RunError implementation should send the leave code to the ABServer for propagation back 
sl@0: 		to the SBEngine client. This enables any leaves from the callbacks to be returned to the 
sl@0: 		PC for display/handling by the user
sl@0: 		
sl@0: 		@return any unhandled error code
sl@0: 		*/
sl@0: 		TInt RunError(TInt aError);
sl@0: 		
sl@0: 		void ConstructL();
sl@0: 		
sl@0: 		void StartListeningForServerMessagesL();
sl@0: 	
sl@0: 	private:
sl@0: 		CActiveBackupCallbackHandler(MActiveBackupDataClient* aABDC, RABClientSession& aClientSession);
sl@0: 		void PrimeServerForCallbackL();
sl@0: 		void PrimeServerForCallbackWithResponseL(TInt aResponse);
sl@0: 		void PrimeServerForCallbackWithResponseL(TDesC8& aResponse);
sl@0: 		TPtr8 CreateFixedBufferL();
sl@0: 			
sl@0: 	private:
sl@0: 		/** Callback mixin implementation provided by the active backup client */
sl@0: 		MActiveBackupDataClient* iActiveBackupDataClient;
sl@0: 		
sl@0: 		/** The client session to call methods on */
sl@0: 		RABClientSession& iClientSession;
sl@0: 
sl@0: 		/** This modifiable package buf is set by the Server to define which callback should 
sl@0: 		be called on the client */
sl@0: 		TPckgBuf<TABCallbackCommands> iCallbackCommand;
sl@0: 		
sl@0: 		/** Modifiable package buf containing the first of a maximum of two arguments for the callback */
sl@0: 		TPckgBuf<TInt> iCallbackArg1;
sl@0: 
sl@0: 		/** Modifiable package buf containing the second of a maximum of two arguments for the callback */
sl@0: 		TPckgBuf<TInt> iCallbackArg2;
sl@0: 		
sl@0: 		/** Buffer for holding transferred data from server */
sl@0: 		HBufC8* iTransferBuffer;
sl@0: 		};
sl@0: 
sl@0: 	} // end namespace
sl@0: 
sl@0: #endif // __ACTIVEBACKUPCALLBACKHANDLER_H__
sl@0: