k_work_sync Struct Reference

A structure holding internal state for a pending synchronous operation on a work item or queue. More...

#include <kernel.h>

Data Fields
union {
struct z_work_flusher   flusher
struct z_work_canceller   canceller
};

Detailed Description

A structure holding internal state for a pending synchronous operation on a work item or queue.

Instances of this type are provided by the caller for invocation of k_work_flush(), k_work_cancel_sync() and sibling flush and cancel APIs. A referenced object must persist until the call returns, and be accessible from both the caller thread and the work queue thread.

Note

If CONFIG_KERNEL_COHERENCE is enabled the object must be allocated in coherent memory; see arch_mem_coherent(). The stack on these architectures is generally not coherent. be stack-allocated. Violations are detected by runtime assertion.

Field Documentation

[union]

union { ... } k_work_sync

canceller

struct z_work_canceller k_work_sync::canceller

flusher

struct z_work_flusher k_work_sync::flusher

---

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

• include/zephyr/kernel.h