![[Index]](../../../../a_stock/btn_index_wt.gif){kind=small}
![[Spacer]](../../../../a_stock/btn_spacer.gif){kind=small}
![[Previous]](../../../../a_stock/btn_prev_wt.gif){kind=small}
![[Next]](../../../../a_stock/btn_next_wt.gif){kind=small}
|
|
|
|
|
|
||
Location:
sbdefs.h
namespace conn
This namespace is the global Symbian Connect namespace which encapsulates all of the connectivity components within Symbian OS.
Defined in conn:
CActiveBackupClient, EBURBackupFull, EBURBackupPartial, EBURNormal, EBURRestoreFull, EBURRestorePartial, EBURUnset, EBackupBase, EBackupIncrement, ENoBackup, KBURPartTypeMask, KBackupIncTypeMask, KUidBackupRestoreKey, MActiveBackupDataClient, TBURPartType, TBackupIncType
class MActiveBackupDataClient;
MActiveBackupDataClient is a Mixin to be implemented by an Active Backup client. The client connects to the Secure Backup Server using the CActiveBackupSession
class and provides an instance of MActiveBackupDataClient to be called for a range of functions.
The bulk transfer of data and snapshots is expected to be by means of shared heaps for performance reasons so the API is expected to change in these areas.
Defined in conn::MActiveBackupDataClient:
AllSnapshotsSuppliedL(), GetBackupDataSectionL(), GetDataChecksum(), GetExpectedDataSize(), GetExtendedInterface(), GetSnapshotDataL(), InitialiseGetBackupDataL(), InitialiseGetProxyBackupDataL(), InitialiseRestoreBaseDataL(), InitialiseRestoreIncrementDataL(), InitialiseRestoreProxyBaseDataL(), ReceiveSnapshotDataL(), RestoreBaseDataSectionL(), RestoreComplete(), RestoreIncrementDataSectionL(), TerminateMultiStageOperation(), ~MActiveBackupDataClient()
~MActiveBackupDataClient()
inline virtual ~MActiveBackupDataClient();
Empty virtual destructor to avoid memory leaks
AllSnapshotsSuppliedL()
virtual void AllSnapshotsSuppliedL()=0;
This method informs the active backup data client that all snapshots have been supplied. If the client has not received a snapshot then it should perform a base backup.
ReceiveSnapshotDataL()
virtual void ReceiveSnapshotDataL(TDriveNumber aDrive, TDesC8 &aBuffer, TBool aLastSection)=0;
This method receives all or part of a snapshot of data to allow calculation of an incremental backup. The snapshot is one that was previously supplied by the data owner. The snapshot data should be read from the location supplied. The snapshot data may be larger than the location supplied in which case the routine will be called repeatedly until all data has been supplied.
Snapshot data will also be supplied as part of a restore operation.
|
|
GetExpectedDataSize()
virtual TUint GetExpectedDataSize(TDriveNumber aDrive)=0;
This method returns the expected size of backup data that will be supplied. If an incremental backup is underway then this
method will not be called until after ReceiveSnapshotDataL(). The size data will be used for the purpose of tracking progess during a backup. If it is inaccurate then the user may see
irregular progress but the actual backup data will not be affected so it is acceptable to return an estimated value.
|
|
GetSnapshotDataL()
virtual void GetSnapshotDataL(TDriveNumber aDrive, TPtr8 &aBuffer, TBool &aFinished)=0;
This method returns a snapshot of data to accompany a backup. The snapshot is expected to contain details on files / data being backed up. The format of the snapshot is only meaningful to the data owner. The snapshot will be supplied if the data owner is asked for an incremental backup and for a restore operation. The snapshot data should be copied to the location supplied. The snapshot data may be larger than the location supplied in which case the routine will be called repeatedly until all data has been retrieved.
|
|
InitialiseGetBackupDataL()
virtual void InitialiseGetBackupDataL(TDriveNumber aDrive)=0;
This method prepares the implementor to return backup data. It will be followed by a sequence of calls to request the actual data.
|
GetBackupDataSectionL()
virtual void GetBackupDataSectionL(TPtr8 &aBuffer, TBool &aFinished)=0;
This method requests a section of backup data. InitialiseGetBackupDataL() will have been called prevously to specify the drive concerned. The data returned may be base or incremental depending on
the type of backup and the capability of the data owner.
|
InitialiseRestoreBaseDataL()
virtual void InitialiseRestoreBaseDataL(TDriveNumber aDrive)=0;
This method prepares the implementor to receive base restore data for a drive. It will be followed by a sequence of calls to supply the actual data.
|
RestoreBaseDataSectionL()
virtual void RestoreBaseDataSectionL(TDesC8 &aBuffer, TBool aFinished)=0;
This method receives a section of base restore data. InitialiseRestoreBaseDataL() will have been called prevously to specify the drive concerned.
|
InitialiseRestoreIncrementDataL()
virtual void InitialiseRestoreIncrementDataL(TDriveNumber aDrive)=0;
This method prepares the implementor to receive incremental restore data for a drive. It will be followed by a sequence of calls to supply the actual data. If multiple increments are supplied then this methid will be called before each increment.
|
RestoreIncrementDataSectionL()
virtual void RestoreIncrementDataSectionL(TDesC8 &aBuffer, TBool aFinished)=0;
This method receives a section of increment restore data. InitialiseRestoreIncrementDataL() will have been called prevously to specify the drive concerned.
|
RestoreComplete()
virtual void RestoreComplete(TDriveNumber aDrive)=0;
This method is called when all data to be restored has been supplied.
|
InitialiseGetProxyBackupDataL()
inline virtual void InitialiseGetProxyBackupDataL(TSecureId aSID, TDriveNumber aDrive);
This method prepares the implementor to return backup data on behalf of another data owner. It will be followed by a sequence of calls to request the actual data. This method is only for use by a proxy data manager that backs up data on behalf of other data owners. There is no corresponding method for snapshots as it is assumed that a proxy data manager will only handle base data.
|
InitialiseRestoreProxyBaseDataL()
inline virtual void InitialiseRestoreProxyBaseDataL(TSecureId aSID, TDriveNumber aDrive);
This method prepares the implementor to receive base restore data for another data owner for a drive. It will be followed by a sequence of calls to supply the actual data. This method is only for use by a proxy data manager that restores up data on behalf of other data owners. There is no corresponding method for incremental data as it is assumed that a proxy data manager will only handle base data.
|
TerminateMultiStageOperation()
virtual void TerminateMultiStageOperation()=0;
This method is called if copying of data is terminated prematurely to allow the implementor to tidy up. The same method applies to all types of data and to backup and restore
GetExtendedInterface()
inline virtual TAny *GetExtendedInterface(const TInt32 aUid);
Gets an extended interface based on a supplied uid.
|
|
GetDataChecksum()
virtual TUint GetDataChecksum(TDriveNumber aDrive)=0;
Gets a 32-bit checksum for its private data. This routine is for test purposes. It must be implemented but an invariant checksum value can be provided. Some tests may cause checksum values to be compared.
|
|
class CActiveBackupClient : public CBase;
CActiveBackupSession provides a connection to the Secure Backup Server for a data owning process.
It can be used to obtain information about an active backup or restore operation. It can also be used to signal to the Secure Backup Server when the data owner is ready for backup or restore.
It is also used by data owners that implement active backup or restore to provide a MActiveBackupDataClient implementation.
This class owns a RActiveBackupSessionImpl instance and publishes the public API to the outside world. The reason for this facade class is twofold:
Hiding the implementation details of RActiveBackupSessionImpl
Future binary compatibility
CBase - Base class for all classes to be instantiated on the heap
conn::CActiveBackupClient - CActiveBackupSession provides a connection to the Secure Backup Server for a data owning process
Defined in conn::CActiveBackupClient:
BURModeInfoL(), ConfirmReadyForBURL(), DoesPartialBURAffectMeL(), NewL(), NewL(), ~CActiveBackupClient()
Inherited from CBase:
Delete(),
Extension_(),
operator new()
NewL()
static IMPORT_C CActiveBackupClient *NewL();
This method creates a CActiveBackupSession, connects to the Secure Backup Server and does not wish to be called back so does
not supply an implementation of MActiveBackupDataClient.
If this is called when the Secure Backup Server is not active then it will leave with KErrNotSupported.
|
NewL()
static IMPORT_C CActiveBackupClient *NewL(MActiveBackupDataClient *aClient);
This method creates a CActiveBackupSession, connects to the Secure Backup Server and supplies a pointer to a MActiveBackupDataClient implementation.
If this is called when the Secure Backup Server is not active then it will leave with KErrNotSupported.
|
|
|
|
~CActiveBackupClient()
IMPORT_C ~CActiveBackupClient();
Standard destructor.
BURModeInfoL()
IMPORT_C void BURModeInfoL(TDriveList &aDriveList, TBURPartType &aBackupType, TBackupIncType &aIncBackupType);
This method returns the type(s) of backup / restore operation currently active
|
DoesPartialBURAffectMeL()
IMPORT_C TBool DoesPartialBURAffectMeL();
This method can be called when a partial backup or restore is active and will indicate whether the calling process is expected to take part. If a full backup or restore is active then this method will return ETrue for all data owners. If no backup or restore is active then this method will return EFalse for all data owners.
|
ConfirmReadyForBURL()
IMPORT_C void ConfirmReadyForBURL(TInt aErrorCode);
This method is called to indicate to the Secure Backup Server that the data owner is ready to participate in backup or restore. The data owner must call this method to indicate readiness or the Secure Backup Server will not request or supply backup data.
N.B. The Secure Backup Server will supply snapshot data (if relevant) before a data owner indicates readiness as it assumes that the data owner requires snapshot data in order to prepare for a backp or restore.
|
|
|
TBURPartType
The backup / restore state of a device.
|
TBackupIncType
The type of a backup.
|
|
|
const TUint KUidBackupRestoreKey;
Secure Backup and Restore publish and subscribe key
Secure Backup and Restore uses a Publish and Subscribe key to publish the current backup / restore state.
The key is a system key so the category to be used when subscribing is KUidSystemCategoryValue The key to be used is KUidBackupRestoreKey. The value is a bit-wise OR of a TBURPartType value and a TBackupIncType value This means that a normal state (i.e. non-backup or restore) is EBURNormal | ENoBackup but If the key has not been set (i.e. == 0) then no backup or restore is in progress either
const TUint KBackupIncTypeMask;
TBackupIncType Bitmask
|
Copyright ©2008 Symbian Software Ltd. |
|
![[Top]](../../../../a_stock/arrow_up_2.gif){kind=icon}
![[Previous]](../../../../a_stock/btn_prev.gif){kind=small}
![[Top]](../../../../a_stock/btn_top.gif)
![[Next]](../../../../a_stock/btn_next.gif){kind=small}