Observer API for getting events from zigpc_gateway. More...

Classes
struct	zigpc_net_mgmt_on_network_init
	Event data on network state update. More...

struct	zigpc_net_mgmt_on_network_state_update
	Event data on network state update. These fields will be used to publish the new state as well as any missing paramters needed to advance the network management FSM. More...

struct	zigpc_net_mgmt_on_node_added
	Event data on node added to the network. More...

struct	zigpc_net_mgmt_on_node_interview_status_t

struct	zigpc_net_mgmt_on_node_removed_t
	Event data on node removed from the network. More...

Macros
#define	ZIGPC_NET_MGMT_REQUESTED_STATE_PARAMS_MAX 10

Typedefs
typedef struct zigpc_net_mgmt_on_network_init	zigpc_net_mgmt_on_network_init_t
	Event data on network state update. More...

typedef struct zigpc_net_mgmt_on_network_state_update	zigpc_net_mgmt_on_network_state_update_t
	Event data on network state update. These fields will be used to publish the new state as well as any missing paramters needed to advance the network management FSM. More...

typedef struct zigpc_net_mgmt_on_node_added	zigpc_net_mgmt_on_node_added_t
	Event data on node added to the network. More...

Enumerations
enum	zigpc_net_mgmt_notify_event { ZIGPC_NET_MGMT_NOTIFY_NETWORK_INIT = 0 , ZIGPC_NET_MGMT_NOTIFY_STATE_UPDATE , ZIGPC_NET_MGMT_NOTIFY_NODE_ADDED , ZIGPC_NET_MGMT_NOTIFY_NODE_INTERVIEW_STATUS , ZIGPC_NET_MGMT_NOTIFY_NODE_REMOVED , ZIGPC_NET_MGMT_NOTIFY_MAX }
	Notify event types. More...

Functions
sl_status_t	zigpc_net_mgmt_register_observer (enum zigpc_net_mgmt_notify_event event, zigpc_observer_callback_t callback)
	Register observer to be informed of Net Mgmt updates If the observer is already registered, nothing will be done. More...

sl_status_t	zigpc_net_mgmt_unregister_observer (enum zigpc_net_mgmt_notify_event event, zigpc_observer_callback_t callback)
	Unregister observer from Net Mgmt updates If the observer is not found, nothing will be done. More...

Detailed Description

Observer API for getting events from zigpc_gateway.

In order to listen to events from Net Management, ZigPC Net Mgmt allows components to register observer functions that receive an event type and associated data

Macro Definition Documentation

◆ ZIGPC_NET_MGMT_REQUESTED_STATE_PARAMS_MAX

#define ZIGPC_NET_MGMT_REQUESTED_STATE_PARAMS_MAX 10

Typedef Documentation

◆ zigpc_net_mgmt_on_network_init_t

typedef struct zigpc_net_mgmt_on_network_init zigpc_net_mgmt_on_network_init_t

Event data on network state update.

◆ zigpc_net_mgmt_on_network_state_update_t

typedef struct zigpc_net_mgmt_on_network_state_update zigpc_net_mgmt_on_network_state_update_t

Event data on network state update. These fields will be used to publish the new state as well as any missing paramters needed to advance the network management FSM.

◆ zigpc_net_mgmt_on_node_added_t

typedef struct zigpc_net_mgmt_on_node_added zigpc_net_mgmt_on_node_added_t

Event data on node added to the network.

Enumeration Type Documentation

◆ zigpc_net_mgmt_notify_event

enum zigpc_net_mgmt_notify_event

Notify event types.

Enumerator
ZIGPC_NET_MGMT_NOTIFY_NETWORK_INIT
ZIGPC_NET_MGMT_NOTIFY_STATE_UPDATE
ZIGPC_NET_MGMT_NOTIFY_NODE_ADDED
ZIGPC_NET_MGMT_NOTIFY_NODE_INTERVIEW_STATUS
ZIGPC_NET_MGMT_NOTIFY_NODE_REMOVED
ZIGPC_NET_MGMT_NOTIFY_MAX

Function Documentation

◆ zigpc_net_mgmt_register_observer()

sl_status_t zigpc_net_mgmt_register_observer	(	enum zigpc_net_mgmt_notify_event	event,
		zigpc_observer_callback_t	callback
	)

Register observer to be informed of Net Mgmt updates If the observer is already registered, nothing will be done.

Parameters

event	ZigPC Net Mgmt notify event type
callback	Callback to register with event

Returns: sl_status_t SL_STATUS_OK on success

◆ zigpc_net_mgmt_unregister_observer()

sl_status_t zigpc_net_mgmt_unregister_observer	(	enum zigpc_net_mgmt_notify_event	event,
		zigpc_observer_callback_t	callback
	)

Unregister observer from Net Mgmt updates If the observer is not found, nothing will be done.