RScheduler Class Reference

class RScheduler : public RSessionBase

Client side interface to the Task Scheduler.

Inherits from

Public Member Functions
RScheduler()
IMPORT_C TIntConnect()
IMPORT_C TIntCreatePersistentSchedule(TSchedulerItemRef &, const CArrayFixFlat< TScheduleEntryInfo2 > &)
IMPORT_C TIntCreatePersistentSchedule(TSchedulerItemRef &, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTsTime &)
IMPORT_C TIntCreatePersistentSchedule(TSchedulerItemRef &, const CArrayFixFlat< TScheduleEntryInfo > &)
IMPORT_C TIntCreatePersistentSchedule(TSchedulerItemRef &, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTime &)
IMPORT_C TIntDeleteSchedule(const TInt)
IMPORT_C TIntDeleteTask(const TInt)
IMPORT_C TIntDisableSchedule(const TInt)
IMPORT_C TIntEditSchedule(const TInt, const CArrayFixFlat< TScheduleEntryInfo2 > &)
IMPORT_C TIntEditSchedule(TInt, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTsTime &)
IMPORT_C TIntEditSchedule(const TInt, const CArrayFixFlat< TScheduleEntryInfo > &)
IMPORT_C TIntEditSchedule(TInt, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTime &)
IMPORT_C TIntEnableSchedule(const TInt)
IMPORT_C TIntGetScheduleL(const TInt, TScheduleState2 &, CArrayFixFlat< TScheduleEntryInfo2 > &, CArrayFixFlat< TTaskInfo > &, TTsTime &)
IMPORT_C TIntGetScheduleL(TInt, TScheduleState2 &, CArrayFixFlat< TTaskSchedulerCondition > &, TTsTime &, CArrayFixFlat< TTaskInfo > &)
IMPORT_C TIntGetScheduleL(const TInt, TScheduleState &, CArrayFixFlat< TScheduleEntryInfo > &, CArrayFixFlat< TTaskInfo > &, TTime &)
IMPORT_C TIntGetScheduleL(TInt, TScheduleState &, CArrayFixFlat< TTaskSchedulerCondition > &, TTime &, CArrayFixFlat< TTaskInfo > &)
IMPORT_C TIntGetScheduleRefsL(CArrayFixFlat< TSchedulerItemRef > &, const TScheduleFilter)
IMPORT_C TIntGetScheduleTypeL(TInt, TScheduleType &)
IMPORT_C TIntGetTaskDataSize(const TInt, TInt &)
IMPORT_C TIntGetTaskInfoL(const TInt, TTaskInfo &, TPtr &, TSchedulerItemRef &, TTsTime &)
IMPORT_C TIntGetTaskInfoL(const TInt, TTaskInfo &, TPtr &, TSchedulerItemRef &, TTime &)
IMPORT_C TIntGetTaskRefsL(CArrayFixFlat< TSchedulerItemRef > &, const TScheduleFilter, const TTaskFilter)
IMPORT_C TIntRegister(const TFileName &, const TInt)
IMPORT_C TIntScheduleTask(TTaskInfo &, HBufC &, const TInt)
IMPORT_C TIntScheduleTask(TTaskInfo &, HBufC &, TSchedulerItemRef &, const CArrayFixFlat< TScheduleEntryInfo2 > &)
IMPORT_C TIntScheduleTask(TTaskInfo &, HBufC &, TSchedulerItemRef &, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTsTime &)
IMPORT_C TIntScheduleTask(TTaskInfo &, HBufC &, TSchedulerItemRef &, const CArrayFixFlat< TScheduleEntryInfo > &)
IMPORT_C TIntScheduleTask(TTaskInfo &, HBufC &, TSchedulerItemRef &, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTime &)
IMPORT_C TVersionVersion()
IMPORT_C TInt__DbgCheckHeap(TInt)
IMPORT_C TInt__DbgFailNext(TInt)
IMPORT_C TInt__DbgMarkEnd(TInt)
IMPORT_C TInt__DbgMarkHeap()
IMPORT_C TInt__DbgResetHeap()
IMPORT_C TInt__FaultServer()
Private Member Functions
TInt CreateSchedule(TSchedulerItemRef &, const CArrayFixFlat< TScheduleEntryInfo2 > &, const TScheduleSettings2 &)
TInt CreateSchedule(TSchedulerItemRef &, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTsTime &, const TScheduleSettings2 &)
TInt GetScheduleDataL(const TInt, const TScheduleInfo &, CArrayFixFlat< TScheduleEntryInfo2 > &)
TInt GetScheduleDataL(const TInt, const TScheduleInfo &, CArrayFixFlat< TTaskSchedulerCondition > &, TTsTime &)
TInt GetScheduleInfo(const TInt, TScheduleInfo &, TTsTime &)
TInt GetTaskDataL(const TInt, const TScheduleInfo &, CArrayFixFlat< TTaskInfo > &)
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::Close()
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RSessionBase::CreateSession(RServer2,const TVersion &)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Open(TInt,TOwnerType)
RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Send(TInt)const
RSessionBase::Send(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt)const
RSessionBase::SendReceive(TInt,TRequestStatus &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSessionBase::SetReturnedHandle(TInt)
RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
RSessionBase::ShareAuto()
RSessionBase::ShareProtected()
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RScheduler()

IMPORT_CRScheduler()

Member Functions Documentation

Connect()

IMPORT_C TIntConnect()

CreatePersistentSchedule(TSchedulerItemRef &, const CArrayFixFlat< TScheduleEntryInfo2 > &)

IMPORT_C TIntCreatePersistentSchedule(TSchedulerItemRef &aRef,
const CArrayFixFlat< TScheduleEntryInfo2 > &aEntryList
)

Parameters

TSchedulerItemRef & aRef
const CArrayFixFlat< TScheduleEntryInfo2 > & aEntryList

CreatePersistentSchedule(TSchedulerItemRef &, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTsTime &)

IMPORT_C TIntCreatePersistentSchedule(TSchedulerItemRef &aRef,
const CArrayFixFlat< TTaskSchedulerCondition > &aConditions,
const TTsTime &aDefaultRunTime
)

Parameters

TSchedulerItemRef & aRef
const CArrayFixFlat< TTaskSchedulerCondition > & aConditions
const TTsTime & aDefaultRunTime

CreatePersistentSchedule(TSchedulerItemRef &, const CArrayFixFlat< TScheduleEntryInfo > &)

IMPORT_C TIntCreatePersistentSchedule(TSchedulerItemRef &aRef,
const CArrayFixFlat< TScheduleEntryInfo > &aEntryList
)

Parameters

TSchedulerItemRef & aRef
const CArrayFixFlat< TScheduleEntryInfo > & aEntryList

CreatePersistentSchedule(TSchedulerItemRef &, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTime &)

IMPORT_C TIntCreatePersistentSchedule(TSchedulerItemRef &aRef,
const CArrayFixFlat< TTaskSchedulerCondition > &aConditions,
const TTime &aDefaultRunTime
)

Parameters

TSchedulerItemRef & aRef
const CArrayFixFlat< TTaskSchedulerCondition > & aConditions
const TTime & aDefaultRunTime

CreateSchedule(TSchedulerItemRef &, const CArrayFixFlat< TScheduleEntryInfo2 > &, const TScheduleSettings2 &)

TInt CreateSchedule(TSchedulerItemRef &aRef,
const CArrayFixFlat< TScheduleEntryInfo2 > &aEntryList,
const TScheduleSettings2 &aSettings
)[private]

Parameters

TSchedulerItemRef & aRef
const CArrayFixFlat< TScheduleEntryInfo2 > & aEntryList
const TScheduleSettings2 & aSettings

CreateSchedule(TSchedulerItemRef &, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTsTime &, const TScheduleSettings2 &)

TInt CreateSchedule(TSchedulerItemRef &aRef,
const CArrayFixFlat< TTaskSchedulerCondition > &aConditions,
const TTsTime &aDefaultRunTime,
const TScheduleSettings2 &aSettings
)[private]

Parameters

TSchedulerItemRef & aRef
const CArrayFixFlat< TTaskSchedulerCondition > & aConditions
const TTsTime & aDefaultRunTime
const TScheduleSettings2 & aSettings

DeleteSchedule(const TInt)

IMPORT_C TIntDeleteSchedule(const TIntaScheduleHandle)const

Parameters

const TInt aScheduleHandle

DeleteTask(const TInt)

IMPORT_C TIntDeleteTask(const TIntaTaskId)const

Parameters

const TInt aTaskId

DisableSchedule(const TInt)

IMPORT_C TIntDisableSchedule(const TIntaScheduleHandle)const

Parameters

const TInt aScheduleHandle

EditSchedule(const TInt, const CArrayFixFlat< TScheduleEntryInfo2 > &)

IMPORT_C TIntEditSchedule(const TIntaScheduleHandle,
const CArrayFixFlat< TScheduleEntryInfo2 > &aEntryList
)

Parameters

const TInt aScheduleHandle
const CArrayFixFlat< TScheduleEntryInfo2 > & aEntryList

EditSchedule(TInt, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTsTime &)

IMPORT_C TIntEditSchedule(TIntaScheduleHandle,
const CArrayFixFlat< TTaskSchedulerCondition > &aConditions,
const TTsTime &aDefaultRunTime
)

Parameters

TInt aScheduleHandle
const CArrayFixFlat< TTaskSchedulerCondition > & aConditions
const TTsTime & aDefaultRunTime

EditSchedule(const TInt, const CArrayFixFlat< TScheduleEntryInfo > &)

IMPORT_C TIntEditSchedule(const TIntaScheduleHandle,
const CArrayFixFlat< TScheduleEntryInfo > &aEntryList
)

Parameters

const TInt aScheduleHandle
const CArrayFixFlat< TScheduleEntryInfo > & aEntryList

EditSchedule(TInt, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTime &)

IMPORT_C TIntEditSchedule(TIntaScheduleHandle,
const CArrayFixFlat< TTaskSchedulerCondition > &aConditions,
const TTime &aDefaultRunTime
)

Parameters

TInt aScheduleHandle
const CArrayFixFlat< TTaskSchedulerCondition > & aConditions
const TTime & aDefaultRunTime

EnableSchedule(const TInt)

IMPORT_C TIntEnableSchedule(const TIntaScheduleHandle)const

Parameters

const TInt aScheduleHandle

GetScheduleDataL(const TInt, const TScheduleInfo &, CArrayFixFlat< TScheduleEntryInfo2 > &)

TInt GetScheduleDataL(const TIntaScheduleHandle,
const TScheduleInfo &aInfo,
CArrayFixFlat< TScheduleEntryInfo2 > &aEntries
)[private]

Parameters

const TInt aScheduleHandle
const TScheduleInfo & aInfo
CArrayFixFlat< TScheduleEntryInfo2 > & aEntries

GetScheduleDataL(const TInt, const TScheduleInfo &, CArrayFixFlat< TTaskSchedulerCondition > &, TTsTime &)

TInt GetScheduleDataL(const TIntaScheduleHandle,
const TScheduleInfo &aInfo,
CArrayFixFlat< TTaskSchedulerCondition > &aConditions,
TTsTime &aDefaultRunTime
)[private]

Parameters

const TInt aScheduleHandle
const TScheduleInfo & aInfo
CArrayFixFlat< TTaskSchedulerCondition > & aConditions
TTsTime & aDefaultRunTime

GetScheduleInfo(const TInt, TScheduleInfo &, TTsTime &)

TInt GetScheduleInfo(const TIntaScheduleHandle,
TScheduleInfo &aInfo,
TTsTime &aNextDue
)[private]

Parameters

const TInt aScheduleHandle
TScheduleInfo & aInfo
TTsTime & aNextDue

GetScheduleL(const TInt, TScheduleState2 &, CArrayFixFlat< TScheduleEntryInfo2 > &, CArrayFixFlat< TTaskInfo > &, TTsTime &)

IMPORT_C TIntGetScheduleL(const TIntaScheduleHandle,
TScheduleState2 &aState,
CArrayFixFlat< TScheduleEntryInfo2 > &aEntries,
CArrayFixFlat< TTaskInfo > &aTasks,
TTsTime &aDueTime
)

Parameters

const TInt aScheduleHandle
TScheduleState2 & aState
CArrayFixFlat< TScheduleEntryInfo2 > & aEntries
CArrayFixFlat< TTaskInfo > & aTasks
TTsTime & aDueTime

GetScheduleL(TInt, TScheduleState2 &, CArrayFixFlat< TTaskSchedulerCondition > &, TTsTime &, CArrayFixFlat< TTaskInfo > &)

IMPORT_C TIntGetScheduleL(TIntaScheduleHandle,
TScheduleState2 &aState,
CArrayFixFlat< TTaskSchedulerCondition > &aConditions,
TTsTime &aDefaultRunTime,
CArrayFixFlat< TTaskInfo > &aTasks
)

Parameters

TInt aScheduleHandle
TScheduleState2 & aState
CArrayFixFlat< TTaskSchedulerCondition > & aConditions
TTsTime & aDefaultRunTime
CArrayFixFlat< TTaskInfo > & aTasks

GetScheduleL(const TInt, TScheduleState &, CArrayFixFlat< TScheduleEntryInfo > &, CArrayFixFlat< TTaskInfo > &, TTime &)

IMPORT_C TIntGetScheduleL(const TIntaScheduleHandle,
TScheduleState &aState,
CArrayFixFlat< TScheduleEntryInfo > &aEntries,
CArrayFixFlat< TTaskInfo > &aTasks,
TTime &aDueTime
)

Parameters

const TInt aScheduleHandle
TScheduleState & aState
CArrayFixFlat< TScheduleEntryInfo > & aEntries
CArrayFixFlat< TTaskInfo > & aTasks
TTime & aDueTime

GetScheduleL(TInt, TScheduleState &, CArrayFixFlat< TTaskSchedulerCondition > &, TTime &, CArrayFixFlat< TTaskInfo > &)

IMPORT_C TIntGetScheduleL(TIntaScheduleHandle,
TScheduleState &aState,
CArrayFixFlat< TTaskSchedulerCondition > &aConditions,
TTime &aDefaultRunTime,
CArrayFixFlat< TTaskInfo > &aTasks
)

Parameters

TInt aScheduleHandle
TScheduleState & aState
CArrayFixFlat< TTaskSchedulerCondition > & aConditions
TTime & aDefaultRunTime
CArrayFixFlat< TTaskInfo > & aTasks

GetScheduleRefsL(CArrayFixFlat< TSchedulerItemRef > &, const TScheduleFilter)

IMPORT_C TIntGetScheduleRefsL(CArrayFixFlat< TSchedulerItemRef > &aScheduleRefArray,
const TScheduleFilteraFilter
)

Parameters

CArrayFixFlat< TSchedulerItemRef > & aScheduleRefArray
const TScheduleFilter aFilter

GetScheduleTypeL(TInt, TScheduleType &)

IMPORT_C TIntGetScheduleTypeL(TIntaScheduleHandle,
TScheduleType &aScheduleType
)

Parameters

TInt aScheduleHandle
TScheduleType & aScheduleType

GetTaskDataL(const TInt, const TScheduleInfo &, CArrayFixFlat< TTaskInfo > &)

TInt GetTaskDataL(const TIntaScheduleHandle,
const TScheduleInfo &aInfo,
CArrayFixFlat< TTaskInfo > &aTasks
)[private]

Parameters

const TInt aScheduleHandle
const TScheduleInfo & aInfo
CArrayFixFlat< TTaskInfo > & aTasks

GetTaskDataSize(const TInt, TInt &)

IMPORT_C TIntGetTaskDataSize(const TIntaTaskId,
TInt &aSize
)

Parameters

const TInt aTaskId
TInt & aSize

GetTaskInfoL(const TInt, TTaskInfo &, TPtr &, TSchedulerItemRef &, TTsTime &)

IMPORT_C TIntGetTaskInfoL(const TIntaTaskId,
TTaskInfo &aTaskInfo,
TPtr &aTaskData,
TSchedulerItemRef &aRef,
TTsTime &aNextDue
)

Parameters

const TInt aTaskId
TTaskInfo & aTaskInfo
TPtr & aTaskData
TSchedulerItemRef & aRef
TTsTime & aNextDue

GetTaskInfoL(const TInt, TTaskInfo &, TPtr &, TSchedulerItemRef &, TTime &)

IMPORT_C TIntGetTaskInfoL(const TIntaTaskId,
TTaskInfo &aTaskInfo,
TPtr &aTaskData,
TSchedulerItemRef &aRef,
TTime &aNextDue
)

Parameters

const TInt aTaskId
TTaskInfo & aTaskInfo
TPtr & aTaskData
TSchedulerItemRef & aRef
TTime & aNextDue

GetTaskRefsL(CArrayFixFlat< TSchedulerItemRef > &, const TScheduleFilter, const TTaskFilter)

IMPORT_C TIntGetTaskRefsL(CArrayFixFlat< TSchedulerItemRef > &aTasks,
const TScheduleFilteraScheduleFilter,
const TTaskFilteraTaskFilter
)

Parameters

CArrayFixFlat< TSchedulerItemRef > & aTasks
const TScheduleFilter aScheduleFilter
const TTaskFilter aTaskFilter

Register(const TFileName &, const TInt)

IMPORT_C TIntRegister(const TFileName &aFileName,
const TIntaPriority
)

Parameters

const TFileName & aFileName
const TInt aPriority

ScheduleTask(TTaskInfo &, HBufC &, const TInt)

IMPORT_C TIntScheduleTask(TTaskInfo &aTaskInfo,
HBufC &aTaskData,
const TIntaScheduleHandle
)

Parameters

TTaskInfo & aTaskInfo
HBufC & aTaskData
const TInt aScheduleHandle

ScheduleTask(TTaskInfo &, HBufC &, TSchedulerItemRef &, const CArrayFixFlat< TScheduleEntryInfo2 > &)

IMPORT_C TIntScheduleTask(TTaskInfo &aTaskInfo,
HBufC &aTaskData,
TSchedulerItemRef &aRef,
const CArrayFixFlat< TScheduleEntryInfo2 > &aEntryList
)

Parameters

TTaskInfo & aTaskInfo
HBufC & aTaskData
TSchedulerItemRef & aRef
const CArrayFixFlat< TScheduleEntryInfo2 > & aEntryList

ScheduleTask(TTaskInfo &, HBufC &, TSchedulerItemRef &, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTsTime &)

IMPORT_C TIntScheduleTask(TTaskInfo &aTaskInfo,
HBufC &aTaskData,
TSchedulerItemRef &aRef,
const CArrayFixFlat< TTaskSchedulerCondition > &aConditions,
const TTsTime &aDefaultRunTime
)

Parameters

TTaskInfo & aTaskInfo
HBufC & aTaskData
TSchedulerItemRef & aRef
const CArrayFixFlat< TTaskSchedulerCondition > & aConditions
const TTsTime & aDefaultRunTime

ScheduleTask(TTaskInfo &, HBufC &, TSchedulerItemRef &, const CArrayFixFlat< TScheduleEntryInfo > &)

IMPORT_C TIntScheduleTask(TTaskInfo &aTaskInfo,
HBufC &aTaskData,
TSchedulerItemRef &aRef,
const CArrayFixFlat< TScheduleEntryInfo > &aEntryList
)

Parameters

TTaskInfo & aTaskInfo
HBufC & aTaskData
TSchedulerItemRef & aRef
const CArrayFixFlat< TScheduleEntryInfo > & aEntryList

ScheduleTask(TTaskInfo &, HBufC &, TSchedulerItemRef &, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTime &)

IMPORT_C TIntScheduleTask(TTaskInfo &aTaskInfo,
HBufC &aTaskData,
TSchedulerItemRef &aRef,
const CArrayFixFlat< TTaskSchedulerCondition > &aConditions,
const TTime &aDefaultRunTime
)

Parameters

TTaskInfo & aTaskInfo
HBufC & aTaskData
TSchedulerItemRef & aRef
const CArrayFixFlat< TTaskSchedulerCondition > & aConditions
const TTime & aDefaultRunTime

Version()

IMPORT_C TVersionVersion()const

__DbgCheckHeap(TInt)

IMPORT_C TInt__DbgCheckHeap(TIntaCount)

Parameters

TInt aCount

__DbgFailNext(TInt)

IMPORT_C TInt__DbgFailNext(TIntaCount)

Parameters

TInt aCount

__DbgMarkEnd(TInt)

IMPORT_C TInt__DbgMarkEnd(TIntaCount)

Parameters

TInt aCount

__DbgMarkHeap()

IMPORT_C TInt__DbgMarkHeap()

__DbgResetHeap()

IMPORT_C TInt__DbgResetHeap()

__FaultServer()

IMPORT_C TInt__FaultServer()