Symbian^3 Product 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 TIntActionsLeft()
IMPORT_C voidCancel()
IMPORT_C TIntDelete(const TDesC &)
IMPORT_C TIntGo()
IMPORT_C CAsynchFSQ *NewL()
voidNotify(TInt)
IMPORT_C TIntRename(const TDesC &, const TDesC &)
IMPORT_C TIntSaveAndDestroy(TDesC8 &, const TDesC &, TBool)
IMPORT_C voidSetCallback(MAsynchFSQObserver *)
IMPORT_C voidSetManualStart(TBool)
IMPORT_C voidSetPriority(TInt)
Private Member Functions
CAsynchFSQ()
voidConstructL()
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 TIntActionsLeft()

Returns the number of actions left for the queue to perform

Cancel()

IMPORT_C voidCancel()

Cancels any ongoing activity and clears the threads.

ConstructL()

voidConstructL()[private]

By default Symbian 2nd phase constructor is private.

Delete(const TDesC &)

IMPORT_C TIntDelete(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(TFSQActionTypeaActionType,
TDesC8 &aData,
const TDesC &aPath,
const TDesC &aURL,
TFSQSchemaTypeaSchema,
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 TIntGo()

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)

voidNotify(TIntaError)

Used to indicate a state change from a data atom

Parameters

TInt aError

Rename(const TDesC &, const TDesC &)

IMPORT_C TIntRename(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 TIntSaveAndDestroy(TDesC8 &aData,
const TDesC &aPath,
TBoolaOverwrite = ETrue
)

Starts async copy operation

Parameters

TDesC8 & aData
const TDesC & aPath
TBool aOverwrite = ETrue

SetCallback(MAsynchFSQObserver *)

IMPORT_C voidSetCallback(MAsynchFSQObserver *aCallback)

Sets the callback

Parameters

MAsynchFSQObserver * aCallback

SetManualStart(TBool)

IMPORT_C voidSetManualStart(TBoolaManualStart)

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

Parameters

TBool aManualStart

SetPriority(TInt)

IMPORT_C voidSetPriority(TIntaPriority)

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.