Collapse all Symbian^3 Product Developer Library

CJob Class Reference

class CJob : public CBase

Manages an asynchronous call from the rootserver into bindmanager, including monitoring a list of individual tasks associated with the job, and dealing with a timeout if a task fails to complete

Inherits from

CJob
- CBase

Nested Classes and Structures

CJob::TTaskData

Public Member Functions
	~CJob()
void	AddTaskL(TUint, const TCFModuleNameF &)
void	Cancel()
void	Dequeue()
TBool	HasStatus(const TRequestStatus &)
void	ModuleTimerShot()
CJob *	NewL(TRequestStatus &, MBindManagerNotify *)
void	StartTimeout(TUint)
void	TaskCompleted(const TCFModuleNameF &, const TUint, const TInt)

Private Member Functions
	CJob(TRequestStatus &, MBindManagerNotify *)
void	ConstructL()

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
MBindManagerNotify *	iBindManager
TBool	iCancelled
TInt	iCompletionCode
TRequestStatus &	iRsStatus
RArray< TTaskData >	iTaskDataList
CJobTimeout *	iTimeout

Constructor & Destructor Documentation

CJob(TRequestStatus &, MBindManagerNotify *)

CJob	(	TRequestStatus &	aRsStatus,
		MBindManagerNotify *	aBindManager
	)	[private]

Constructor for CJob

Parameters

TRequestStatus & aRsStatus	the TRequestStatus to complete when the job is finished
MBindManagerNotify * aBindManager	the object to notify of timeout

~CJob()

~CJob

(

)

Destructor for CJob

Member Functions Documentation

AddTaskL(TUint, const TCFModuleNameF &)

void	AddTaskL	(	TUint	aTaskId,
			const TCFModuleNameF &	aModule
		)

Add a task to this job

leave: KErrNoMemory

Parameters

TUint aTaskId	the task identifier to add
const TCFModuleNameF & aModule	the name of the module which owns the task

Cancel()

void

Cancel

(

)

Cancels the job

ConstructL()

void

ConstructL

(

)

[private]

Second phase constructor for CJob

Dequeue()

void

Dequeue

(

)

Remove this from the linked list

HasStatus(const TRequestStatus &)

TBool

HasStatus

(

const TRequestStatus &

aRsStatus

)

const

Indicates whether this job will complete the supplied status request when the job completes

Parameters

const TRequestStatus & aRsStatus

the comparator

ModuleTimerShot()

void

ModuleTimerShot

(

)

[virtual]

Virtual method called by timeout member

NewL(TRequestStatus &, MBindManagerNotify *)

CJob *	NewL	(	TRequestStatus &	iRsStatus,
			MBindManagerNotify *	aBindManager
		)	[static]

Creates new CJob object

leave: KErrNoMemory

Parameters

TRequestStatus & iRsStatus	the TRequestStatus to complete when the job is finished
MBindManagerNotify * aBindManager	the object to notify of timeout

StartTimeout(TUint)

void

StartTimeout

(

TUint

aMicroseconds

)

Start the timeout for this job

Parameters

TUint aMicroseconds

the length of the timeout

TaskCompleted(const TCFModuleNameF &, const TUint, const TInt)

void	TaskCompleted	(	const TCFModuleNameF &	aModuleName,
			const TUint	aTaskId,
			const TInt	aStatus
		)

Method called by bindmanager when a task is completed. If all of the tasks on a job complete then the client's request will be completed and the job deleted

Parameters

const TCFModuleNameF & aModuleName	the name of the module that owns the completed task
const TUint aTaskId	the identifier of the completed task
const TInt aStatus	the completion code for the task