backupandrestore/backupengine/inc/sbeclientserver.h
changeset 0 d0791faffa3f
equal deleted inserted replaced
-1:000000000000 0:d0791faffa3f
       
     1 /**
       
     2 * Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 * Contains defines shared between the Secure Backup Engine client and Server.
       
    16 * 
       
    17 *
       
    18 */
       
    19 
       
    20 
       
    21 
       
    22 /**
       
    23  @file
       
    24 */
       
    25 
       
    26 #ifndef __SBECLIENTSERVER_H__
       
    27 #define __SBECLIENTSERVER_H__
       
    28 
       
    29 #include <connect/tserverstart.h>
       
    30 
       
    31 namespace conn
       
    32 	{
       
    33 	/** The name of the SBE server execuatable.
       
    34 	@ingroup Client
       
    35 	@internalComponent
       
    36 	*/
       
    37 	_LIT(KSBEServerName,"!SBEServer");
       
    38 
       
    39 	/** Number of times to attempt connection to server.
       
    40 	@ingroup Client
       
    41 	@internalComponent
       
    42 	*/
       
    43 	const TInt KSBERetryCount = 4;
       
    44 
       
    45 	/** Number of async message slots.
       
    46 	@ingroup Client
       
    47 	@internalComponent
       
    48 	*/
       
    49 	const TInt KSBEASyncMessageSlots = 3;
       
    50 
       
    51 
       
    52 	/** The SBE major version number.
       
    53 	@ingroup Client
       
    54 	@internalComponent
       
    55 	*/
       
    56 	const TUint KSBEMajorVersionNumber = 1;
       
    57 
       
    58     /** The SBE minor version number.
       
    59 	@ingroup Client
       
    60 	@internalComponent
       
    61 	*/
       
    62 	const TUint KSBEMinorVersionNumber = 0;
       
    63 
       
    64     /** The SBE build number
       
    65 	@ingroup Client
       
    66 	@internalComponent
       
    67 	*/
       
    68 	const TUint KSBEBuildVersionNumber = 0;
       
    69 
       
    70 	enum TSBEMessages
       
    71 	/** SBE Client/Server Messages
       
    72 	@internalComponent
       
    73 	*/
       
    74 		{
       
    75 		ESBEMsgGetGSHHandle,			/*!< Pass the the Global Anonymous Shared Heap handle to client */
       
    76 		ESBEMsgPrepDataOwnerInfo,		/*!< Prepare the data owner information for a specific SID */
       
    77 		ESBEMsgGetDataOwnerInfo,		/*!< Transfer the data owner information for a specific SID */
       
    78 		ESBEMsgPrepPublicFiles,			/*!< Prepare the data owner information for a specific SID */
       
    79 		ESBEMsgGetPublicFiles,			/*!< Transfer the data owner information for a specific SID */
       
    80 		ESBEMsgPrepPublicFilesRaw,		/*!< Prepare the data owner information for a specific SID */
       
    81 		ESBEMsgGetPublicFilesRaw,		/*!< Transfer the data owner information for a specific SID */
       
    82 		ESBEMsgPrepPublicFilesXML,		/*!< Prepare the data owner information for a specific SID */
       
    83 		ESBEMsgGetPublicFilesXML,		/*!< Transfer the data owner information for a specific SID */
       
    84 		ESBEMsgSetBURMode,				/*!< Set the Backup and Restore mode and associatedial BUR */
       
    85 		ESBEMsgPrepSIDStatus,			/*!< Get the returned descriptor length from a SIDS params */
       
    86 		ESBEMsgSetSIDListPartial,		/*!< Set the list of data owners affected in a parttatus array */
       
    87 		ESBEMsgGetSIDStatus,			/*!< Transfer the array of SID's and statuses */
       
    88 		ESBEMsgRequestDataSync,			/*!< Request that the SBE transfers some data to the client */
       
    89 		ESBEMsgSupplyDataSync,			/*!< Instruct the SBE that data has been supplied ine client */
       
    90 		ESBEMsgRequestDataAsync,		/*!< Request that the SBE transfers some data to th the GSH */
       
    91 		ESBEMsgSupplyDataAsync,			/*!< Instruct the SBE that data has been supplied in the GSH */
       
    92 		ESBEMsgAllSnapshotsSupplied,	/*!< Request that supplied SID's are subject to a Base backup */
       
    93 		ESBEMsgGetExpectedDataSize,		/*!< Ask the SBE for the expected size of backup data */
       
    94 		ESBEMsgAllSystemFilesRestored,	/*!< Instruct the SBE that all system files have now been restored */
       
    95 		ESBEMsgGetDataChecksum,			/*!< For testing - Request the checksum of a SID's backup data */
       
    96 		ESBEMsgPrepLargePublicFiles,	/*!< Instruct the SBE to build the public file list and place in GSH */
       
    97 		ESBEMsgGetLargePublicFiles		/*!< Retrieve parameters such as the finished flag from SBE */
       
    98 		};
       
    99 
       
   100 	}
       
   101 
       
   102 #endif //__SBECLIENTSERVER_H__