Class conn::CActiveBackupClient

class CActiveBackupClient : public CBase;

Description

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 conn::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

Derivation

• 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 dat...

Members

Defined in conn::CActiveBackupClient:

• BURModeInfoL(TDriveList &,TBURPartType &,TBackupIncType &)This method returns the type(s) of backup / restore operation currently active
• ConfirmReadyForBURL(TInt)This method is called to indicate to the Secure Backup Server that the data owne...
• DoesPartialBURAffectMeL()This method can be called when a partial backup or restore is active and will in...
• NewL()This method creates a CActiveBackupSession, connects to the Secure Backup Server...
• NewL(MActiveBackupDataClient *)This method creates a CActiveBackupSession, connects to the Secure Backup Server...
• ~CActiveBackupClient()Standard destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CActiveBackupClient* NewL();

Description

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 conn::MActiveBackupDataClient.

If this is called when the Secure Backup Server is not active then it will leave with KErrNotSupported.

Return value

conn::CActiveBackupClient * Pointer to a created conn::CActiveBackupClient object

IMPORT_C static CActiveBackupClient* NewL(MActiveBackupDataClient *aClient);

Description

This method creates a CActiveBackupSession, connects to the Secure Backup Server and supplies a pointer to a conn::MActiveBackupDataClient implementation.

If this is called when the Secure Backup Server is not active then it will leave with KErrNotSupported.

Parameters

conn::MActiveBackupDataClient *aClient pointer to an object that implements the conn::MActiveBackupDataClient mixin. If this is NULL then the data owner does not take part in active backup or restore.

Return value

conn::CActiveBackupClient * Pointer to a created conn::CActiveBackupClient object

Leave codes

Release only - If an ActiveScheduler is not installed

Panic codes

KErrNotFound Debug only - If an ActiveScheduler is not installed

IMPORT_C ~CActiveBackupClient();

Description

Standard destructor.

IMPORT_C void BURModeInfoL(TDriveList &aDriveList, TBURPartType &aBackupType, TBackupIncType &aIncBackupType);

Description

This method returns the type(s) of backup / restore operation currently active

Parameters

TBuf8 &aDriveList list of drives involved in backup and restore conn::TBURPartType &aBackupType enumerated type indicating whether a backup or restore is in progress and whether full or partial. conn::TBackupIncType &aIncBackupType enumerated type indicating whetherr a backup is base or incremental.

IMPORT_C TBool DoesPartialBURAffectMeL();

Description

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.

Return value

TBool ETrue if the calling data owner is involved in the current backup or restore operation.

IMPORT_C void ConfirmReadyForBURL(TInt aErrorCode);

Description

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.

Parameters

TInt aErrorCode this should be set to KErrNone when the client is ready for backup or restore. If it is set to any other value then it indicates that the client cannot continue with the backup or restore and the error code will be supplied to the remote backup client.