ble_npl_event Struct Reference

NimBLE event opaque – pairs a callback with an argument. More...

#include <nimble_npl_os.h>

Data Fields
uint8_t	queued
	1 while sitting in an evq, 0 otherwise.
ble_npl_event_fn *	fn
	Callback invoked by ble_npl_event_run.
void *	arg
	Opaque user argument passed to fn().

Detailed Description

NimBLE event opaque – pairs a callback with an argument.

Posted into a ble_npl_eventq by callers and dispatched by ble_npl_eventq_get. Mirrors the FreeRTOS port's struct.

Invariant

queued is 1 exactly while the event sits in a queue.

Example:

struct ble_npl_event ev;
ble_npl_event_init(&ev, on_event, ctx);

See also

ble_npl_eventq

Definition at line 99 of file nimble_npl_os.h.

Field Documentation

arg

void* ble_npl_event::arg

Opaque user argument passed to fn().

Definition at line 102 of file nimble_npl_os.h.

Referenced by ble_npl_callout_init(), ble_npl_callout_set_arg(), ble_npl_event_get_arg(), ble_npl_event_init(), and ble_npl_event_set_arg().

fn

ble_npl_event_fn* ble_npl_event::fn

Callback invoked by ble_npl_event_run.

Definition at line 101 of file nimble_npl_os.h.

Referenced by ble_npl_callout_init(), ble_npl_event_init(), and ble_npl_event_run().

queued

uint8_t ble_npl_event::queued

1 while sitting in an evq, 0 otherwise.

Definition at line 100 of file nimble_npl_os.h.

Referenced by ble_npl_event_is_queued(), ble_npl_eventq_get(), ble_npl_eventq_put(), and ble_npl_eventq_remove().

---

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

• port/nimble/inc/nimble/nimble_npl_os.h