TTickCountQue Class Reference

#include <e32std.h>

class TTickCountQue : public TDblQueBase

Inherits from

Detailed Description

A class that provides the behaviour for managing a doubly linked list in which elements are added in order of the time until their tick count.

A common use for a list of this type is as a queue of timed events, where the tick counts are the expiry times of the events.

The tick count is defined by the value of the TTickCountQueLink::iTickCount member of the link element.

See also: TTickCountQueLink TTickCountQueLink::iTickCount

Constructor & Destructor Documentation

TTickCountQue ( )

TTickCountQue()

Constructs an empty list header

Member Function Documentation

Add ( TTickCountQueLink & )

voidAdd(TTickCountQueLink &aRef)

Adds the specified list element.

The element is added into the list in order of its tick count.

Parameters
aRefThe list element to be inserted.

First ( )

TTickCountQueLink *First()const

Gets a pointer to the first list element in the doubly linked list.

Return Value
A pointer to the first list element in the doubly linked list. If the list is empty, this pointer is not necessarily NULL and must not be assumed to point to a valid object.

RemoveFirst ( )

TTickCountQueLink *RemoveFirst()

Removes the first list element from the linked list, if any.

Return Value
A pointer to the element removed from the linked list. This is NULL, if the queue is empty.

RemoveFirst ( TUint )

TTickCountQueLink *RemoveFirst(TUintaTickCount)

Removes the first list element from the linked list if its tick count is prior to the current tick count.

Parameters
aTickCountThe current tick count.
Return Value
A pointer to the element removed from the linked list. This is NULL if the first element has yet to expire or the queue is empty.