conn_mgr_connectivity.h File Reference

API for controlling generic network association routines on network devices that support it. More...

#include <zephyr/device.h>
#include <zephyr/net/net_if.h>
#include <zephyr/sys/iterable_sections.h>
#include <zephyr/net/net_mgmt.h>

Go to the source code of this file.

Macros
#define	NET_EVENT_CONN_IF_TIMEOUT    (_NET_MGMT_CONN_IF_EVENT | NET_EVENT_CONN_CMD_IF_TIMEOUT)
	net_mgmt event raised when a connection attempt times out
#define	NET_EVENT_CONN_IF_FATAL_ERROR    (_NET_MGMT_CONN_IF_EVENT | NET_EVENT_CONN_CMD_IF_FATAL_ERROR)
	net_mgmt event raised when a non-recoverable connectivity error occurs on an iface
#define	CONN_MGR_IF_NO_TIMEOUT   0
	Value to use with conn_mgr_if_set_timeout and conn_mgr_conn_binding::timeout to indicate no timeout.

Enumerations
enum	net_event_conn_cmd { NET_EVENT_CONN_CMD_IF_TIMEOUT = 1 , NET_EVENT_CONN_CMD_IF_FATAL_ERROR }
enum	conn_mgr_if_flag { CONN_MGR_IF_PERSISTENT , CONN_MGR_IF_NO_AUTO_CONNECT , CONN_MGR_IF_NO_AUTO_DOWN }
	Per-iface connectivity flags. More...

Functions
int	conn_mgr_if_connect (struct net_if *iface)
	Connect interface.
int	conn_mgr_if_disconnect (struct net_if *iface)
	Disconnect interface.
bool	conn_mgr_if_is_bound (struct net_if *iface)
	Check whether the provided network interface supports connectivity / has been bound to a connectivity implementation.
int	conn_mgr_if_set_opt (struct net_if *iface, int optname, const void *optval, size_t optlen)
	Set implementation-specific connectivity options.
int	conn_mgr_if_get_opt (struct net_if *iface, int optname, void *optval, size_t *optlen)
	Get implementation-specific connectivity options.
bool	conn_mgr_if_get_flag (struct net_if *iface, enum conn_mgr_if_flag flag)
	Check the value of connectivity flags.
int	conn_mgr_if_set_flag (struct net_if *iface, enum conn_mgr_if_flag flag, bool value)
	Set the value of a connectivity flags.
int	conn_mgr_if_get_timeout (struct net_if *iface)
	Get the connectivity timeout for an iface.
int	conn_mgr_if_set_timeout (struct net_if *iface, int timeout)
	Set the connectivity timeout for an iface.
int	conn_mgr_all_if_up (bool skip_ignored)
	Convenience function that takes all available ifaces into the admin-up state.
int	conn_mgr_all_if_down (bool skip_ignored)
	Convenience function that takes all available ifaces into the admin-down state.
int	conn_mgr_all_if_connect (bool skip_ignored)
	Convenience function that takes all available ifaces into the admin-up state, and connects those that support connectivity.
int	conn_mgr_all_if_disconnect (bool skip_ignored)
	Convenience function that disconnects all available ifaces that support connectivity without putting them into admin-down state (unless auto-down is enabled for the iface).

Detailed Description

API for controlling generic network association routines on network devices that support it.