Zephyr API Documentation  2.7.0-rc2
A Scalable Open Source RTOS
net_mgmt.h File Reference

Network Management API public header. More...

#include <sys/__assert.h>
#include <net/net_core.h>
#include <net/net_event.h>

Go to the source code of this file.

Data Structures

struct  net_mgmt_event_callback
 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...
 

Macros

#define net_mgmt(_mgmt_request, _iface, _data, _len)    net_mgmt_##_mgmt_request(_mgmt_request, _iface, _data, _len)
 
#define NET_MGMT_DEFINE_REQUEST_HANDLER(_mgmt_request)
 
#define NET_MGMT_REGISTER_REQUEST_HANDLER(_mgmt_request, _func)    FUNC_ALIAS(_func, net_mgmt_##_mgmt_request, int)
 

Typedefs

typedef int(* net_mgmt_request_handler_t) (uint32_t mgmt_request, struct net_if *iface, void *data, size_t len)
 Signature which all Net MGMT request handler need to follow. More...
 
typedef void(* net_mgmt_event_handler_t) (struct net_mgmt_event_callback *cb, uint32_t mgmt_event, struct net_if *iface)
 Define the user's callback handler function signature. More...
 

Functions

static void net_mgmt_init_event_callback (struct net_mgmt_event_callback *cb, net_mgmt_event_handler_t handler, uint32_t mgmt_event_mask)
 Helper to initialize a struct net_mgmt_event_callback properly. More...
 
void net_mgmt_add_event_callback (struct net_mgmt_event_callback *cb)
 Add a user callback. More...
 
void net_mgmt_del_event_callback (struct net_mgmt_event_callback *cb)
 Delete a user callback. More...
 
void net_mgmt_event_notify_with_info (uint32_t mgmt_event, struct net_if *iface, const void *info, size_t length)
 Used by the system to notify an event. More...
 
static void net_mgmt_event_notify (uint32_t mgmt_event, struct net_if *iface)
 
int net_mgmt_event_wait (uint32_t mgmt_event_mask, uint32_t *raised_event, struct net_if **iface, const void **info, size_t *info_length, k_timeout_t timeout)
 Used to wait synchronously on an event mask. More...
 
int net_mgmt_event_wait_on_iface (struct net_if *iface, uint32_t mgmt_event_mask, uint32_t *raised_event, const void **info, size_t *info_length, k_timeout_t timeout)
 Used to wait synchronously on an event mask for a specific iface. More...
 
void net_mgmt_event_init (void)
 Used by the core of the network stack to initialize the network event processing. More...
 

Detailed Description

Network Management API public header.