Collapse all Symbian^3 Product Developer Library

conn::CActiveBackupClient Class Reference

class conn::CActiveBackupClient : public CBase

CActiveBackupClient 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

Inherits from

conn::CActiveBackupClient
- CBase

Public Member Functions
	~CActiveBackupClient()
IMPORT_C void	BURModeInfoL(TDriveList &, TBURPartType &, TBackupIncType &)
IMPORT_C void	ConfirmReadyForBURL(TInt)
IMPORT_C TBool	DoesPartialBURAffectMeL()
IMPORT_C CActiveBackupClient *	NewL()
IMPORT_C CActiveBackupClient *	NewL(MActiveBackupDataClient *)

Private Member Functions
	CActiveBackupClient()
void	ConstructL()
void	ConstructL(MActiveBackupDataClient *)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CActiveBackupCallbackHandler *	iABCallbackHandler
RABClientSession *	iClientSession

Constructor & Destructor Documentation

CActiveBackupClient()

CActiveBackupClient

(

)

[private]

Class constructor.

~CActiveBackupClient()

IMPORT_C

~CActiveBackupClient

(

)

Standard destructor.

Member Functions Documentation

BURModeInfoL(TDriveList &, TBURPartType &, TBackupIncType &)

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

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

Parameters

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

ConfirmReadyForBURL(TInt)

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.

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.

ConstructL()

void

ConstructL

(

)

[private]

Construct this instance of CActiveBackupClient

ConstructL(MActiveBackupDataClient *)

void

ConstructL

(

MActiveBackupDataClient *

aClient

)

[private]

Construct this instance of CActiveBackupClient

Parameters

MActiveBackupDataClient * aClient

Pointer to a concrete instance of MActiveBackupDataClient

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.

NewL()

IMPORT_C CActiveBackupClient *

NewL

(

)

[static]

This method creates a CActiveBackupClient, 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(MActiveBackupDataClient *)

IMPORT_C CActiveBackupClient *

NewL

(

MActiveBackupDataClient *

aClient

)

[static]

This method creates a CActiveBackupClient, 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.

panic: KErrNotFound Debug only - If an ActiveScheduler is not installed

leave: Release only - If an ActiveScheduler is not installed

Parameters

MActiveBackupDataClient * aClient

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

Member Data Documentation

CActiveBackupCallbackHandler * iABCallbackHandler

CActiveBackupCallbackHandler *

iABCallbackHandler

[private]

Pointer to the Active Backup Callback Handler

RABClientSession * iClientSession

RABClientSession *

iClientSession

[private]

Pointer to the client session R class that's wrapped up by this class