net_mgmt_event_callback Struct Reference

Network Management event callback structure Used to register a callback into the network management event part, in order to let the owner of this struct to get network event notification based on given event mask. More...

#include <net_mgmt.h>

Data Fields
sys_snode_t	node
	Meant to be used internally, to insert the callback into a list.
union {
net_mgmt_event_handler_t   handler
	Actual callback function being used to notify the owner. More...
struct k_sem *   sync_call
	Semaphore meant to be used internally for the synchronous net_mgmt_event_wait() function. More...
};
union {
uint32_t   event_mask
	A mask of network events on which the above handler should be called in case those events come. More...
uint32_t   raised_event
	Internal place holder when a synchronous event wait is successfully unlocked on a event. More...
};
	A mask of network events on which the above handler should be called in case those events come.

Detailed Description

Network Management event callback structure Used to register a callback into the network management event part, in order to let the owner of this struct to get network event notification based on given event mask.

Field Documentation

[union]

union { ... } net_mgmt_event_callback

[union]

union { ... } net_mgmt_event_callback

A mask of network events on which the above handler should be called in case those events come.

Such mask can be modified whenever necessary by the owner, and thus will affect the handler being called or not.

event_mask

uint32_t net_mgmt_event_callback::event_mask

A mask of network events on which the above handler should be called in case those events come.

Note that only the command part is treated as a mask, matching one to several commands. Layer and layer code will be made of an exact match. This means that in order to receive events from multiple layers, one must have multiple listeners registered, one for each layer being listened.

handler

net_mgmt_event_handler_t net_mgmt_event_callback::handler

Actual callback function being used to notify the owner.

node

sys_snode_t net_mgmt_event_callback::node

Meant to be used internally, to insert the callback into a list.

So nobody should mess with it.

raised_event

uint32_t net_mgmt_event_callback::raised_event

Internal place holder when a synchronous event wait is successfully unlocked on a event.

sync_call

struct k_sem* net_mgmt_event_callback::sync_call

Semaphore meant to be used internally for the synchronous net_mgmt_event_wait() function.

---

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

• include/zephyr/net/net_mgmt.h