timeout.h File Reference

Timeout handling of GoMacH. More...

Detailed Description

Timeout handling of GoMacH.

Definition in file timeout.h.

#include <stdint.h>
#include <stdbool.h>
#include "msg.h"
#include "xtimer.h"
#include "net/gnrc/netif.h"
#include "types.h"

Include dependency graph for timeout.h:

Go to the source code of this file.

void	gnrc_gomach_set_timeout (gnrc_netif_t *netif, gnrc_gomach_timeout_type_t type, uint32_t offset)
	Set GoMacH timeout of type type of offset offset.
void	gnrc_gomach_clear_timeout (gnrc_netif_t *netif, gnrc_gomach_timeout_type_t type)
	Clear GoMacH timeout of type type.
bool	gnrc_gomach_timeout_is_running (gnrc_netif_t *netif, gnrc_gomach_timeout_type_t type)
	Check whether GoMacH timeout of type type is running.
bool	gnrc_gomach_timeout_is_expired (gnrc_netif_t *netif, gnrc_gomach_timeout_type_t type)
	Check whether GoMacH timeout of type type is expired.
void	gnrc_gomach_reset_timeouts (gnrc_netif_t *netif)
	Reset all GoMacH timeouts.
static void	gnrc_gomach_timeout_make_expire (gnrc_gomach_timeout_t *timeout)
	Make a specific GoMacH timeout expired.

Function Documentation

gnrc_gomach_clear_timeout()

void gnrc_gomach_clear_timeout	(	gnrc_netif_t *	netif,
		gnrc_gomach_timeout_type_t	type
	)

Clear GoMacH timeout of type type.

Parameters

[in,out]	netif	the network interface.
[in]	type	GoMacH timeout type.

gnrc_gomach_reset_timeouts()

void gnrc_gomach_reset_timeouts

(

gnrc_netif_t *

netif

)

Reset all GoMacH timeouts.

Parameters

[in,out]

netif

the network interface.

gnrc_gomach_set_timeout()

void gnrc_gomach_set_timeout	(	gnrc_netif_t *	netif,
		gnrc_gomach_timeout_type_t	type,
		uint32_t	offset
	)

Set GoMacH timeout of type type of offset offset.

Parameters

[in,out]	netif	the network interface.
[in]	type	GoMacH timeout type.
[in]	offset	timeout offset.

gnrc_gomach_timeout_is_expired()

bool gnrc_gomach_timeout_is_expired	(	gnrc_netif_t *	netif,
		gnrc_gomach_timeout_type_t	type
	)

Check whether GoMacH timeout of type type is expired.

It will clear the timeout once it is found expired.

Parameters

[in,out]	netif	the network interface.
[in]	type	GoMacH timeout type.

Returns

true, if timeout of type type is expired.

false, if timeout of type type is not expired, or not exist.

gnrc_gomach_timeout_is_running()

bool gnrc_gomach_timeout_is_running	(	gnrc_netif_t *	netif,
		gnrc_gomach_timeout_type_t	type
	)

Check whether GoMacH timeout of type type is running.

Parameters

[in]	netif	the network interface.
[in]	type	GoMacH timeout type.

Returns

true, if timeout of type type is running.

false, if timeout of type type is not running.

gnrc_gomach_timeout_make_expire()

static void gnrc_gomach_timeout_make_expire ( gnrc_gomach_timeout_t *  timeout )

inlinestatic

Make a specific GoMacH timeout expired.

Parameters

[in,out]

timeout

GoMacH timeout

Definition at line 88 of file timeout.h.