1 sbdefs.h

     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 * Declaration of Types and Constants for Secure Backup and Restore

    16 * 

    17 *

    18 */

    19 

    20 

    21 

    22 

    23 

    24 /**

    25  @file

    26 */

    27 #ifndef __SBDEFS_H__

    28 #define __SBDEFS_H__

    29 

    30 #include <e32std.h>

    31 #include <f32file.h>

    32 

    33 namespace conn

    34 	{

    35 	/** Secure Backup and Restore publish and subscribe key

    36 

    37 	Secure Backup and Restore uses a Publish and Subscribe key to publish

    38 	the current backup / restore state.

    39  

    40 	The key is a system key so the category to be used when subscribing is KUidSystemCategoryValue

    41 	The key to be used is KUidBackupRestoreKey.

    42 	The value is a bit-wise OR of a TBURPartType value and a TBackupIncType value

    43 	This means that a normal state (i.e. non-backup or restore) is EBURNormal | ENoBackup but

    44 	If the key has not been set (i.e. == 0) then no backup or restore is in progress either

    45 

    46 	@released

    47 	@publishedAll

    48 	*/

    49 	const TUint KUidBackupRestoreKey = 0x10202792 ;

    50 

    51 

    52 	/** TBURPartType Bitmask

    53 	@released

    54 	@publishedAll

    55 	*/

    56 	const TUint KBURPartTypeMask = 0xff;

    57 

    58 	enum TBURPartType

    59 		/** 

    60 		The backup / restore state of a device.

    61 

    62 		@released

    63 		@publishedAll

    64 		*/

    65 		{

    66 		EBURUnset          = 0x00000000, /*!< 0x00000000: The backup / restore mode has not been set */

    67 		EBURNormal         = 0x00000001, /*!< 0x00000001: The device as a whole is not engaged in a backup or restore */

    68 		EBURBackupFull     = 0x00000002, /*!< 0x00000002: The device as a whole is engaged in a backup of all components data */

    69 		EBURBackupPartial  = 0x00000004, /*!< 0x00000004: The device as a whole is engaged in a backup of selected components data */

    70 		EBURRestoreFull    = 0x00000008, /*!< 0x00000008: The device as a whole is engaged in a restore of all components data */

    71 		EBURRestorePartial = 0x00000010  /*!< 0x00000010: The device as a whole is engaged in a restore of all components data */

    72 		};

    73 

    74 	/** TBackupIncType Bitmask

    75 	@released

    76 	@publishedAll

    77 	*/

    78 	const TUint KBackupIncTypeMask = 0xffffff00;

    79 

    80 	enum TBackupIncType

    81 		/** 

    82 		The type of a backup.

    83 

    84 		@released

    85 		@publishedAll

    86 		*/

    87 		{

    88 		ENoBackup        = 0x00000000, /*!< 0x00000000: No backup is in progress */

    89 		EBackupBase      = 0x00000100, /*!< 0x00000100: The backup is a base backup, i.e. it includes all files / data */

    90 		EBackupIncrement = 0x00000200  /*!< 0x00000200: The backup is an incremental backup, i.e. it includes only files / data that have changed since a previous backup */

    91 		};

    92 

    93 	} // end namespace

    94 #endif