Zephyr Project API  3.4.0
A Scalable Open Source RTOS
conn_mgr_connectivity.h File Reference

API for defining generic interfaces for configuring and firing network association routines on network devices that support it. More...

Go to the source code of this file.

Data Structures

struct  conn_mgr_conn_api
 
struct  conn_mgr_conn_impl
 conn_mgr Connectivity Implementation struct Declares a conn_mgr connectivity layer implementation with the provided API More...
 
struct  conn_mgr_conn_binding
 Connectivity Manager network interface binding structure. More...
 

Macros

#define CONN_MGR_CONN_DEFINE(conn_id, conn_api)
 Define a conn_mgr connectivity implementation that can be bound to network devices. More...
 
#define CONN_MGR_CONN_DECLARE_PUBLIC(conn_id)    extern const struct conn_mgr_conn_impl CONN_MGR_CONN_IMPL_GET_NAME(conn_id)
 Helper macro to make a conn_mgr connectivity implementation publicly available. More...
 
#define CONN_MGR_IF_NO_TIMEOUT   0
 
#define CONN_MGR_BIND_CONN_INST(dev_id, inst, conn_id)
 Associate a connectivity implementation with an existing network device instance. More...
 
#define CONN_MGR_BIND_CONN(dev_id, conn_id)    CONN_MGR_BIND_CONN_INST(dev_id, 0, conn_id)
 Associate a connectivity implementation with an existing network device. More...
 

Enumerations

enum  conn_mgr_if_flag { CONN_MGR_IF_PERSISTENT }
 Per-iface connectivity flags. More...
 

Functions

int conn_mgr_if_connect (struct net_if *iface)
 Connect interface. More...
 
int conn_mgr_if_disconnect (struct net_if *iface)
 Disconnect interface. More...
 
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. More...
 
int conn_mgr_if_set_opt (struct net_if *iface, int optname, const void *optval, size_t optlen)
 Set implementation-specific connectivity options. More...
 
int conn_mgr_if_get_opt (struct net_if *iface, int optname, void *optval, size_t *optlen)
 Get implementation-specific connectivity options. More...
 
bool conn_mgr_if_get_flag (struct net_if *iface, enum conn_mgr_if_flag flag)
 Check the value of connectivity flags. More...
 
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. More...
 
int conn_mgr_if_get_timeout (struct net_if *iface)
 Get the connectivity timeout for an iface. More...
 
int conn_mgr_if_set_timeout (struct net_if *iface, int timeout)
 Set the connectivity timeout for an iface. More...
 
void conn_mgr_conn_init (void)
 Initialize all connectivity implementation bindings. More...
 

Detailed Description

API for defining generic interfaces for configuring and firing network association routines on network devices that support it.