Eris 1.3.16
|
#include <Timeout.h>
Public Member Functions | |
Timeout (unsigned long milli) | |
standard constructor for new timeouts | |
Timeout & | operator= (const Timeout &t) |
assignment operator | |
void | extend (unsigned long msec) |
Extend the timeout termination by the specified time. | |
void | reset (unsigned long msec) |
reset the timeout to the specified time, and reset the 'expired' flag. | |
void | cancel () |
cancel the Timeout immediately | |
bool | isExpired () const |
test whether or not the timeout has fired or not | |
virtual void | expired () |
Implement the expiry behaviour of this object. | |
virtual const WFMath::TimeStamp & | due () const |
The time value when this event is due. | |
Public Attributes | |
sigc::signal< void > | Expired |
The timeout signal. | |
Protected Attributes | |
WFMath::TimeStamp | _due |
interval at which the timeout is due | |
bool | _fired |
flag if the timeout has expired |
Eris::Timeout::Timeout | ( | unsigned long | milli | ) |
standard constructor for new timeouts
label | The unique timeout identification label |
milli | The initial timeout value, in milliseconds |
References _due.
void Eris::Timeout::expired | ( | ) | [virtual] |
Implement the expiry behaviour of this object.
The TimedEvent is automatically removed from the service before this method is called, so deleting the object, or re-registering it are permitted.
Implements Eris::TimedEvent.
void Eris::Timeout::extend | ( | unsigned long | msec | ) |
Extend the timeout termination by the specified time.
This has no effect if the timeout has already fired
msec | The interval to extend the timeout by, in milliseconds |
References _due.
void Eris::Timeout::reset | ( | unsigned long | msec | ) |