CPeriodic Class Reference

class CPeriodic : public CTimer

Periodic timer active object.

This class generates regular timer events and handles them with a callback function. The callback is specified as a parameter to Start().

The callback may not be called immediately after the signal from the timer request has been generated, for the following reasons:

1. the RunL() of another active object may be running at the time of the signal

2. other active objects may have a higher priority than the CPeriodic

If timing accuracy is important to your application, you can minimise the first problem by ensuring all RunL()s complete quickly, and can eliminate the second by giving the CPeriodic a higher priority than any other active object. Although it is generally recommended that timer-related active objects have a high priority, this will not address the problem of CPeriodic timers running behind, because active object scheduling is not pre-emptive.

After a timer signal generated by a CPeriodic, the next signal is requested just before running the callback, and this request can be delayed for the same reasons that running the callback can be delayed. Therefore, a large number N of periods may add up to somewhat more than N times the requested period time. If absolute precision is required in tracking time, do not rely on counting the number of times the callback is called: read the value of the system clock every time you need it.

For many applications, such precision is not required, for example, tick counting is sufficiently accurate for controlling time-outs in a communications program.

Note that you should be familiar with CActive in order to understand CPeriodic behaviour, but not necessarily with CTimer.

CHeartbeat

Inherits from

Constructor & Destructor Documentation

CPeriodic(TInt)

IMPORT_CCPeriodic(TIntaPriority)[protected]

Parameters

TInt aPriority

~CPeriodic()

IMPORT_C~CPeriodic()

Member Functions Documentation

New(TInt)

IMPORT_C CPeriodic *New(TIntaPriority)[static]

Parameters

TInt aPriority

NewL(TInt)

IMPORT_C CPeriodic *NewL(TIntaPriority)[static]

Parameters

TInt aPriority

RunL()

IMPORT_C voidRunL()[protected, virtual]

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's RunL() or RunError() functions.

CActiveScheduler::Start

CActiveScheduler::Error

CActiveScheduler::WaitForAnyRequest

TRAPD

Start(TTimeIntervalMicroSeconds32, TTimeIntervalMicroSeconds32, TCallBack)

IMPORT_C voidStart(TTimeIntervalMicroSeconds32aDelay,
TTimeIntervalMicroSeconds32anInterval,
TCallBackaCallBack
)

Member Data Documentation

TCallBack iCallBack

TCallBack iCallBack[private]

TTimeIntervalMicroSeconds32 iInterval

TTimeIntervalMicroSeconds32 iInterval[private]