CDeltaTimer Class Reference

#include <e32base.h>

Link against: euser_v5.lib

class CDeltaTimer : public CActive

Inherits from

CDeltaTimer
- CActive
  - CBase

Public Member Functions
	~CDeltaTimer()
IMPORT_C CDeltaTimer *	NewL(TInt)
IMPORT_C CDeltaTimer *	NewL(TInt, TTimeIntervalMicroSeconds32)
virtual IMPORT_C void	Queue(TTimeIntervalMicroSeconds32, TDeltaTimerEntry &)
IMPORT_C TInt	QueueLong(TTimeIntervalMicroSeconds, TDeltaTimerEntry &)
virtual IMPORT_C void	Remove(TDeltaTimerEntry &)

Inherited Attributes
	CActive::iStatus

Inherited Enumerations
	CActive:TPriority

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::RunError(TInt)
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	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

A queue of timed events.

A timed event is a callback function encapsulated by a TDeltaTimerEntry object, and is intended to be called when the time interval represented by the event expires.

The queue itself is a TDeltaQue list. A timed event entry is added into a position in the queue that is determined by the time interval specified for that event. Although the time interval for a timed event is specified as an interval from the present moment, when added to the queue the implementation treats each event as having an interval from the previous timed event (or now).

CDeltaTimer is an active object, driven by an RTimer which is usually set to expire upon completion of the event at the head of the queue. If the time to the next event is too great or an event at the head of the queue has been removed, the timer may be set to expire prior to the event at the head of the queue (if any).

When the timer completes, the head of the queue is inspected to see whether the timed event at the head of the queue has expired. On expiry, the callback function represented by that timed event is called, and the timed event entry is removed from the queue. The queue then inspects further events for expiry, calling and removing them as necessary until either the queue is empty or there is an event in the future to wait for.

Note that the tick period is the minimum time interval for an event and the granularity of all timings using the queue. Note that in general, any event may be called back some time after it has expired and that specifically the duration of all events will at least be rounded up to a muliple of the tick period.

Constructor & Destructor Documentation

~CDeltaTimer ( )

~CDeltaTimer

(

)

Destructor.

Frees all resources before destruction of the object. Specifically, it cancels any outstanding timer requests generated by the RTimer object and then deletes all timed event entries from the timed event queue.

Member Function Documentation

NewL ( TInt )

IMPORT_C CDeltaTimer *

NewL

(

TInt

aPriority

)

[static]

Creates a new timed event queue with the specified active object priority.

Parameters
aPriority	The priority of this active object.

Return Value: On successful return, a pointer to the queue of timed events.

NewL ( TInt, TTimeIntervalMicroSeconds32 )

IMPORT_C CDeltaTimer *	NewL	(	TInt	aPriority,
			TTimeIntervalMicroSeconds32	aGranularity
		)	[static]

Creates a new timed event queue with the specified active object priority, and the specified timer granularity.

Deprecated

Parameters
aPriority	The priority of this active object.
aGranularity	Ignored. The resolution of the timer is the tick period.

Return Value: On successful return, a pointer to the queue of timed events.

Queue ( TTimeIntervalMicroSeconds32, TDeltaTimerEntry & )

IMPORT_C void	Queue	(	TTimeIntervalMicroSeconds32	aTimeInMicroSeconds,
			TDeltaTimerEntry &	aEntry
		)	[virtual]

Adds a new timed event entry into the timed event queue.

Parameters
aTimeInMicroSeconds	The interval from the present time when the timed event entry is to expire.
aEntry	The timed event entry encapsulating the call back that is to be called when this timed event entry expires.

QueueLong ( TTimeIntervalMicroSeconds, TDeltaTimerEntry & )

IMPORT_C TInt	QueueLong	(	TTimeIntervalMicroSeconds	aTimeInMicroSeconds,
			TDeltaTimerEntry &	aEntry
		)

Adds a new timed event entry into the timed event queue.

Parameters
aTimeInMicroSeconds	The interval from the present time when the timed event entry is to expire.
aEntry	The timed event entry encapsulating the call back that is to be called when this timed event entry expires.

Return Value: KErrNone if sucessful, KErrOverflow if the interval is too great or negative.

Remove ( TDeltaTimerEntry & )

IMPORT_C void

Remove

(

TDeltaTimerEntry &

aEntry

)

[virtual]

Removes the specified timed event entry from the timer queue.

Parameters
aEntry	The timed event entry.