Collapse all Symbian^3 Application Developer Library

RTimeout Class Reference

class RTimeout

The timeout handle.

This can be a member of any object that needs timeout events.

The RTimeout can be used as a base for derived classes.

Public Member Functions
	RTimeout ( TimeoutCallback )
void	Cancel ()
TBool	IsActive ()
void	Set ( MTimeoutManager *, TUint )

Private Attributes
TUint	iDelta
const TimeoutCallback	iExpired
RTimeout *	iNext
RTimeout *	iPrev

Constructor & Destructor Documentation

RTimeout(TimeoutCallback)

RTimeout

(

TimeoutCallback

aCallback

)

[inline]

Contructor.

Parameters

TimeoutCallback aCallback

the expire callback function

Member Functions Documentation

Cancel()

void

Cancel

(

)

[inline]

Cancel timeout.

Cancel removes the timeout (if any) from this link. No Expired() call will happen as a result of this.

IsActive()

TBool

IsActive

(

)

const [inline]

Tests if the timeout is active.

Note:

It is always safe to just add the link to a new time manager. Add will implicitly cancel any previous setting, if such exists.

Set(MTimeoutManager *, TUint)

void	Set	(	MTimeoutManager *	aMgr,
			TUint	aTime
		)	[inline]

Activate timeout callback after the specified time.

Just an alternate way of calling MTimeoutManager::Set .

Parameters

MTimeoutManager * aMgr	The timeout manager.
TUint aTime	The time (in fraction of second units).

Member Data Documentation

TUint iDelta

TUint

iDelta

[private]

const TimeoutCallback iExpired

const TimeoutCallback

iExpired

[private]

RTimeout * iNext

RTimeout *

iNext

[private]

RTimeout * iPrev

RTimeout *

iPrev

[private]