#include <abclient.h>

This item is not part of the S60 5th Edition SDK

Class `conn::MActiveBackupDataClient`

class MActiveBackupDataClient;

Description

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.

Members

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 leaks

Construction and destruction

`~MActiveBackupDataClient()`

inline virtual ~MActiveBackupDataClient();

Description

Empty virtual destructor to avoid memory leaks

Member functions

`AllSnapshotsSuppliedL()`

virtual void AllSnapshotsSuppliedL()=0;

Description

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(TDriveNumber,TDesC8 &,TBool)`

virtual void ReceiveSnapshotDataL(TDriveNumber aDrive, TDesC8 &aBuffer, TBool aLastSection)=0;

Description

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.

Parameters

`TDriveNumber aDrive`	the drive being backed up
`TDesC8 &aBuffer`	a pointer to the base of the location from whence data can be copied.
`TBool aLastSection`	ETrue if this is the last section of snapshot data, else EFalse.

Leave codes

KErrNotSupported

if the data owner does not support incremental backups.

`GetExpectedDataSize(TDriveNumber)`

virtual TUint GetExpectedDataSize(TDriveNumber aDrive)=0;

Description

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.

Parameters


                                 						TDriveNumber aDrive

the drive being backed up.

Return value

TUint

the size of the data that will be returned

`GetSnapshotDataL(TDriveNumber,TPtr8 &,TBool &)`

virtual void GetSnapshotDataL(TDriveNumber aDrive, TPtr8 &aBuffer, TBool &aFinished)=0;

Description

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.

Parameters

`TDriveNumber aDrive`	the drive being backed up
`TPtr8 &aBuffer`	a pointer to the base of the location where data can be copied.
`TBool &aFinished`	on return ETrue if all data has been returned for this drive, else EFalse.

Leave codes

KErrNotSupported

if the data owner does not support incremental backups.

`InitialiseGetBackupDataL(TDriveNumber)`

virtual void InitialiseGetBackupDataL(TDriveNumber aDrive)=0;

Description

This method prepares the implementor to return backup data. It will be followed by a sequence of calls to request the actual data.

Parameters


                                 						TDriveNumber aDrive

the drive being backed up.

`GetBackupDataSectionL(TPtr8 &,TBool &)`

virtual void GetBackupDataSectionL(TPtr8 &aBuffer, TBool &aFinished)=0;

Description

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.

Parameters

`TPtr8 &aBuffer`	a pointer to the base of the location where data can be copied.
`TBool &aFinished`	on return ETrue if all data has been returned for this drive, else EFalse.

`InitialiseRestoreBaseDataL(TDriveNumber)`

virtual void InitialiseRestoreBaseDataL(TDriveNumber aDrive)=0;

Description

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.

Parameters


                                 						TDriveNumber aDrive

the drive being restored.

`RestoreBaseDataSectionL(TDesC8 &,TBool)`

virtual void RestoreBaseDataSectionL(TDesC8 &aBuffer, TBool aFinished)=0;

Description

This method receives a section of base restore data. conn::MActiveBackupDataClient::InitialiseRestoreBaseDataL(TDriveNumber) will have been called prevously to specify the drive concerned.

Parameters

`TDesC8 &aBuffer`	a pointer to the base of the location whence data can be read.
`TBool aFinished`	ETrue if all data has been returned for this drive, else EFalse.

`InitialiseRestoreIncrementDataL(TDriveNumber)`

virtual void InitialiseRestoreIncrementDataL(TDriveNumber aDrive)=0;

Description

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.

Parameters


                                 						TDriveNumber aDrive

the drive being restored.

`RestoreIncrementDataSectionL(TDesC8 &,TBool)`

virtual void RestoreIncrementDataSectionL(TDesC8 &aBuffer, TBool aFinished)=0;

Description

This method receives a section of increment restore data. conn::MActiveBackupDataClient::InitialiseRestoreIncrementDataL(TDriveNumber) will have been called prevously to specify the drive concerned.

Parameters

`TDesC8 &aBuffer`	a pointer to the base of the location whence data can be read.
`TBool aFinished`	ETrue if all data has been returned for this increment, else EFalse.

`RestoreComplete(TDriveNumber)`

virtual void RestoreComplete(TDriveNumber aDrive)=0;

Description

This method is called when all data to be restored has been supplied.

Parameters


                                 						TDriveNumber aDrive

the drive being restored.

`InitialiseGetProxyBackupDataL(TSecureId,TDriveNumber)`

inline virtual void InitialiseGetProxyBackupDataL(TSecureId aSID, TDriveNumber aDrive);

Description

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.

Parameters

`TSecureId aSID`	the data owner whose data is to be backed up
`TDriveNumber aDrive`	the drive being backed up.

`InitialiseRestoreProxyBaseDataL(TSecureId,TDriveNumber)`

inline virtual void InitialiseRestoreProxyBaseDataL(TSecureId aSID, TDriveNumber aDrive);

Description

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.

Parameters

`TSecureId aSID`	the data owner whose data is to be restored
`TDriveNumber aDrive`	the drive being restored.

`TerminateMultiStageOperation()`

virtual void TerminateMultiStageOperation()=0;

Description

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(const TInt32)`

inline virtual TAny* GetExtendedInterface(const TInt32 aUid);

Description

Gets an extended interface based on a supplied uid.

Parameters

const TInt32 aUid

Uid which identifies an extended interface

Return value

TAny *

Pointer to an extended interface

`GetDataChecksum(TDriveNumber)`

virtual TUint GetDataChecksum(TDriveNumber aDrive)=0;

Description

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.

Parameters


                                 						TDriveNumber aDrive

the drive containing data being checksummed

Return value

TUint

the 32-bit checksum

Class conn::MActiveBackupDataClient

Description

Members

Construction and destruction

~MActiveBackupDataClient()

Description

Member functions

AllSnapshotsSuppliedL()

Description

ReceiveSnapshotDataL(TDriveNumber,TDesC8 &,TBool)

Description

Parameters

Leave codes

GetExpectedDataSize(TDriveNumber)

Description

Parameters

Return value

GetSnapshotDataL(TDriveNumber,TPtr8 &,TBool &)

Description

Parameters

Leave codes

InitialiseGetBackupDataL(TDriveNumber)

Description

Parameters

GetBackupDataSectionL(TPtr8 &,TBool &)

Description

Parameters

InitialiseRestoreBaseDataL(TDriveNumber)

Description

Parameters

RestoreBaseDataSectionL(TDesC8 &,TBool)

Description

Parameters

InitialiseRestoreIncrementDataL(TDriveNumber)

Description

Parameters

RestoreIncrementDataSectionL(TDesC8 &,TBool)

Description

Parameters

RestoreComplete(TDriveNumber)

Description

Parameters

InitialiseGetProxyBackupDataL(TSecureId,TDriveNumber)

Description

Parameters

InitialiseRestoreProxyBaseDataL(TSecureId,TDriveNumber)

Description

Parameters

TerminateMultiStageOperation()

Description

GetExtendedInterface(const TInt32)

Description

Parameters

Return value

GetDataChecksum(TDriveNumber)

Description

Parameters

Return value

Class `conn::MActiveBackupDataClient`

`~MActiveBackupDataClient()`

`AllSnapshotsSuppliedL()`

`ReceiveSnapshotDataL(TDriveNumber,TDesC8 &,TBool)`

`GetExpectedDataSize(TDriveNumber)`

`GetSnapshotDataL(TDriveNumber,TPtr8 &,TBool &)`

`InitialiseGetBackupDataL(TDriveNumber)`

`GetBackupDataSectionL(TPtr8 &,TBool &)`

`InitialiseRestoreBaseDataL(TDriveNumber)`

`RestoreBaseDataSectionL(TDesC8 &,TBool)`

`InitialiseRestoreIncrementDataL(TDriveNumber)`

`RestoreIncrementDataSectionL(TDesC8 &,TBool)`

`RestoreComplete(TDriveNumber)`

`InitialiseGetProxyBackupDataL(TSecureId,TDriveNumber)`

`InitialiseRestoreProxyBaseDataL(TSecureId,TDriveNumber)`

`TerminateMultiStageOperation()`

`GetExtendedInterface(const TInt32)`

`GetDataChecksum(TDriveNumber)`