Collapse all Symbian^3 Application Developer Library

CTask Class Reference

class CTask : public CBase

Holds details about an individual message exchange with a server or CPM.

Inherits from

CTask
- CBase

Public Member Functions
	~CTask ()
TBool	CheckIfSame ( TCFMessage &)
void	Dequeue ()
TBool	GetMsgReturnCode (const TCFMessage &, TInt &)
const TCFMessage &	Message ()
TBool	NeedReply ()
CTask *	NewL (const TCFMessage &, const TUint )
TBool	ReplyMatches (const TCFMessage &)
TUint	TaskId ()

Private Member Functions
	CTask (const TCFMessage &, TUint )

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()

Public Attributes
TDblQueLink	iLink

Private Attributes
TCFMessage	iMessage
TInt	iTaskId

Constructor & Destructor Documentation

CTask(const TCFMessage &, TUint)

CTask	(	const TCFMessage &	aMessage,
		TUint	aTaskId
	)	[private]

Constructor for CTask

Parameters

const TCFMessage & aMessage	the message to be associated with the task
TUint aTaskId	the tasks identifier

~CTask()

~CTask

(

)

Destructor for CTask

Member Functions Documentation

CheckIfSame(TCFMessage &)

TBool

CheckIfSame

(

TCFMessage &

aMessage

)

const

Compares the message code and parameter block of the task's message with the message passed as a parameter and returns the result

Parameters

TCFMessage & aMessage

the comparator

Dequeue()

void

Dequeue

(

)

Remove this from the linked list

GetMsgReturnCode(const TCFMessage &, TInt &)

TBool	GetMsgReturnCode	(	const TCFMessage &	aMessage,
			TInt &	aStatus
		)	[static]

Extracts the result code from the message supplied and returns it in the status parameter

Parameters

const TCFMessage & aMessage	the reply containing the result code
TInt & aStatus	the status to be filled in with the result code

Message()

const TCFMessage &

Message

(

)

const

Accessor method for the message

NeedReply()

TBool

NeedReply

(

)

const

Checks if the task's message should expect to receive a reply from the server or CPM

NewL(const TCFMessage &, const TUint)

CTask *	NewL	(	const TCFMessage &	aMessage,
			const TUint	aTaskId = 0
		)	[static]

Creates new CTask object

leave: KErrNoMemory

Parameters

const TCFMessage & aMessage	the message to be associated with the task
const TUint aTaskId = 0	the tasks identifier

ReplyMatches(const TCFMessage &)

TBool

ReplyMatches

(

const TCFMessage &

aMessage

)

const

Determines if the message passed as a parameter is a reply to this task's message and returns the result

Parameters

const TCFMessage & aMessage

the reply message to test

TaskId()

TUint

TaskId

(

)

const

Accessor method for the task id

Member Data Documentation

TDblQueLink iLink

TDblQueLink

iLink

TCFMessage iMessage

TCFMessage

iMessage

[private]

TInt iTaskId

TInt

iTaskId

[private]