Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
conn_mgr_connectivity.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2023 Nordic Semiconductor ASA
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
13#ifndef ZEPHYR_INCLUDE_CONN_MGR_CONNECTIVITY_H_
14#define ZEPHYR_INCLUDE_CONN_MGR_CONNECTIVITY_H_
15
16#include <zephyr/device.h>
17#include <zephyr/net/net_if.h>
19#include <zephyr/net/net_mgmt.h>
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
37/* Connectivity Events */
38#define _NET_MGMT_CONN_LAYER NET_MGMT_LAYER(NET_MGMT_LAYER_L2)
39#define _NET_MGMT_CONN_CODE NET_MGMT_LAYER_CODE(0x207)
40#define _NET_MGMT_CONN_BASE (_NET_MGMT_CONN_LAYER | _NET_MGMT_CONN_CODE | \
41 NET_MGMT_EVENT_BIT)
42#define _NET_MGMT_CONN_IF_EVENT (NET_MGMT_IFACE_BIT | _NET_MGMT_CONN_BASE)
43
44enum net_event_conn_cmd {
45 NET_EVENT_CONN_CMD_IF_TIMEOUT = 1,
46 NET_EVENT_CONN_CMD_IF_FATAL_ERROR,
47};
48
54#define NET_EVENT_CONN_IF_TIMEOUT \
55 (_NET_MGMT_CONN_IF_EVENT | NET_EVENT_CONN_CMD_IF_TIMEOUT)
56
60#define NET_EVENT_CONN_IF_FATAL_ERROR \
61 (_NET_MGMT_CONN_IF_EVENT | NET_EVENT_CONN_CMD_IF_FATAL_ERROR)
62
63
75
83
91
93 /* Total number of flags - must be at the end of the enum */
94 CONN_MGR_NUM_IF_FLAGS,
96};
97
101#define CONN_MGR_IF_NO_TIMEOUT 0
102
119int conn_mgr_if_connect(struct net_if *iface);
120
136
145bool conn_mgr_if_is_bound(struct net_if *iface);
146
166int conn_mgr_if_set_opt(struct net_if *iface, int optname, const void *optval, size_t optlen);
167
194int conn_mgr_if_get_opt(struct net_if *iface, int optname, void *optval, size_t *optlen);
195
208bool conn_mgr_if_get_flag(struct net_if *iface, enum conn_mgr_if_flag flag);
209
223int conn_mgr_if_set_flag(struct net_if *iface, enum conn_mgr_if_flag flag, bool value);
224
236
249int conn_mgr_if_set_timeout(struct net_if *iface, int timeout);
250
272int conn_mgr_all_if_up(bool skip_ignored);
273
274
285int conn_mgr_all_if_down(bool skip_ignored);
286
298int conn_mgr_all_if_connect(bool skip_ignored);
299
311int conn_mgr_all_if_disconnect(bool skip_ignored);
312
317#ifdef __cplusplus
318}
319#endif
320
321#endif /* ZEPHYR_INCLUDE_CONN_MGR_CONNECTIVITY_H_ */
int conn_mgr_all_if_disconnect(bool skip_ignored)
Convenience function that disconnects all available ifaces that support connectivity without putting ...
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...
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.
bool conn_mgr_if_is_bound(struct net_if *iface)
Check whether the provided network interface supports connectivity / has been bound to a connectivity...
int conn_mgr_if_set_opt(struct net_if *iface, int optname, const void *optval, size_t optlen)
Set 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_timeout(struct net_if *iface, int timeout)
Set the connectivity timeout for an iface.
int conn_mgr_if_connect(struct net_if *iface)
Connect interface.
int conn_mgr_if_get_opt(struct net_if *iface, int optname, void *optval, size_t *optlen)
Get implementation-specific connectivity options.
int conn_mgr_if_disconnect(struct net_if *iface)
Disconnect interface.
int conn_mgr_if_get_timeout(struct net_if *iface)
Get the connectivity timeout for an iface.
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.
conn_mgr_if_flag
Per-iface connectivity flags.
Definition: conn_mgr_connectivity.h:67
@ CONN_MGR_IF_PERSISTENT
Persistent.
Definition: conn_mgr_connectivity.h:74
@ CONN_MGR_IF_NO_AUTO_DOWN
No auto-down.
Definition: conn_mgr_connectivity.h:90
@ CONN_MGR_IF_NO_AUTO_CONNECT
No auto-connect.
Definition: conn_mgr_connectivity.h:82
Public API for network interface.
Network Management API public header.
Network Interface structure.
Definition: net_if.h:678