CBaBackupSessionWrapper Class Reference

#include <babackup.h>

Link against: bafl.lib

class CBaBackupSessionWrapper : public CBase

Inherits from

  • CBaBackupSessionWrapper
    Public Member Functions
    ~CBaBackupSessionWrapper()
    IMPORT_C voidCloseAll(MBackupObserver::TFileLockFlags, TRequestStatus &)
    IMPORT_C voidCloseFileL(const TDesC &, MBackupObserver::TFileLockFlags)
    IMPORT_C voidDeRegisterBackupOperationObserver(MBackupOperationObserver &)
    IMPORT_C voidDeregisterFile(const TDesC &)
    IMPORT_C TBoolIsBackupOperationRunning()
    IMPORT_C CBaBackupSessionWrapper *NewL()
    IMPORT_C voidNotifyBackupOperationL(const TBackupOperationAttributes &)
    IMPORT_C voidRegisterBackupOperationObserverL(MBackupOperationObserver &)
    IMPORT_C voidRegisterFileL(const TDesC &, MBackupObserver &)
    IMPORT_C voidRestartAll()
    IMPORT_C voidRestartFile(const TDesC &)
    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()

    Detailed 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

    Constructor & Destructor Documentation

    ~CBaBackupSessionWrapper ( )

    IMPORT_C~CBaBackupSessionWrapper()

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

    Member Function Documentation

    CloseAll ( MBackupObserver::TFileLockFlags, TRequestStatus & )

    IMPORT_C voidCloseAll(MBackupObserver::TFileLockFlagsaFlags,
    TRequestStatus &aStatus
    )

    Closes all non-system apps and signal all registered files to have their locks altered according to aFlags. Returns immediately before having finished all processing. aStatus will be completed when everything is closed or closing has completed. Possible error codes are KErrNoMemory - Not enough memory to signal all apps/files to close KErrServerBusy - Another client has some files closed - No-one else should attempt any backup operation KErrLocked - Not all apps were successfully closed In all cases, an undefined number of apps/files may have been closed and backup may still be possible although install/restore operations should not be attempted.

    capability
    WriteDeviceData
    ParameterDescription
    aFlagsthe file lock state to request the other clients with.
    aStatusthe request status to be completed when all files have been closed.

    CloseFileL ( const TDesC &, MBackupObserver::TFileLockFlags )

    IMPORT_C voidCloseFileL(const TDesC &aFileName,
    MBackupObserver::TFileLockFlagsaFlags
    )

    Close or reduce use of aFileName depending on the state of aFlags.

    leave
    KErrNoMemory if not enough memory to signal the files to close. KErrServerIsBusy if another client has some files being closed.
    capability
    WriteDeviceData
    ParameterDescription
    aFileNamethe name of the file to be closed / changed the file lock state.

    DeRegisterBackupOperationObserver ( MBackupOperationObserver & )

    IMPORT_C voidDeRegisterBackupOperationObserver(MBackupOperationObserver &aBackupOperationObserver)

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

    Since
    App-Framework_6.2

    DeregisterFile ( const TDesC & )

    IMPORT_C voidDeregisterFile(const TDesC &aFileName)

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

    IsBackupOperationRunning ( )

    IMPORT_C TBoolIsBackupOperationRunning()const

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

    Since
    App-Framework_6.2

    NewL ( )

    IMPORT_C CBaBackupSessionWrapper *NewL()[static]

    Returns a newly created CBaBackupSessionWrapper, passing ownership immediately

    NotifyBackupOperationL ( const TBackupOperationAttributes & )

    IMPORT_C voidNotifyBackupOperationL(const TBackupOperationAttributes &aBackupOperationAttributes)

    Notifies the server that a backup operation is going to happen.

    Since
    App-Framework_6.2
    capability
    WriteDeviceData

    RegisterBackupOperationObserverL ( MBackupOperationObserver & )

    IMPORT_C voidRegisterBackupOperationObserverL(MBackupOperationObserver &aBackupOperationObserver)

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

    Since
    App-Framework_6.2

    RegisterFileL ( const TDesC &, MBackupObserver & )

    IMPORT_C voidRegisterFileL(const TDesC &aFileName,
    MBackupObserver &aObserver
    )

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

    leave
    KErrServerBusy if the server is busy with the other client or under CloseAll operation. KErrNoMemory if not enough memory to register this file.
    ParameterDescription
    aFileNamethe name of the file to be observed.
    aObserverthe observer which will be called back when the lock state of the file should be modified.

    RestartAll ( )

    IMPORT_C voidRestartAll()

    Opposite of CloseAll. Can safely be called nothing has been closed by this client

    capability
    WriteDeviceData

    RestartFile ( const TDesC & )

    IMPORT_C voidRestartFile(const TDesC &aFileName)

    Opposite of CloseFileL. Can be safely called if CloseFileL hasn't been called before

    capability
    WriteDeviceData
    © Nokia 2011.