L4Re - L4 Runtime Environment
L4::Ipc_svr::Timeout_queue Class Reference

Timeout queue to be used in l4re server loop. More...

+ Collaboration diagram for L4::Ipc_svr::Timeout_queue:

Public Types

typedef L4::Ipc_svr::Timeout Timeout
 Provide a local definition of Timeout for backward compat.
 

Public Member Functions

l4_kernel_clock_t next_timeout () const
 Get the time for the next timeout. More...
 
bool timeout_expired (l4_kernel_clock_t now) const
 Determine if a timeout has happened. More...
 
void handle_expired_timeouts (l4_kernel_clock_t now)
 run the callbacks of expired timeouts More...
 
void add (Timeout *timeout, l4_kernel_clock_t time)
 Add a timeout to the queue. More...
 
void remove (Timeout *timeout)
 Remove timeout from the queue. More...
 

Detailed Description

Timeout queue to be used in l4re server loop.

Definition at line 64 of file ipc_timeout_queue.

Member Function Documentation

◆ add()

void L4::Ipc_svr::Timeout_queue::add ( Timeout timeout,
l4_kernel_clock_t  time 
)
inline

Add a timeout to the queue.

Parameters
timeouttimeout object to add
timethe time when the timeout expires
Precondition
timeout must not be in any queue already

Definition at line 120 of file ipc_timeout_queue.

◆ handle_expired_timeouts()

void L4::Ipc_svr::Timeout_queue::handle_expired_timeouts ( l4_kernel_clock_t  now)
inline

run the callbacks of expired timeouts

Parameters
nowthe current time.

Definition at line 100 of file ipc_timeout_queue.

◆ next_timeout()

l4_kernel_clock_t L4::Ipc_svr::Timeout_queue::next_timeout ( ) const
inline

Get the time for the next timeout.

Returns
the time for the next timeout or 0 if there is none

Definition at line 74 of file ipc_timeout_queue.

◆ remove()

void L4::Ipc_svr::Timeout_queue::remove ( Timeout timeout)
inline

Remove timeout from the queue.

Parameters
timeouttimeout to remove from timeout queue
Precondition
timeout must be in this queue

Definition at line 135 of file ipc_timeout_queue.

◆ timeout_expired()

bool L4::Ipc_svr::Timeout_queue::timeout_expired ( l4_kernel_clock_t  now) const
inline

Determine if a timeout has happened.

Parameters
nowThe current time.
Return values
trueThere is at least one expired timeout in the queue. false No expired timeout in the queue.

Definition at line 90 of file ipc_timeout_queue.


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