1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/ossrv/genericservices/activebackupclient/inc/abachandler.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,110 @@
     1.4 +/**
     1.5 +* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:
    1.18 +* Declaration of CActiveBackupCallbackHandler
    1.19 +* 
    1.20 +*
    1.21 +*/
    1.22 +
    1.23 +
    1.24 +
    1.25 +/**
    1.26 + @file
    1.27 +*/
    1.28 +#ifndef __ACTIVEBACKUPCALLBACKHANDLER_H__
    1.29 +#define __ACTIVEBACKUPCALLBACKHANDLER_H__
    1.30 +
    1.31 +#include <e32base.h>
    1.32 +#include <connect/abclient.h>
    1.33 +#include <connect/abclientserver.h>
    1.34 +
    1.35 +namespace conn
    1.36 +	{ 
    1.37 +	class MActiveBackupDataClient;
    1.38 +	class RABClientSession;
    1.39 +	
    1.40 +	class CActiveBackupCallbackHandler : public CActive
    1.41 +		/**
    1.42 +		CActiveBackupCallbackHandler is used to handle the asynchronous calls back from the
    1.43 +		active backup server. IPC only allows client initiated message transfer and hence the 
    1.44 +		Active Backup Callback Handler must prime the server with an initial message and use 
    1.45 +		the async response to "send" a message to the client side.
    1.46 +		
    1.47 +		@internal component
    1.48 +		*/
    1.49 +		{
    1.50 +	public:
    1.51 +
    1.52 +		/** 
    1.53 +		Empty virtual destructor to avoid memory leaks
    1.54 +		*/
    1.55 +		virtual ~CActiveBackupCallbackHandler();
    1.56 +		
    1.57 +		static CActiveBackupCallbackHandler* NewL(MActiveBackupDataClient* aABDC, 
    1.58 +			RABClientSession& aClientSession);
    1.59 +		
    1.60 +		/**
    1.61 +		RunL will synchronously call the callback implementation passed in to this object
    1.62 +		*/
    1.63 +		void RunL();
    1.64 +		
    1.65 +		/**
    1.66 +		*/
    1.67 +		void DoCancel();
    1.68 +		
    1.69 +		/**
    1.70 +		RunError implementation should send the leave code to the ABServer for propagation back 
    1.71 +		to the SBEngine client. This enables any leaves from the callbacks to be returned to the 
    1.72 +		PC for display/handling by the user
    1.73 +		
    1.74 +		@return any unhandled error code
    1.75 +		*/
    1.76 +		TInt RunError(TInt aError);
    1.77 +		
    1.78 +		void ConstructL();
    1.79 +		
    1.80 +		void StartListeningForServerMessagesL();
    1.81 +	
    1.82 +	private:
    1.83 +		CActiveBackupCallbackHandler(MActiveBackupDataClient* aABDC, RABClientSession& aClientSession);
    1.84 +		void PrimeServerForCallbackL();
    1.85 +		void PrimeServerForCallbackWithResponseL(TInt aResponse);
    1.86 +		void PrimeServerForCallbackWithResponseL(TDesC8& aResponse);
    1.87 +		TPtr8 CreateFixedBufferL();
    1.88 +			
    1.89 +	private:
    1.90 +		/** Callback mixin implementation provided by the active backup client */
    1.91 +		MActiveBackupDataClient* iActiveBackupDataClient;
    1.92 +		
    1.93 +		/** The client session to call methods on */
    1.94 +		RABClientSession& iClientSession;
    1.95 +
    1.96 +		/** This modifiable package buf is set by the Server to define which callback should 
    1.97 +		be called on the client */
    1.98 +		TPckgBuf<TABCallbackCommands> iCallbackCommand;
    1.99 +		
   1.100 +		/** Modifiable package buf containing the first of a maximum of two arguments for the callback */
   1.101 +		TPckgBuf<TInt> iCallbackArg1;
   1.102 +
   1.103 +		/** Modifiable package buf containing the second of a maximum of two arguments for the callback */
   1.104 +		TPckgBuf<TInt> iCallbackArg2;
   1.105 +		
   1.106 +		/** Buffer for holding transferred data from server */
   1.107 +		HBufC8* iTransferBuffer;
   1.108 +		};
   1.109 +
   1.110 +	} // end namespace
   1.111 +
   1.112 +#endif // __ACTIVEBACKUPCALLBACKHANDLER_H__
   1.113 +