template < class Msg > class TimerContainer : public Vocal IO Writer

An ordered list of TimerEntries

Inheritance:


Public Methods

TimerEntryId add(Sptr < Msg >, milliseconds_t relativeTime)
Add a new message to the timer
bool cancel(TimerEntryId)
Cancel a delayed event
TimerEntryId getFirstTimerEntryId()
Returns the identifier of the first entry
Sptr < Msg > getMessage() throw( VMissingDataException )
Returns the first message available
int getTimeout()
Get the timeout value for the first available message
bool messageAvailable()
Returns true if a message is available
unsigned int size()
Return the number of all the pending events in the TimerContainer
TimerContainer()
Default constructor
ostream& writeTo(ostream & out)
Write a TimerContainer to an ostream
virtual ~TimerContainer()
Virtual destructor

Inherited from Writer:


Documentation

An ordered list of TimerEntries. This list is a list of events and the time those events expire.

TimerContainer()
Default constructor

virtual ~TimerContainer()
Virtual destructor

TimerEntryId add(Sptr < Msg >, milliseconds_t relativeTime)
Add a new message to the timer

bool cancel(TimerEntryId)
Cancel a delayed event. Returns true is id was found, and false otherwise.

int getTimeout()
Get the timeout value for the first available message. Returns -1 if no messages available (conveying infinite timeout).

TimerEntryId getFirstTimerEntryId()
Returns the identifier of the first entry

bool messageAvailable()
Returns true if a message is available

Sptr < Msg > getMessage() throw( VMissingDataException )
Returns the first message available. Throws a status exception if no messages are available.

ostream& writeTo(ostream & out)
Write a TimerContainer to an ostream

unsigned int size()
Return the number of all the pending events in the TimerContainer


This class has no child classes.
See Also:
Vocal::TimeAndDate::TimerEntry

alphabetic index hierarchy of classes


generated by doc++