os/ossrv/genericservices/activebackupclient/inc/abclientserver.h
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/ossrv/genericservices/activebackupclient/inc/abclientserver.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,124 @@
     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 +* Contains defines shared between the Active Backup client and Server.
    1.19 +* 
    1.20 +*
    1.21 +*/
    1.22 +
    1.23 +
    1.24 +
    1.25 +/**
    1.26 + @file
    1.27 +*/
    1.28 +
    1.29 +#ifndef __ABCLIENTSERVER_H__
    1.30 +#define __ABCLIENTSERVER_H__
    1.31 +
    1.32 +#include <connect/tserverstart.h>
    1.33 +
    1.34 +namespace conn
    1.35 +	{
    1.36 +	/** The name of the AB server.
    1.37 +	@ingroup Client
    1.38 +	@internalComponent
    1.39 +	*/
    1.40 +	_LIT(KABServerName,"!ABServer");
    1.41 +
    1.42 +	/** Number of times to attempt connection to server.
    1.43 +	@ingroup Client
    1.44 +	@internalComponent
    1.45 +	*/
    1.46 +	const TInt KABRetryCount = 4;
    1.47 +
    1.48 +	/** Number of async message slots.
    1.49 +	@ingroup Client
    1.50 +	@internalComponent
    1.51 +	*/
    1.52 +	const TInt KABASyncMessageSlots = 1;
    1.53 +
    1.54 +
    1.55 +	/** The AB major version number.
    1.56 +	@ingroup Client
    1.57 +	@internalComponent
    1.58 +	*/
    1.59 +	const TUint KABMajorVersionNumber = 1;
    1.60 +
    1.61 +    /** The AB minor version number.
    1.62 +	@ingroup Client
    1.63 +	@internalComponent
    1.64 +	*/
    1.65 +	const TUint KABMinorVersionNumber = 0;
    1.66 +
    1.67 +    /** The AB build number
    1.68 +	@ingroup Client
    1.69 +	@internalComponent
    1.70 +	*/
    1.71 +	const TUint KABBuildVersionNumber = 0;
    1.72 +	
    1.73 +	/** Size of data blocks to send back to the PC from the ABClient
    1.74 +	@ingroup Client
    1.75 +	@internalComponent
    1.76 +	*/
    1.77 +	const TInt KABMaxSendDataBlock = 65536;
    1.78 +
    1.79 +	enum TABMessages
    1.80 +	/** AB Client/Server Messages
    1.81 +	@internalComponent
    1.82 +	*/
    1.83 +		{
    1.84 +		EABMsgBURModeInfo,					/*!< Get info about the backup/restore mode */
    1.85 +		EABMsgDoesPartialAffectMe,			/*!< Query whether or not this client is being operated on */
    1.86 +		EABMsgConfirmReadyForBUR,			/*!< Confirm to the SBEngine that all data has now been prepared */
    1.87 +		EABMsgPrimeForCallback,				/*!< This is the first msg that primes server for callbacks */
    1.88 +		EABMsgPrimeForCallbackAndResponse,	/*!< Re-prime the server, sending a response from the last call */
    1.89 +		EABMsgPrimeForCallbackAndResponseDes, /*!< As for PrimeForCallbackAndResponse but for sending a descriptor */
    1.90 +		EABMsgPropagateLeave,				/*!< Propagate a leave from the callback, back to the engine */
    1.91 +		EABMsgGetDataSync,					/*!< Synchronous call to get data from the server */
    1.92 +		EABMsgSendDataLength,				/*!< Synchronous call to send the length of data to the server */
    1.93 +		EABMsgClosingDownCallback,			/*!< Inform the server that we're closing down the callback interface */
    1.94 +		EABMsgGetDriveNumForSuppliedSnapshot /*!< Called from within the ReceiveSnapshot callback to return the drive num */
    1.95 +		};
    1.96 +
    1.97 +	enum TABCallbackCommands
    1.98 +	/**
    1.99 +	List of commands that the server requests the client to call on it's callback interface
   1.100 +	@internalComponent
   1.101 +	*/
   1.102 +		{
   1.103 +		EABCallbackAllSnapshotsSupplied,
   1.104 +		EABCallbackReceiveSnapshotData,
   1.105 +		EABCallbackGetExpectedDataSize,
   1.106 +		EABCallbackGetSnapshotData,
   1.107 +		EABCallbackInitialiseGetBackupData,
   1.108 +		EABCallbackGetBackupDataSection,
   1.109 +		EABCallbackInitialiseRestoreBaseDataSection,
   1.110 +		EABCallbackRestoreBaseDataSection,
   1.111 +		EABCallbackInitialiseRestoreIncrementData,
   1.112 +		EABCallbackRestoreIncrementDataSection,
   1.113 +		EABCallbackRestoreComplete,
   1.114 +		EABCallbackInitialiseGetProxyBackupData,
   1.115 +		EABCallbackInitialiseRestoreProxyBaseData,
   1.116 +		EABCallbackTerminateMultiStageOperation,
   1.117 +		EABCallbackGetDataChecksum
   1.118 +		};
   1.119 +		
   1.120 +	/** The maximum size of descriptor data passed with each IPC call 
   1.121 +	@internalComponent
   1.122 +	*/
   1.123 +	const TInt KIPCMessageSize = 4096;
   1.124 +
   1.125 +	}
   1.126 +
   1.127 +#endif //__ABCLIENTSERVER_H__