Symbian^3 Application Developer Library >

CAsynchFSQ Class Reference

class CAsynchFSQ : private CBase

Asynchronous file manager queue and related operations.

Since
3.2

Inherits from

Public Member Functions
~CAsynchFSQ ()
IMPORT_C TInt ActionsLeft ()
IMPORT_C void Cancel ()
IMPORT_C TInt Delete (const TDesC &)
IMPORT_C TInt Go ()
IMPORT_C CAsynchFSQ * NewL ()
void Notify ( TInt )
IMPORT_C TInt Rename (const TDesC &, const TDesC &)
IMPORT_C TInt SaveAndDestroy ( TDesC8 &, const TDesC &, TBool )
IMPORT_C void SetCallback ( MAsynchFSQObserver *)
IMPORT_C void SetManualStart ( TBool )
IMPORT_C void SetPriority ( TInt )
Private Member Functions
CAsynchFSQ ()
void ConstructL ()
TInt Enqueue ( TFSQActionType , TDesC8 &, const TDesC &, const TDesC &, TFSQSchemaType , const TDesC &, 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()
Private Attributes
MAsynchFSQObserver * iCallback
TBool iManualStart
TBool iOverwrite
TInt iPriority
RPointerArray < CAsynchFSQAtom > iQueue

Constructor & Destructor Documentation

CAsynchFSQ()

CAsynchFSQ ( ) [private]

C++ default constructor.

~CAsynchFSQ()

~CAsynchFSQ ( ) [virtual]

Destructor.

Member Functions Documentation

ActionsLeft()

IMPORT_C TInt ActionsLeft ( )

Returns the number of actions left for the queue to perform

Cancel()

IMPORT_C void Cancel ( )

Cancels any ongoing activity and clears the threads.

ConstructL()

void ConstructL ( ) [private]

By default Symbian 2nd phase constructor is private.

Delete(const TDesC &)

IMPORT_C TInt Delete ( const TDesC & aPath )

Deletes a file from the file system

Parameters

const TDesC & aPath

Enqueue(TFSQActionType, TDesC8 &, const TDesC &, const TDesC &, TFSQSchemaType, const TDesC &, const TDesC &)

TInt Enqueue ( TFSQActionType aActionType,
TDesC8 & aData,
const TDesC & aPath,
const TDesC & aURL,
TFSQSchemaType aSchema,
const TDesC & aUserName,
const TDesC & aPassword
) [private]

Adds one index to the end of each queue.

Parameters

TFSQActionType aActionType
TDesC8 & aData
const TDesC & aPath
const TDesC & aURL
TFSQSchemaType aSchema
const TDesC & aUserName
const TDesC & aPassword

Go()

IMPORT_C TInt Go ( )

Starts the saving thread If iManualStart is not activated, this is essentially a NO-OP

NewL()

IMPORT_C CAsynchFSQ * NewL ( ) [static]

Two-phased constructor.

Notify(TInt)

void Notify ( TInt aError )

Used to indicate a state change from a data atom

Parameters

TInt aError

Rename(const TDesC &, const TDesC &)

IMPORT_C TInt Rename ( const TDesC & aOld,
const TDesC & aNew
)

Renames a file in the file system

Parameters

const TDesC & aOld
const TDesC & aNew

SaveAndDestroy(TDesC8 &, const TDesC &, TBool)

IMPORT_C TInt SaveAndDestroy ( TDesC8 & aData,
const TDesC & aPath,
TBool aOverwrite = ETrue
)

Starts async copy operation

Parameters

TDesC8 & aData
const TDesC & aPath
TBool aOverwrite = ETrue

SetCallback(MAsynchFSQObserver *)

IMPORT_C void SetCallback ( MAsynchFSQObserver * aCallback )

Sets the callback

Parameters

MAsynchFSQObserver * aCallback

SetManualStart(TBool)

IMPORT_C void SetManualStart ( TBool aManualStart )

Notifies the queue that the client wishes to start the thread manually

Parameters

TBool aManualStart

SetPriority(TInt)

IMPORT_C void SetPriority ( TInt aPriority )

Sets the thread priority

Parameters

TInt aPriority

Member Data Documentation

MAsynchFSQObserver * iCallback

MAsynchFSQObserver * iCallback [private]

TBool iManualStart

TBool iManualStart [private]

TBool iOverwrite

TBool iOverwrite [private]

TInt iPriority

TInt iPriority [private]

RPointerArray< CAsynchFSQAtom > iQueue

RPointerArray < CAsynchFSQAtom > iQueue [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.