Timeouts
[Datatypes, Defines and Macros]

Data Structures
struct	l4_timeout_s
	Basic timeout specification. More...
union	l4_timeout_t
	For IPC there are usually a send and a receive timeout. More...
Functions
l4_timeout_s	l4_timeout_rel (unsigned man, unsigned exp)
	Get relative timeout consisting of mantissa and exponent.
l4_timeout_s	l4_timeout_abs (l4_kernel_clock_t pint, enum l4_timeout_abs_validity v)
	Get absolute timeout.
l4_timeout_t	l4_timeout (l4_timeout_s snd, l4_timeout_s rcv)
	Combine send and receive timeout in a timeout.
void	l4_snd_timeout (l4_timeout_s snd, l4_timeout_t *to)
	Set send timeout in given to timeout.
void	l4_rcv_timeout (l4_timeout_s rcv, l4_timeout_t *to)
	Set receive timeout in given to timeout.
l4_kernel_clock_t	l4_timeout_rel_get (l4_timeout_s to)
	Get clock value of out timeout.
l4_kernel_clock_t	l4_timeout_abs_get (l4_kernel_clock_t cur, l4_timeout_s to)
	Get clock value for a clock + an absolute timeout.
unsigned	l4_timeout_is_absolute (l4_timeout_s to)
	Return whether the given timeout is absolute or not.
l4_kernel_clock_t	l4_timeout_get (l4_kernel_clock_t cur, l4_timeout_s to)
	Get clock value for a clock + a timeout.

---

Function Documentation

l4_timeout_s l4_timeout_rel	(	unsigned	man,
		unsigned	exp
	)			[inline]

Get relative timeout consisting of mantissa and exponent.

Parameters:

	man	Mantissa of timeout
	exp	Exponent of timeout

Returns:

timeout value

Definition at line 258 of file __timeout.h.

l4_timeout_s l4_timeout_abs	(	l4_kernel_clock_t	pint,
		enum l4_timeout_abs_validity	v
	)			[inline]

Get absolute timeout.

Parameters:

	pint	Point in time in clocks
	v	Granularity

Returns:

timeout value

Definition at line 241 of file __timeout.h.

References l4_timeout_s::t.

l4_timeout_t l4_timeout	(	l4_timeout_s	snd,
		l4_timeout_s	rcv
	)			[inline]

Combine send and receive timeout in a timeout.

Parameters:

	snd	Send timeout
	rcv	Receive timeout

Returns:

L4 timeout

Definition at line 217 of file __timeout.h.

References l4_timeout_t::p, l4_timeout_t::rcv, and l4_timeout_t::snd.

void l4_snd_timeout	(	l4_timeout_s	snd,
		l4_timeout_t *	to
	)			[inline]

Set send timeout in given to timeout.

Parameters:

snd

Send timeout

Return values:

to

L4 timeout

Definition at line 227 of file __timeout.h.

References l4_timeout_t::p, and l4_timeout_t::snd.

void l4_rcv_timeout	(	l4_timeout_s	rcv,
		l4_timeout_t *	to
	)			[inline]

Set receive timeout in given to timeout.

Parameters:

rcv

Receive timeout

Return values:

to

L4 timeout

Definition at line 234 of file __timeout.h.

References l4_timeout_t::p, and l4_timeout_t::rcv.

l4_kernel_clock_t l4_timeout_rel_get

(

l4_timeout_s

to

)

[inline]

Get clock value of out timeout.

Parameters:

to

L4 timeout

Returns:

Clock value

Definition at line 265 of file __timeout.h.

References l4_timeout_s::t.

Referenced by l4_timeout_get().

l4_kernel_clock_t l4_timeout_abs_get	(	l4_kernel_clock_t	cur,
		l4_timeout_s	to
	)			[inline]

Get clock value for a clock + an absolute timeout.

Parameters:

	cur	Clock value
	to	L4 timeout

Returns:

Clock sum

Definition at line 274 of file __timeout.h.

References l4_timeout_s::t.

Referenced by l4_timeout_get().

unsigned l4_timeout_is_absolute

(

l4_timeout_s

to

)

[inline]

Return whether the given timeout is absolute or not.

Parameters:

to

L4 timeout

Returns:

!= 0 if absolute, 0 if relative

Definition at line 289 of file __timeout.h.

References l4_timeout_s::t.

Referenced by l4_timeout_get().

l4_kernel_clock_t l4_timeout_get	(	l4_kernel_clock_t	cur,
		l4_timeout_s	to
	)			[inline]

Get clock value for a clock + a timeout.

Parameters:

	cur	Clock value
	to	L4 timeout

Returns:

Clock sum

Definition at line 296 of file __timeout.h.

References l4_timeout_abs_get(), l4_timeout_is_absolute(), and l4_timeout_rel_get().