class TimerList XorpTimer creation and scheduling entity. More... Definition #include <timer.hh> Inherits Heap [public ] List of all Methods

Annotated List Files Globals Hierarchy Index

Public Methods

• inline  TimerList (query_current_time q = system_gettimeofday)
• inline  ~TimerList ()
• void  run ()
• XorpTimer  new_oneoff_at (const timeval& when, const OneoffTimerCallback& ocb)
• XorpTimer  new_oneoff_after_ms (int ms, const OneoffTimerCallback& ocb)
• XorpTimer  new_periodic (int ms, const PeriodicTimerCallback& pcb)
• inline XorpTimer  new_oneoff_at (const timeval& when, OneoffTimerHook hook, void* thunk = 0)
• inline XorpTimer  new_oneoff_after_ms (int ms, OneoffTimerHook hook, void* thunk = 0)
• inline XorpTimer  new_periodic (int ms, PeriodicTimerHook hook, void* thunk = 0)
• XorpTimer  set_flag_at (const timeval& when, bool* flag_ptr)
• XorpTimer  set_flag_after_ms (int ms, bool* flag_ptr)
• inline XorpTimer  new_timer (const BasicTimerCallback& cb)
• bool  empty () const
• size_t  size () const
• bool  get_next_delay (timeval& tv) const
• inline void  current_time (timeval& now) const

Detailed Description

A TimerList is a scheduling entity that provides a means to create XorpTimer objects and run them.

XorpTimer objects created via TimerList methods contain pointers to reference counted elements maintained in the TimerList. The elements on the list need to be referenced by XorpTimer objects or the underlying timer callbacks are never made. For instance:

TimerList timer_list;

XorpTimer t = timer_list.new_oneoff_after_ms(100, 
			callback(some_function, some_arg));

new_oneoff_after_ms(200, my_callback_b, my_parameter_a);

while ( ! timer_list.empty() ) {
	timer_list.run();
}

<code>my_callback_a</code> is called 100ms after the XorpTimer object is created.

<code>my_callback_b</code> is never called because no XorpTimer references the underlying element on the TimerList after <code>TimerList::new_oneoff_after_ms()</code> is called.

Parameters:

query_current_time

specifiable current time function. If no argument is supplied, gettimeofday is used.

Expire all pending XorpTimer objects associated with TimerList.

Create a XorpTimer that will be scheduled once.

Parameters:

when	the absolute time when the timer expires.
ocb	callback object that is invoked when timer expires.

Returns: the XorpTimer created.

Create a XorpTimer that will be scheduled once.

Parameters:

ms	the relative time in milliseconds when the timer expires.
ocb	callback object that is invoked when timer expires.

Returns: the XorpTimer created.

Create a XorpTimer that will invoke a callback periodically.

Parameters:

ms	the period in milliseconds when the timer expires.
pcb	user callback object that is invoked when timer expires. If the callback returns false the periodic XorpTimer is unscheduled.

Returns: the XorpTimer created.

[Deprecated] Create a XorpTimer that will be scheduled once.

Parameters:

when	the absolute time when the timer expires.
hook	user function that is invoked when timer expires.
thunk	argument supplied to user function when timer expires.

Returns: the XorpTimer created.

[Deprecated] Create a XorpTimer that will invoke a callback once.

Parameters:

ms	the relative time in milliseconds when the timer expires.
hook	user function that is invoked when timer expires.
thunk	argument supplied to user function when timer expires.

Returns: the XorpTimer created.

[Deprecated] Create a XorpTimer that will invoke a callback periodically.

Parameters:

ms	the period in milliseconds when the timer expires.
hook	user function that is invoked when timer expires. If the hook returns false the periodic XorpTimer is unscheduled.
thunk	argument supplied to user function when timer expires.

Returns: the XorpTimer created.

Create a XorpTimer to set a flag.

Parameters:

when	the absolute time when the timer expires.
flag_ptr	pointer to a boolean variable that is set to false when this function is called and will be set to true when the XorpTimer expires.

Returns: the XorpTimer created.

Create a XorpTimer to set a flag.

Parameters:

ms	the relative time in milliseconds when the timer expires.
flag_ptr	pointer to a boolean variable that is set to false when this function is called and will be set to true when the XorpTimer expires.

Returns: the XorpTimer created.

Custom XorpTimer creation method. The XorpTimer object created needs to be explicitly scheduled with the available XorpTimer methods.

Parameters:

hook	user function to be invoked when XorpTimer expires.
thunk	user argument to be passed when user's function is invoked.

Returns: the XorpTimer created.

[const]

Returns: true if there no XorpTimer objects currently scheduled on list.

[const]

Returns: the number of scheduled objects.

Reimplemented from Heap.

[const]

Query the next XorpTimer Expiry time.

Parameters:

tv	reference that is assigned expiry time of next timer. If there is no XorpTimer pending, this value is assigned the maximum timeval value.

Returns: true if there is a XorpTimer awaiting expiry, false otherwise.

[const]

Read from clock used by TimerList object.

Parameters:

now	the timeval structure to be assigned the current time.