A single snapshot of where a handle is, without touching the wire. More...

#include <ra8_wifi.h>

Collaboration diagram for ra8_wifi_status:

Data Fields
ra8_wifi_state_t	state
	Lifecycle position.
bool	associated
	The station is joined.
bool	ip_bound
	A DHCP lease is held.
int8_t	rssi
	Last known signal level in dBm, or zero.
ra8_wifi_lease_t	ip
	The current lease, valid when ip_bound.

Detailed Description

A single snapshot of where a handle is, without touching the wire.

Every field is a cached value the facade already holds, so reading status is side-effect-free and safe to call as often as a display refresh wants. Call ra8_wifi_poll first when a fresher association reading is needed.

Invariant: associated is true exactly when state is at least k_ra8_wifi_state_associated.; ip_bound is true exactly when state is k_ra8_wifi_state_ip_bound.

Example:: ra8_wifi_status_t st = {};

(void)ra8_wifi_status(&wifi, &st);

ra8_wifi_status
ra8_err_t ra8_wifi_status(const ra8_wifi_t *wifi, ra8_wifi_status_t *out)
Read a handle's cached status without touching the wire.
Definition ra8_wifi.c:394

ra8_wifi_status_t
struct ra8_wifi_status ra8_wifi_status_t