onoff_client Struct Reference

State associated with a client of an on-off service. More...

#include <onoff.h>

Data Fields
sys_snode_t	node
struct sys_notify	notify
	Notification configuration. More...

Detailed Description

State associated with a client of an on-off service.

Objects of this type are allocated by a client, which is responsible for zero-initializing the node field and invoking the appropriate sys_notify init function to configure notification.

Control of the object content transfers to the service provider when a pointer to the object is passed to any on-off manager function. While the service provider controls the object the client must not change any object fields. Control reverts to the client concurrent with release of the owned sys_notify structure, or when indicated by an onoff_cancel() return value.

After control has reverted to the client the notify field must be reinitialized for the next operation.

Field Documentation

node

sys_snode_t onoff_client::node

notify

struct sys_notify onoff_client::notify

Notification configuration.

---

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

• include/zephyr/sys/onoff.h