class MifsetTimers Class for handling timers per virtual network interface. More... Definition #include <mifset.hh> List of all Methods

Annotated List Files Globals Hierarchy Index

Public Methods

•  MifsetTimers ()
•  ~MifsetTimers ()
• bool  mif_timer_is_set (size_t vif_index) const
• uint32_t  mif_timer_remain (size_t vif_index, struct timeval& timeval_diff) const
• void  set_mif_timer (size_t vif_index, uint32_t delay_sec, uint32_t delay_usec, cfunc_t func, void *data_pointer)
• void  cancel_mif_timer (size_t vif_index)

Detailed Description

Default constructor

Destructor

[const]

Test if the timer is set

Test if the timer for a given virtual interface is set (i.e., running).

Parameters:

vif_index

the index of the virtual interface to test if its timer is set.

Returns: true if the timer is set, otherwise false.

[const]

Get the remaining expiration time

Compute the expiration time for the timer for a given virtual interface.

Parameters:

vif_index	the index of the virtual interface to compute the expiration time of its timer.
timeval_diff	the timeval structure to store the result. Note that if the timer is not set, the timeval structure will be reset to (0, 0); i.e., zero seconds and zero microseconds.

Returns: the number of seconds until the timer expire. Note that if the timer is not set, the return value is 0 (zero seconds).

Set the timer

This method will start a one-time timer. If the timer should be periodic, it should be restarted by the timeout function.

Parameters:

vif_index	the index of the virtual interface to set the timer of.
delay_sec	the number of seconds to the timer expiration.
delay_usec	the number of microseconds (in addition to the number of seconds delay_sec) to the timer expiration.
func	the timeout function to call when the timer expires.
data_pointer	the data to supply to the timeout function func when the timer expires.

Cancel the timer

Parameters:

vif_index

the index of the virtual interface of the timer to cancel.