1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/apputils/inc/babackup.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,173 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#if !defined(__BABACKUP_H__)
1.20 +#define __BABACKUP_H__
1.21 +
1.22 +#include <e32std.h>
1.23 +#include <e32base.h>
1.24 +
1.25 +/**
1.26 +Backup server wrapper observer interface.
1.27 +
1.28 +MBackupObserver defines the interface to be implemented by any code that will
1.29 +hold file locks or may attempt to access files regardless of other device state
1.30 +e.g. a phone app may always attempt to access the contacts database for caller id
1.31 +
1.32 +@publishedAll
1.33 +@released
1.34 +*/
1.35 +class MBackupObserver
1.36 + {
1.37 +public:
1.38 +/** Flags indicating how to change a file lock. */
1.39 + enum TFileLockFlags
1.40 + {
1.41 + /** Owner can reopen/resume writing to the file. */
1.42 + ETakeLock =0,
1.43 + /** Owner should stop writing to the file. */
1.44 + EReleaseLockReadOnly =0x01,
1.45 + /** Owner should close the file. */
1.46 + EReleaseLockNoAccess =0x02,
1.47 + };
1.48 +public:
1.49 + /** Called by the server to request the file owner to change the lock on the specified
1.50 + file.
1.51 +
1.52 + @param aFileName Filename of affected file
1.53 + @param aFlags Flag indicating how to change the file lock */
1.54 + virtual void ChangeFileLockL(const TDesC& aFileName,TFileLockFlags aFlags)=0;
1.55 + };
1.56 +
1.57 +class TBackupOperationAttributes;
1.58 +
1.59 +/** Backup operation observer interface.
1.60 +
1.61 +Programs should implement this interface to receive notifications when a backup
1.62 +or restore operation either starts or ends.
1.63 +
1.64 +@see CBaBackupSessionWrapper::RegisterBackupOperationObserverL()
1.65 +@publishedAll
1.66 +@released
1.67 +*/
1.68 +class MBackupOperationObserver
1.69 + {
1.70 +public:
1.71 +/** Backup operation event types. */
1.72 + enum TOperationType
1.73 + {
1.74 + /** None. */
1.75 + ENone =0x00,
1.76 + /** Operation start. */
1.77 + EStart =0x01,
1.78 + /** Operation end. */
1.79 + EEnd =0x02,
1.80 + /** Operation aborted. */
1.81 + EAbort =0x04,
1.82 + };
1.83 +public:
1.84 + /** Called when a backup or restore operation either starts or ends.
1.85 +
1.86 + @param aBackupOperationAttributes Operation attributes */
1.87 + virtual void HandleBackupOperationEventL(const TBackupOperationAttributes& aBackupOperationAttributes)=0;
1.88 +private:
1.89 + IMPORT_C virtual void Reserved1();
1.90 + };
1.91 +
1.92 +
1.93 +/**
1.94 +Attributes for a backup operation.
1.95 +
1.96 +@see MBackupOperationObserver
1.97 +@publishedAll
1.98 +@released
1.99 +*/
1.100 +class TBackupOperationAttributes
1.101 + {
1.102 +public:
1.103 + inline TBackupOperationAttributes();
1.104 + inline TBackupOperationAttributes(MBackupObserver::TFileLockFlags aFileFlag, MBackupOperationObserver::TOperationType aOperation);
1.105 +public:
1.106 + /** File locking flags requested by the operation. */
1.107 + MBackupObserver::TFileLockFlags iFileFlag;
1.108 + /** Operation type. */
1.109 + MBackupOperationObserver::TOperationType iOperation;
1.110 + };
1.111 +
1.112 +
1.113 +class RBaBackupSession;
1.114 +class CBaLockChangeNotifier;
1.115 +class CBaBackupOperationNotifier;
1.116 +
1.117 +/**
1.118 +CBaBackupSessionWrapper provides the APIs necessary to enable a backup or restore/install
1.119 +by allowing broadcast requests for some or all files to either remain untouched or have
1.120 +their locks released for an arbitrary period.
1.121 +
1.122 +The class should be used by both code driving a backup/install and any engines that will
1.123 +hold files locks or may access files regardless of the presence of (non-system) client apps
1.124 +
1.125 +@publishedAll
1.126 +@released
1.127 +*/
1.128 +class CBaBackupSessionWrapper : public CBase
1.129 + {
1.130 +public:
1.131 + IMPORT_C static CBaBackupSessionWrapper* NewL();
1.132 + IMPORT_C ~CBaBackupSessionWrapper();
1.133 + IMPORT_C void RegisterFileL(const TDesC& aFileName,MBackupObserver& aObserver);
1.134 + IMPORT_C void DeregisterFile(const TDesC& aFileName);
1.135 + IMPORT_C void CloseAll(MBackupObserver::TFileLockFlags aFlags,TRequestStatus& aStatus);
1.136 + IMPORT_C void RestartAll();
1.137 + IMPORT_C void CloseFileL(const TDesC& aFileName,MBackupObserver::TFileLockFlags aFlags);
1.138 + IMPORT_C void RestartFile(const TDesC& aFileName);
1.139 + IMPORT_C void RegisterBackupOperationObserverL(MBackupOperationObserver& aBackupOperationObserver);
1.140 + IMPORT_C void DeRegisterBackupOperationObserver(MBackupOperationObserver& aBackupOperationObserver);
1.141 + IMPORT_C TBool IsBackupOperationRunning() const;
1.142 + IMPORT_C void NotifyBackupOperationL(const TBackupOperationAttributes& aBackupOperationAttributes);
1.143 +private:
1.144 + CBaBackupSessionWrapper();
1.145 + void ConstructL();
1.146 +private:
1.147 + RBaBackupSession* iBackupSession;
1.148 + CBaLockChangeNotifier* iLockChangeNotifier;
1.149 + TAny* iReserved; // needed to preserve BC
1.150 + CBaBackupOperationNotifier* iBackupOperationNotifier;
1.151 + };
1.152 +
1.153 +
1.154 +//
1.155 +// TBackupOperationAttributes
1.156 +//
1.157 +
1.158 +inline TBackupOperationAttributes::TBackupOperationAttributes()
1.159 + : iFileFlag(MBackupObserver::ETakeLock), iOperation(MBackupOperationObserver::ENone)
1.160 + /** Default constructor. */
1.161 + {
1.162 + }
1.163 +
1.164 +inline TBackupOperationAttributes::TBackupOperationAttributes(MBackupObserver::TFileLockFlags aFileFlag, MBackupOperationObserver::TOperationType aOperation)
1.165 + : iFileFlag(aFileFlag), iOperation(aOperation)
1.166 + /** Constructor that specifies operation attributes.
1.167 +
1.168 + @param aFileFlag File locking flags requested by the operation
1.169 + @param aOperation Operation type */
1.170 + {
1.171 + }
1.172 +
1.173 +
1.174 +
1.175 +#endif
1.176 +