libassa  3.5.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Private Attributes | List of all members
ASSA::Timer Class Reference

#include <Timer.h>

Public Member Functions

 Timer ()
 Default constructor.
 Timer (const EventHandler *eh_, const TimeVal &tm_, const TimeVal &delta_, const std::string &name_)
 Constructor used by the TimerQueue.
 Timer (const Timer &t_)
 Copy constructor.
 ~Timer ()
 Destructor: do-nothing.
Timeroperator= (const Timer &t_)
 Assignment operator.
bool operator< (const Timer &t_) const
 Less-that by time.
bool operator== (const Timer &t_) const
 Equal by time.
EventHandlergetHandler () const
 Get EventHandler pointer.
const TimeValgetExpirationTime () const
 Get Expiration Time.
const TimeValgetDeltaTime () const
 Get Delta time.
void rescheduleExpirationTime ()
 Reschedule expiration time with Delta value.
void dump (void)
 Dump contents to logfile.
void set_id (const std::string &id_)
 Set Timer ID.
std::string get_id () const
 Retrieve Timer ID.

Private Attributes

EventHandlerm_eh
 Pointer to EventHandler.
TimeVal m_timer
 When the timer should be triggered.
TimeVal m_delta
 Absolute value used when Reactor needs to reschedule the timer.
std::string m_id
 Timer's ID.

Detailed Description

Definition at line 35 of file Timer.h.

Constructor & Destructor Documentation

ASSA::Timer::Timer ( )
inline

Default constructor.

Definition at line 110 of file Timer.h.

References trace.

: m_eh (NULL), m_id ("<unknown>")
{
trace("Timer::Timer");
}
ASSA::Timer::Timer ( const EventHandler eh_,
const TimeVal tm_,
const TimeVal delta_,
const std::string &  name_ 
)
inline

Constructor used by the TimerQueue.

Parameters
eh_EventHandler to call upon timeout
tm_Time of the day to expire the timer.
delta_Absolute timeout value.
name_Timer name

Definition at line 118 of file Timer.h.

References trace.

: m_eh ((EventHandler*) eh_), m_timer (tm_), m_delta (delta_), m_id (name_)
{
trace("Timer::Timer(EH*, TV&)");
}
ASSA::Timer::Timer ( const Timer t_)
inline

Copy constructor.

Definition at line 127 of file Timer.h.

References trace.

: m_eh (t_.m_eh), m_timer (t_.m_timer),
m_delta (t_.m_delta), m_id (t_.m_id)
{
trace("Timer::Timer(Timer&)");
}
ASSA::Timer::~Timer ( )
inline

Destructor: do-nothing.

Definition at line 136 of file Timer.h.

References trace.

{
trace("Timer::~Timer");
}

Member Function Documentation

void ASSA::Timer::dump ( void  )
inline

Dump contents to logfile.

Definition at line 177 of file Timer.h.

References DL, ASSA::TimeVal::fmt_mm_ss_mls(), ASSA::TimeVal::fmtString(), get_id(), ASSA::EventHandler::get_id(), m_delta, m_eh, m_timer, and ASSA::REACT.

Referenced by ASSA::PriorityQueue_STLPQ< T, Compare >::dump(), and ASSA::TimerQueue::expire().

{
DL((REACT,"Timer %s (EH=%s) expires at %s (delta=%s)\n",
get_id ().c_str (),
m_eh->get_id ().c_str (),
m_timer.fmtString ().c_str(),
m_delta.fmt_mm_ss_mls ().c_str()));
}
std::string ASSA::Timer::get_id ( ) const
inline

Retrieve Timer ID.

Definition at line 89 of file Timer.h.

References m_id.

Referenced by dump(), and ASSA::TimerQueue::expire().

{ return m_id; }
const TimeVal& ASSA::Timer::getDeltaTime ( ) const
inline

Get Delta time.

Definition at line 74 of file Timer.h.

References m_delta.

{ return m_delta; }
const TimeVal& ASSA::Timer::getExpirationTime ( ) const
inline

Get Expiration Time.

Definition at line 71 of file Timer.h.

References m_timer.

Referenced by ASSA::TimerQueue::expire(), and ASSA::TimerQueue::top().

{ return m_timer; }
EventHandler* ASSA::Timer::getHandler ( ) const
inline

Get EventHandler pointer.

Definition at line 68 of file Timer.h.

References m_eh.

Referenced by ASSA::TimerQueue::expire(), and ASSA::PriorityQueue_STLPQ< T, Compare >::remove().

{ return m_eh; }
bool ASSA::Timer::operator< ( const Timer t_) const
inline

Less-that by time.

Definition at line 155 of file Timer.h.

References m_timer.

{
return m_timer < t_.m_timer;
}
Timer & ASSA::Timer::operator= ( const Timer t_)
inline

Assignment operator.

Definition at line 143 of file Timer.h.

References m_delta, m_eh, m_id, and m_timer.

{
m_eh = t_.m_eh;
m_timer = t_.m_timer;
m_delta = t_.m_delta;
m_id = t_.m_id;
return *this;
}
bool ASSA::Timer::operator== ( const Timer t_) const
inline

Equal by time.

Definition at line 162 of file Timer.h.

References m_timer.

{
return m_timer == t_.m_timer;
}
void ASSA::Timer::rescheduleExpirationTime ( )
inline

Reschedule expiration time with Delta value.

Definition at line 169 of file Timer.h.

References ASSA::TimeVal::gettimeofday(), m_delta, and m_timer.

{
TimeVal now (TimeVal::gettimeofday ());
m_timer = now + m_delta;
}
void ASSA::Timer::set_id ( const std::string &  id_)
inline

Set Timer ID.

ID allows Reactor and application-level code describe intelligently the kind of the Timer this is.

Definition at line 85 of file Timer.h.

References m_id.

{ m_id = id_; }

Member Data Documentation

TimeVal ASSA::Timer::m_delta
private

Absolute value used when Reactor needs to reschedule the timer.

Definition at line 99 of file Timer.h.

Referenced by dump(), getDeltaTime(), operator=(), and rescheduleExpirationTime().

EventHandler* ASSA::Timer::m_eh
private

Pointer to EventHandler.

Definition at line 93 of file Timer.h.

Referenced by dump(), getHandler(), and operator=().

std::string ASSA::Timer::m_id
private

Timer's ID.

Definition at line 102 of file Timer.h.

Referenced by get_id(), operator=(), and set_id().

TimeVal ASSA::Timer::m_timer
private

When the timer should be triggered.

Definition at line 96 of file Timer.h.

Referenced by dump(), getExpirationTime(), operator<(), operator=(), operator==(), and rescheduleExpirationTime().


The documentation for this class was generated from the following file: