CScheduledTask Class Reference

#include <schtask.h>

Link against: schsvr.lib

class CScheduledTask : public CBase, public CBase

Inherits from

CScheduledTask
- CBase
- CBase

Public Member Functions
	CScheduledTask(TTaskInfo &, HBufC *, TScheduleType, const TSecurityInfo &)
	~CScheduledTask()
IMPORT_C const HBufC &	Data()
void	DecRepeat()
TBool	Due()
void	ExternalizeL(RWriteStream &)
IMPORT_C const TTaskInfo &	Info()
IMPORT_C CScheduledTask *	NewLC(RReadStream &)
TInt	Offset()
void	OnDue(const TTsTime &)
TBool	Persists()
void	Remove()
TInt	ScheduleId()
IMPORT_C TScheduleType	ScheduleType()
IMPORT_C const TSecurityInfo &	SecurityInfo()
void	SetDue(TBool)
void	SetPersists()
void	SetScheduleId(TInt)
IMPORT_C const TTsTime &	ValidUntil()

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

Detailed Description

The representation of a scheduled task that is passed to registered programs.

When tasks are due, the Task Scheduler encapsulates task information within CScheduledTask objects, and externalises them to a direct file store.

The root stream of the direct file store contains a 32 bit value, followed by the external representations of one or more CScheduledTask objects. The 32 bit value is interpreted as a TInt32 and contains the number of CScheduledTask objects that follow in the stream.

The registered program can create successive CScheduledTask objects from this stream using the static NewLC() function.

Constructor & Destructor Documentation

CScheduledTask ( TTaskInfo &, HBufC *, TScheduleType, const TSecurityInfo & )

CScheduledTask	(	TTaskInfo &	aInfo,
		HBufC *	aData,
		TScheduleType	aScheduleType,
		const TSecurityInfo &	aSecurityInfo
	)

~CScheduledTask ( )

~CScheduledTask

(

)

Member Function Documentation

Data ( )

IMPORT_C const HBufC &

Data

(

)

const

Gets a reference to the data to be passed to the program on execution.

Return Value: A reference to the descriptor containing the data.

DecRepeat ( )

void

DecRepeat

(

)

Decrement repeat counter only used by server

Due ( )

TBool

Due

(

)

const

Is this task due? only used by server

ExternalizeL ( RWriteStream & )

void

ExternalizeL

(

RWriteStream &

aStream

)

const

externalize data to stream. only used by server

Info ( )

IMPORT_C const TTaskInfo &

Info

(

)

const

Gets the detailed information for the task.

Return Value: Detailed information about a task.

NewLC ( RReadStream & )

IMPORT_C CScheduledTask *

NewLC

(

RReadStream &

aStream

)

[static]

Creates the object from the specified stream.

Parameters
aStream	The stream containing the external representation of this object.

Return Value: A new instance of a CScheduledTask object.

Offset ( )

TInt

Offset

(

)

[static]

queue offset only used by server

OnDue ( const TTsTime & )

void

OnDue

(

const TTsTime &

aValidUntil

)

Mark task as being due.

Parameters
aValidUntil	time this task will be valid until. This information will be passed to the registered executable, so they may check whether the task should still be executed. only used by server

Persists ( )

TBool

Persists

(

)

const

Return flag that determines if task is transisent or persistent. only used by server

Remove ( )

void

Remove

(

)

Remove from queue only used by server

ScheduleId ( )

TInt

ScheduleId

(

)

const

Gets the schedulesID only used by server

ScheduleType ( )

IMPORT_C TScheduleType

ScheduleType

(

)

const

Gets the schedules type.

SecurityInfo ( )

IMPORT_C const TSecurityInfo &

SecurityInfo

(

)

const

Gets the security information for this scheduled task. This information is the securityID, VenforID and capabilities of the client who created the schedule responsible for invoking this task.

SetDue ( TBool )

void

SetDue

(

TBool

aDue

)

Set due flag. only used by server

SetPersists ( )

void

SetPersists

(

)

Mark task as belonging to a persistent schedule. only used by server

SetScheduleId ( TInt )

void

SetScheduleId

(

TInt

aScheduleId

)

Sets the schedules ID only used by server

ValidUntil ( )

IMPORT_C const TTsTime &

ValidUntil

(

)

const

Gets the time when the task stops being valid.

If the executing program determines that this time is in the past, then it should not run the task.

Return Value: The time when the task stops being valid