Timeout handling of GoMacH. More...

Detailed Description

Timeout handling of GoMacH.

Definition in file net/gnrc/gomach/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 net/gnrc/gomach/timeout.h:

Go to the source code of this file.

Functions

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. More...
 
void gnrc_gomach_clear_timeout (gnrc_netif_t *netif, gnrc_gomach_timeout_type_t type)
 Clear GoMacH timeout of type type. More...
 
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. More...
 
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. More...
 
void gnrc_gomach_reset_timeouts (gnrc_netif_t *netif)
 Reset all GoMacH timeouts. More...
 
static void gnrc_gomach_timeout_make_expire (gnrc_gomach_timeout_t *timeout)
 Make a specific GoMacH timeout expired. More...
 

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]netifthe network interface.
[in]typeGoMacH timeout type.

◆ gnrc_gomach_reset_timeouts()

void gnrc_gomach_reset_timeouts ( gnrc_netif_t netif)

Reset all GoMacH timeouts.

Parameters
[in,out]netifthe 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]netifthe network interface.
[in]typeGoMacH timeout type.
[in]offsettimeout 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]netifthe network interface.
[in]typeGoMacH 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]netifthe network interface.
[in]typeGoMacH 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]timeoutGoMacH timeout

Definition at line 88 of file net/gnrc/gomach/timeout.h.