![Symbian Developer Library](../../../../a_stock/images/mainheading.gif)
![]() |
![]() |
|
class MActiveBackupDataClient;
conn::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 conn::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()
This method informs the active backup data client that all snapshots have been s...GetBackupDataSectionL(TPtr8 &,TBool &)
This method requests a section of backup data. conn::MActiveBackupDataClient::In...GetDataChecksum(TDriveNumber)
Gets a 32-bit checksum for its private data. This routine is for test purposes. ...GetExpectedDataSize(TDriveNumber)
This method returns the expected size of backup data that will be supplied. If a...GetExtendedInterface(const TInt32)
Gets an extended interface based on a supplied uid.GetSnapshotDataL(TDriveNumber,TPtr8 &,TBool &)
This method returns a snapshot of data to accompany a backup. The snapshot is ex...InitialiseGetBackupDataL(TDriveNumber)
This method prepares the implementor to return backup data. It will be followed ...InitialiseGetProxyBackupDataL(TSecureId,TDriveNumber)
This method prepares the implementor to return backup data on behalf of another ...InitialiseRestoreBaseDataL(TDriveNumber)
This method prepares the implementor to receive base restore data for a drive. I...InitialiseRestoreIncrementDataL(TDriveNumber)
This method prepares the implementor to receive incremental restore data for a d...InitialiseRestoreProxyBaseDataL(TSecureId,TDriveNumber)
This method prepares the implementor to receive base restore data for another da...ReceiveSnapshotDataL(TDriveNumber,TDesC8 &,TBool)
This method receives all or part of a snapshot of data to allow calculation of a...RestoreBaseDataSectionL(TDesC8 &,TBool)
This method receives a section of base restore data. conn::MActiveBackupDataClie...RestoreComplete(TDriveNumber)
This method is called when all data to be restored has been supplied.RestoreIncrementDataSectionL(TDesC8 &,TBool)
This method receives a section of increment restore data. conn::MActiveBackupDat...TerminateMultiStageOperation()
This method is called if copying of data is terminated prematurely to allow the ...~MActiveBackupDataClient()
Empty virtual destructor to avoid memory leaksinline virtual ~MActiveBackupDataClient();
Empty virtual destructor to avoid memory leaks
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.
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.
|
|
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 conn::MActiveBackupDataClient::ReceiveSnapshotDataL(TDriveNumber,TDesC8 &,TBool)
. 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.
|
|
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.
|
|
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.
|
virtual void GetBackupDataSectionL(TPtr8 &aBuffer, TBool &aFinished)=0;
This method requests a section of backup data. conn::MActiveBackupDataClient::InitialiseGetBackupDataL(TDriveNumber)
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.
|
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.
|
virtual void RestoreBaseDataSectionL(TDesC8 &aBuffer, TBool aFinished)=0;
This method receives a section of base restore data. conn::MActiveBackupDataClient::InitialiseRestoreBaseDataL(TDriveNumber)
will have been called prevously to specify the drive concerned.
|
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.
|
virtual void RestoreIncrementDataSectionL(TDesC8 &aBuffer, TBool aFinished)=0;
This method receives a section of increment restore data. conn::MActiveBackupDataClient::InitialiseRestoreIncrementDataL(TDriveNumber)
will have been called prevously to specify the drive concerned.
|
virtual void RestoreComplete(TDriveNumber aDrive)=0;
This method is called when all data to be restored has been supplied.
|
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.
|
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.
|
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
inline virtual TAny* GetExtendedInterface(const TInt32 aUid);
Gets an extended interface based on a supplied uid.
|
|
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.
|
|