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

Connection Manager API. More...

Functions

void conn_mgr_mon_resend_status (void)
 Resend either NET_L4_CONNECTED or NET_L4_DISCONNECTED depending on whether connectivity is currently available.
 
void conn_mgr_ignore_iface (struct net_if *iface)
 Mark an iface to be ignored by conn_mgr.
 
void conn_mgr_watch_iface (struct net_if *iface)
 Watch (stop ignoring) an iface.
 
bool conn_mgr_is_iface_ignored (struct net_if *iface)
 Check whether the provided iface is currently ignored.
 
void conn_mgr_ignore_l2 (const struct net_l2 *l2)
 Mark an L2 to be ignored by conn_mgr.
 
void conn_mgr_watch_l2 (const struct net_l2 *l2)
 Watch (stop ignoring) an L2.
 

Detailed Description

Connection Manager API.

Function Documentation

◆ conn_mgr_ignore_iface()

void conn_mgr_ignore_iface ( struct net_if iface)

#include <zephyr/net/conn_mgr_monitor.h>

Mark an iface to be ignored by conn_mgr.

Ignoring an iface forces conn_mgr to consider it unready/disconnected.

This means that events related to the iface connecting/disconnecting will not be fired, and if the iface was connected before being ignored, events will be fired as though it disconnected at that moment.

Parameters
ifaceiface to be ignored.

◆ conn_mgr_ignore_l2()

void conn_mgr_ignore_l2 ( const struct net_l2 l2)

#include <zephyr/net/conn_mgr_monitor.h>

Mark an L2 to be ignored by conn_mgr.

This is a wrapper for conn_mgr_ignore_iface that ignores all ifaces that use the L2.

Parameters
l2L2 to be ignored.

◆ conn_mgr_is_iface_ignored()

bool conn_mgr_is_iface_ignored ( struct net_if iface)

#include <zephyr/net/conn_mgr_monitor.h>

Check whether the provided iface is currently ignored.

Parameters
ifaceThe iface to check.
Return values
trueif the iface is being ignored by conn_mgr.
falseif the iface is being watched by conn_mgr.

◆ conn_mgr_mon_resend_status()

void conn_mgr_mon_resend_status ( void  )

#include <zephyr/net/conn_mgr_monitor.h>

Resend either NET_L4_CONNECTED or NET_L4_DISCONNECTED depending on whether connectivity is currently available.

◆ conn_mgr_watch_iface()

void conn_mgr_watch_iface ( struct net_if iface)

#include <zephyr/net/conn_mgr_monitor.h>

Watch (stop ignoring) an iface.

conn_mgr will no longer be forced to consider the iface unreadly/disconnected.

Events related to the iface connecting/disconnecting will no longer be blocked, and if the iface was connected before being watched, events will be fired as though it connected in that moment.

All ifaces default to watched at boot.

Parameters
ifaceiface to no longer ignore.

◆ conn_mgr_watch_l2()

void conn_mgr_watch_l2 ( const struct net_l2 l2)

#include <zephyr/net/conn_mgr_monitor.h>

Watch (stop ignoring) an L2.

This is a wrapper for conn_mgr_watch_iface that watches all ifaces that use the L2.

Parameters
l2L2 to watch.