epoc32/include/babackup.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#if !defined(__BABACKUP_H__) 
williamr@2
    17
#define __BABACKUP_H__
williamr@2
    18
williamr@2
    19
#include <e32std.h>
williamr@2
    20
#include <e32base.h>
williamr@2
    21
williamr@2
    22
/** 
williamr@2
    23
Backup server wrapper observer interface.
williamr@2
    24
williamr@2
    25
MBackupObserver defines the interface to be implemented by any code that will
williamr@2
    26
hold file locks or may attempt to access files regardless of other device state
williamr@2
    27
e.g. a phone app may always attempt to access the contacts database for caller id
williamr@2
    28
williamr@2
    29
@publishedAll
williamr@2
    30
@released
williamr@2
    31
*/
williamr@2
    32
class MBackupObserver
williamr@2
    33
	{
williamr@2
    34
public:
williamr@2
    35
/** Flags indicating how to change a file lock. */
williamr@2
    36
	enum TFileLockFlags
williamr@2
    37
		{
williamr@2
    38
	/** Owner can reopen/resume writing to the file. */
williamr@2
    39
		ETakeLock				=0,
williamr@2
    40
	/** Owner should stop writing to the file. */
williamr@2
    41
		EReleaseLockReadOnly	=0x01,
williamr@2
    42
	/** Owner should close the file. */
williamr@2
    43
		EReleaseLockNoAccess	=0x02,
williamr@2
    44
		};
williamr@2
    45
public:
williamr@2
    46
	/** Called by the server to request the file owner to change the lock on the specified 
williamr@2
    47
	file.
williamr@2
    48
	
williamr@2
    49
	@param aFileName Filename of affected file
williamr@2
    50
	@param aFlags Flag indicating how to change the file lock */
williamr@2
    51
	virtual void ChangeFileLockL(const TDesC& aFileName,TFileLockFlags aFlags)=0;
williamr@2
    52
	};
williamr@2
    53
williamr@2
    54
class TBackupOperationAttributes;
williamr@2
    55
williamr@2
    56
/** Backup operation observer interface.
williamr@2
    57
williamr@2
    58
Programs should implement this interface to receive notifications when a backup 
williamr@2
    59
or restore operation either starts or ends.
williamr@2
    60
williamr@2
    61
@see CBaBackupSessionWrapper::RegisterBackupOperationObserverL() 
williamr@2
    62
@publishedAll
williamr@2
    63
@released
williamr@2
    64
*/
williamr@2
    65
class MBackupOperationObserver
williamr@2
    66
	{
williamr@2
    67
public:
williamr@2
    68
/** Backup operation event types. */
williamr@2
    69
	enum TOperationType
williamr@2
    70
		{
williamr@2
    71
	/** None. */
williamr@2
    72
		ENone		=0x00,
williamr@2
    73
	/** Operation start. */
williamr@2
    74
		EStart		=0x01,
williamr@2
    75
	/** Operation end. */
williamr@2
    76
		EEnd		=0x02,
williamr@2
    77
	/** Operation aborted. */
williamr@2
    78
		EAbort		=0x04,
williamr@2
    79
		};
williamr@2
    80
public:
williamr@2
    81
	/** Called when a backup or restore operation either starts or ends.
williamr@2
    82
	
williamr@2
    83
	@param aBackupOperationAttributes Operation attributes */
williamr@2
    84
	virtual void HandleBackupOperationEventL(const TBackupOperationAttributes& aBackupOperationAttributes)=0;
williamr@2
    85
private:
williamr@2
    86
	IMPORT_C virtual void Reserved1();
williamr@2
    87
	};
williamr@2
    88
williamr@2
    89
williamr@2
    90
/** 
williamr@2
    91
Attributes for a backup operation.
williamr@2
    92
williamr@2
    93
@see MBackupOperationObserver 
williamr@2
    94
@publishedAll
williamr@2
    95
@released
williamr@2
    96
*/
williamr@2
    97
class TBackupOperationAttributes
williamr@2
    98
	{
williamr@2
    99
public:
williamr@2
   100
	inline TBackupOperationAttributes();
williamr@2
   101
	inline TBackupOperationAttributes(MBackupObserver::TFileLockFlags aFileFlag, MBackupOperationObserver::TOperationType aOperation);
williamr@2
   102
public:
williamr@2
   103
	/** File locking flags requested by the operation. */
williamr@2
   104
	MBackupObserver::TFileLockFlags iFileFlag;
williamr@2
   105
	/** Operation type. */
williamr@2
   106
	MBackupOperationObserver::TOperationType iOperation;
williamr@2
   107
	};
williamr@2
   108
williamr@2
   109
williamr@2
   110
class RBaBackupSession;
williamr@2
   111
class CBaLockChangeNotifier;
williamr@2
   112
class CBaBackupOperationNotifier;
williamr@2
   113
williamr@2
   114
/**
williamr@2
   115
CBaBackupSessionWrapper provides the APIs necessary to enable a backup or restore/install
williamr@2
   116
by allowing broadcast requests for some or all files to either remain untouched or have
williamr@2
   117
their locks released for an arbitrary period.
williamr@2
   118
williamr@2
   119
The class should be used by both code driving a backup/install and any engines that will
williamr@2
   120
hold files locks or may access files regardless of the presence of (non-system) client apps
williamr@2
   121
williamr@2
   122
@publishedAll
williamr@2
   123
@released
williamr@2
   124
*/
williamr@2
   125
class CBaBackupSessionWrapper : public CBase
williamr@2
   126
	{
williamr@2
   127
public:
williamr@2
   128
	IMPORT_C static CBaBackupSessionWrapper* NewL();
williamr@2
   129
	IMPORT_C ~CBaBackupSessionWrapper();
williamr@2
   130
	IMPORT_C void RegisterFileL(const TDesC& aFileName,MBackupObserver& aObserver);
williamr@2
   131
	IMPORT_C void DeregisterFile(const TDesC& aFileName);
williamr@2
   132
	IMPORT_C void CloseAll(MBackupObserver::TFileLockFlags aFlags,TRequestStatus& aStatus);
williamr@2
   133
	IMPORT_C void RestartAll();
williamr@2
   134
	IMPORT_C void CloseFileL(const TDesC& aFileName,MBackupObserver::TFileLockFlags aFlags);
williamr@2
   135
	IMPORT_C void RestartFile(const TDesC& aFileName);
williamr@2
   136
	IMPORT_C void RegisterBackupOperationObserverL(MBackupOperationObserver& aBackupOperationObserver);
williamr@2
   137
	IMPORT_C void DeRegisterBackupOperationObserver(MBackupOperationObserver& aBackupOperationObserver);
williamr@2
   138
	IMPORT_C TBool IsBackupOperationRunning() const;
williamr@2
   139
	IMPORT_C void NotifyBackupOperationL(const TBackupOperationAttributes& aBackupOperationAttributes);
williamr@2
   140
private:
williamr@2
   141
	CBaBackupSessionWrapper();
williamr@2
   142
	void ConstructL();
williamr@2
   143
private:
williamr@2
   144
	RBaBackupSession* iBackupSession;
williamr@2
   145
	CBaLockChangeNotifier* iLockChangeNotifier;
williamr@2
   146
	TAny* iReserved;  // needed to preserve BC
williamr@2
   147
	CBaBackupOperationNotifier* iBackupOperationNotifier;
williamr@2
   148
	};
williamr@2
   149
williamr@2
   150
williamr@2
   151
//
williamr@2
   152
// TBackupOperationAttributes
williamr@2
   153
//
williamr@2
   154
williamr@2
   155
inline TBackupOperationAttributes::TBackupOperationAttributes()
williamr@2
   156
	: iFileFlag(MBackupObserver::ETakeLock), iOperation(MBackupOperationObserver::ENone)
williamr@2
   157
	/** Default constructor. */
williamr@2
   158
	{
williamr@2
   159
	}
williamr@2
   160
williamr@2
   161
inline TBackupOperationAttributes::TBackupOperationAttributes(MBackupObserver::TFileLockFlags aFileFlag, MBackupOperationObserver::TOperationType aOperation)
williamr@2
   162
	: iFileFlag(aFileFlag), iOperation(aOperation)
williamr@2
   163
	/** Constructor that specifies operation attributes.
williamr@2
   164
	
williamr@2
   165
	@param aFileFlag File locking flags requested by the operation
williamr@2
   166
	@param aOperation Operation type */
williamr@2
   167
	{
williamr@2
   168
	}
williamr@2
   169
williamr@2
   170
williamr@2
   171
williamr@2
   172
#endif
williamr@4
   173