Event user area information filled by em_event_uarea_info() More...

#include <event_machine_event.h>

Data Fields
void *	uarea

size_t	size

struct {
bool isset

uint16_t value

}	id

Detailed Description

Event user area information filled by em_event_uarea_info()

Output structure for obtaining information about an event's user area. Information related to the user area will be filled into this struct by the em_event_uarea_info() API function.

A user area is only present if the EM pool the event was allocated from was created with user area size > 0, see em_pool_cfg_t and em_pool_create(). The user area ID can always be used (set/get), even when the size of the user area is zero(0).

See also: em_event_uarea_info(), em_event_uarea_id_set()

Examples: bench_event.c, and queue_types_ag.c.

Definition at line 881 of file event_machine_event.h.

Field Documentation

◆ id

struct { ... } em_event_uarea_info_t::id

Event user area ID (ID can be set/get even when no uarea present)

Examples: queue_types_ag.c.

◆ isset

bool em_event_uarea_info_t::isset

Boolean: has the ID been set previously? true/false

Definition at line 890 of file event_machine_event.h.

◆ size

size_t em_event_uarea_info_t::size

Size of the event user area, zero(0) if event has no user area

Definition at line 885 of file event_machine_event.h.

◆ uarea

void* em_event_uarea_info_t::uarea

Pointer to the event user area, NULL if event has no user area

Examples: queue_types_ag.c.

Definition at line 883 of file event_machine_event.h.

◆ value

uint16_t em_event_uarea_info_t::value

Value of the user area ID, if (and only if) set before. Only inspect '.id.value' when '.id.isset=true' indicating that ID has been set earlier by em_event_uarea_id_set().

Examples: queue_types_ag.c.

Definition at line 895 of file event_machine_event.h.

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

event_machine_event.h