Class CBaBackupSessionWrapper

class CBaBackupSessionWrapper : public CBase;

Description

CBaBackupSessionWrapper provides the APIs necessary to enable a backup or restore/install by allowing broadcast requests for some or all files to either remain untouched or have their locks released for an arbitrary period.

The class should be used by both code driving a backup/install and any engines that will hold files locks or may access files regardless of the presence of (non-system) client apps

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CBaBackupSessionWrapper - CBaBackupSessionWrapper provides the APIs necessary to enable a backup or restor...

Members

Defined in CBaBackupSessionWrapper:

• DeRegisterBackupOperationObserver(MBackupOperationObserver &)De-registers the observer aBackupOperationObserver for getting notifications whe...
• DeregisterFile(const TDesC &)Stop sending this client requests to alter the lock state of aFileName
• IsBackupOperationRunning()constReturns ETrue when either a backup or restore operation is running, otherwise it...
• NewL()Returns a newly created CBaBackupSessionWrapper, passing ownership immediately
• RegisterBackupOperationObserverL(MBackupOperationObserver &)Registers the observer aBackupOperationObserver for getting notifications whethe...
• RegisterFileL(const TDesC &,MBackupObserver &)Register the specified file to the server. The given observer will be called bac...
• ~CBaBackupSessionWrapper()D'tor. Any files or apps that have been closed will be restarted

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 CBaBackupSessionWrapper* NewL();

Description

Returns a newly created CBaBackupSessionWrapper, passing ownership immediately

Return value

CBaBackupSessionWrapper *

IMPORT_C ~CBaBackupSessionWrapper();

Description

D'tor. Any files or apps that have been closed will be restarted

IMPORT_C void RegisterFileL(const TDesC &aFileName, MBackupObserver &aObserver);

Description

Register the specified file to the server. The given observer will be called back when the lock state of the file should be modified

Parameters

const TDesC16 &aFileName the name of the file to be observed. MBackupObserver &aObserver the observer which will be called back when the lock state of the file should be modified.

Leave codes

KErrServerBusy if the server is busy with the other client or under CloseAll operation. KErrNoMemory if not enough memory to register this file.

IMPORT_C void DeregisterFile(const TDesC &aFileName);

Description

Stop sending this client requests to alter the lock state of aFileName

Parameters

const TDesC16 &aFileName

IMPORT_C void RegisterBackupOperationObserverL(MBackupOperationObserver &aBackupOperationObserver);

Description

Registers the observer aBackupOperationObserver for getting notifications whether a backup or restore operation starts or ends.

Parameters

MBackupOperationObserver &aBackupOperationObserver

IMPORT_C void DeRegisterBackupOperationObserver(MBackupOperationObserver &aBackupOperationObserver);

Description

De-registers the observer aBackupOperationObserver for getting notifications whether a backup or restore operation starts or ends.

Parameters

MBackupOperationObserver &aBackupOperationObserver

IMPORT_C TBool IsBackupOperationRunning() const;

Description

Returns ETrue when either a backup or restore operation is running, otherwise it retunrs EFalse.

Return value

TBool