Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Connection Manager Connectivity Bulk API

Connection Manager Bulk API . More...

Functions

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

Connection Manager Bulk API .

Since
3.4
Version
0.1.0

Function Documentation

◆ conn_mgr_all_if_connect()

int conn_mgr_all_if_connect ( bool skip_ignored)

#include <zephyr/net/conn_mgr_connectivity.h>

Convenience function that takes all available ifaces into the admin-up state, and connects those that support connectivity.

Essentially a wrapper for net_if_up and conn_mgr_if_connect.

Parameters
skip_ignored- If true, only affect ifaces that aren't ignored by conn_mgr. Otherwise, affect all ifaces.
Returns
0 if all net_if_up and conn_mgr_if_connect calls returned 0, otherwise the first nonzero value returned by either net_if_up or conn_mgr_if_connect.

◆ conn_mgr_all_if_disconnect()

int conn_mgr_all_if_disconnect ( bool skip_ignored)

#include <zephyr/net/conn_mgr_connectivity.h>

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).

Essentially a wrapper for net_if_down.

Parameters
skip_ignored- If true, only affect ifaces that aren't ignored by conn_mgr. Otherwise, affect all ifaces.
Returns
0 if all net_if_up and conn_mgr_if_connect calls returned 0, otherwise the first nonzero value returned by either net_if_up or conn_mgr_if_connect.

◆ conn_mgr_all_if_down()

int conn_mgr_all_if_down ( bool skip_ignored)

#include <zephyr/net/conn_mgr_connectivity.h>

Convenience function that takes all available ifaces into the admin-down state.

Essentially a wrapper for net_if_down.

Parameters
skip_ignored- If true, only affect ifaces that aren't ignored by conn_mgr. Otherwise, affect all ifaces.
Returns
0 if all net_if_down calls returned 0, otherwise the first nonzero value returned by a net_if_down call.

◆ conn_mgr_all_if_up()

int conn_mgr_all_if_up ( bool skip_ignored)

#include <zephyr/net/conn_mgr_connectivity.h>

Convenience function that takes all available ifaces into the admin-up state.

Essentially a wrapper for net_if_up.

Parameters
skip_ignored- If true, only affect ifaces that aren't ignored by conn_mgr. Otherwise, affect all ifaces.
Returns
0 if all net_if_up calls returned 0, otherwise the first nonzero value returned by a net_if_up call.