Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
onoff_manager Struct Reference

State associated with an on-off manager. More...

#include <onoff.h>

Data Fields

sys_slist_t clients
 List of clients waiting for request or reset completion notifications.
 
sys_slist_t monitors
 List of monitors to be notified of state changes including errors and transition completion.
 
const struct onoff_transitionstransitions
 Transition functions.
 
struct k_spinlock lock
 Mutex protection for other fields.
 
int last_res
 The result of the last transition.
 
uint16_t flags
 Flags identifying the service state.
 
uint16_t refs
 Number of active clients for the service.
 

Detailed Description

State associated with an on-off manager.

No fields in this structure are intended for use by service providers or clients. The state is to be initialized once, using onoff_manager_init(), when the service provider is initialized. In case of error it may be reset through the onoff_reset() API.

Field Documentation

◆ clients

sys_slist_t onoff_manager::clients

List of clients waiting for request or reset completion notifications.

◆ flags

uint16_t onoff_manager::flags

Flags identifying the service state.

◆ last_res

int onoff_manager::last_res

The result of the last transition.

◆ lock

struct k_spinlock onoff_manager::lock

Mutex protection for other fields.

◆ monitors

sys_slist_t onoff_manager::monitors

List of monitors to be notified of state changes including errors and transition completion.

◆ refs

uint16_t onoff_manager::refs

Number of active clients for the service.

◆ transitions

const struct onoff_transitions* onoff_manager::transitions

Transition functions.


The documentation for this struct was generated from the following file: