CMsvIndexContext Class Reference

class CMsvIndexContext : public CActive

Inherits from

Public Member Functions
~CMsvIndexContext ()
const TMsvConfig & Config ()
void CreateIndexL ( TInt , TRequestStatus &)
void CreateIndexL ( TInt , TBool )
TBool GetAndClearIndexCorruptFlagL ()
CMsvIndexAdapter *& IndexAdapter ()
CMsvIndexAdapter * IndexAdapter ()
const TDesC & IndexFileName ()
CPermanentFileStore & IndexStore ()
TBool Initialized ()
void Initialized ( TBool )
TInt LoadStoreConfig ( TBool )
void LocalizeStandardFoldersL ()
const TDesC & MessageFolder ()
CMsvIndexContext * NewL ( CMsvServer &, MMsvContextObserver &)
CMsvIndexContext * NewLC ( CMsvServer &, MMsvContextObserver &)
const TMsvIndexLoadProgress & Progress ()
const CMsvEntrySelection & Remove ()
CMsvEntrySelection & Remove ()
TMsvIndexLoadProgress::TIndexState State ()
const CMsvEntrySelection & Update ()
CMsvEntrySelection & Update ()
Private Member Functions
CMsvIndexContext ( CMsvServer &, MMsvContextObserver &)
void ConstructL ()
void CreateStoreDeleteFile ()
void DoCancel ()
void DoCreateServiceDirsL ()
void DoStoreConfigL ()
void IndexFailedToLoad ( TInt )
void IndexLoaded ( TMsvServerChangeNotificationType )
void IndexLoadingCompleted ( TInt )
void ResetAndCreateNewMailStoreL ( TBool )
void RunL ()
Inherited Functions
CActive::CActive(TInt)
CActive::Cancel()
CActive::Deque()
CActive::Extension_(TUint,TAny *&,TAny *)
CActive::IsActive()const
CActive::IsAdded()const
CActive::Priority()const
CActive::RunError(TInt)
CActive::SetActive()
CActive::SetPriority(TInt)
CActive::~CActive()
CBase::CBase()
CBase::Delete(CBase *)
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()
Inherited Enumerations
CActive:TPriority
Private Attributes
HBufC8 * iBuf
TMsvConfig iConfig
CMsvIndexAdapter * iIndexAdapter
TBool iInitialized
TFileName iMessageFolder
MMsvContextObserver & iObserver
TRequestStatus * iObserverStatus
TMsvIndexLoadProgress iProgress
CMsvEntrySelection * iRemoveEntries
TBool iRunMailInit
CMsvServer & iServer
TBool iSyncLoad
CMsvEntrySelection * iUpdateEntryStreams
Inherited Attributes
CActive::iStatus

Constructor & Destructor Documentation

CMsvIndexContext(CMsvServer &, MMsvContextObserver &)

CMsvIndexContext ( CMsvServer & aServer,
MMsvContextObserver & aObserver
) [private]

Parameters

CMsvServer & aServer
MMsvContextObserver & aObserver

~CMsvIndexContext()

~CMsvIndexContext ( )

Member Functions Documentation

Config()

const TMsvConfig & Config ( ) const [inline]

ConstructL()

void ConstructL ( ) [private]

CreateIndexL(TInt, TRequestStatus &)

void CreateIndexL ( TInt aDrive,
TRequestStatus & aStatus
)

Parameters

TInt aDrive
TRequestStatus & aStatus

CreateIndexL(TInt, TBool)

void CreateIndexL ( TInt aDrive,
TBool aSync
)

Parameters

TInt aDrive
TBool aSync

CreateStoreDeleteFile()

void CreateStoreDeleteFile ( ) [private]

DoCancel()

void DoCancel ( ) [private, virtual]

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel() .

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel() .

CActive::Cancel

DoCreateServiceDirsL()

void DoCreateServiceDirsL ( ) [private]

DoStoreConfigL()

void DoStoreConfigL ( ) [private]

GetAndClearIndexCorruptFlagL()

TBool GetAndClearIndexCorruptFlagL ( )

IndexAdapter()

CMsvIndexAdapter *& IndexAdapter ( ) [inline]

IndexAdapter()

CMsvIndexAdapter * IndexAdapter ( ) const [inline]

IndexFailedToLoad(TInt)

void IndexFailedToLoad ( TInt aError ) [private]

Parameters

TInt aError

IndexFileName()

const TDesC & IndexFileName ( ) const

IndexLoaded(TMsvServerChangeNotificationType)

void IndexLoaded ( TMsvServerChangeNotificationType aNotification ) [private]

Parameters

TMsvServerChangeNotificationType aNotification

IndexLoadingCompleted(TInt)

void IndexLoadingCompleted ( TInt aError ) [private]

Parameters

TInt aError

IndexStore()

CPermanentFileStore & IndexStore ( )

Initialized()

TBool Initialized ( ) const [inline]

Initialized(TBool)

void Initialized ( TBool aInitialized ) [inline]

Parameters

TBool aInitialized

LoadStoreConfig(TBool)

TInt LoadStoreConfig ( TBool aLoad )

Parameters

TBool aLoad

LocalizeStandardFoldersL()

void LocalizeStandardFoldersL ( )

MessageFolder()

const TDesC & MessageFolder ( ) const [inline]

NewL(CMsvServer &, MMsvContextObserver &)

CMsvIndexContext * NewL ( CMsvServer & aServer,
MMsvContextObserver & aObserver
) [static]

Parameters

CMsvServer & aServer
MMsvContextObserver & aObserver

NewLC(CMsvServer &, MMsvContextObserver &)

CMsvIndexContext * NewLC ( CMsvServer & aServer,
MMsvContextObserver & aObserver
) [static]

Parameters

CMsvServer & aServer
MMsvContextObserver & aObserver

Progress()

const TMsvIndexLoadProgress & Progress ( )

Remove()

const CMsvEntrySelection & Remove ( ) const [inline]

Remove()

CMsvEntrySelection & Remove ( ) [inline]

ResetAndCreateNewMailStoreL(TBool)

void ResetAndCreateNewMailStoreL ( TBool aDelete = ETrue ) [private]

Parameters

TBool aDelete = ETrue

RunL()

void RunL ( ) [private, virtual]

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's RunL() or RunError() functions.

CActiveScheduler::Start CActiveScheduler::Error CActiveScheduler::WaitForAnyRequest TRAPD

State()

TMsvIndexLoadProgress::TIndexState State ( ) const [inline]

Update()

const CMsvEntrySelection & Update ( ) const [inline]

Update()

CMsvEntrySelection & Update ( ) [inline]

Member Data Documentation

HBufC8 * iBuf

HBufC8 * iBuf [private]

TMsvConfig iConfig

TMsvConfig iConfig [private]

CMsvIndexAdapter * iIndexAdapter

CMsvIndexAdapter * iIndexAdapter [private]

TBool iInitialized

TBool iInitialized [private]

TFileName iMessageFolder

TFileName iMessageFolder [private]

MMsvContextObserver & iObserver

MMsvContextObserver & iObserver [private]

TRequestStatus * iObserverStatus

TRequestStatus * iObserverStatus [private]

TMsvIndexLoadProgress iProgress

TMsvIndexLoadProgress iProgress [private]

CMsvEntrySelection * iRemoveEntries

CMsvEntrySelection * iRemoveEntries [private]

TBool iRunMailInit

TBool iRunMailInit [private]

CMsvServer & iServer

CMsvServer & iServer [private]

TBool iSyncLoad

TBool iSyncLoad [private]

CMsvEntrySelection * iUpdateEntryStreams

CMsvEntrySelection * iUpdateEntryStreams [private]