EmberAfEventContext Struct Reference
Zigbee Application Framework API Reference > Application Framework Types Reference

a structure used to keep track of cluster related events and their sleep control values. The cluster code will not know at runtime all of the events that it has access to in the event table This structure is stored by the application framework in an event context table which along with helper functions allows the cluster code to schedule and deactivate its associated events.

#include < af-types.h >

Data Fields

uint8_t endpoint
EmberAfClusterId clusterId
bool isClient
EmberAfEventPollControl pollControl
EmberAfEventSleepControl sleepControl
EmberEventControl * eventControl

a structure used to keep track of cluster related events and their sleep control values. The cluster code will not know at runtime all of the events that it has access to in the event table This structure is stored by the application framework in an event context table which along with helper functions allows the cluster code to schedule and deactivate its associated events.

Field Documentation

◆ clusterId

EmberAfClusterId EmberAfEventContext::clusterId

The cluster id of the associated cluster event.

◆ endpoint

uint8_t EmberAfEventContext::endpoint

The endpoint of the associated cluster event.

◆ eventControl

EmberEventControl * EmberAfEventContext::eventControl

A pointer to the event control value which is stored in the event table and is used to actually schedule the event.

◆ isClient

bool EmberAfEventContext::isClient

The server/client identity of the associated cluster event.

◆ pollControl

EmberAfEventPollControl EmberAfEventContext::pollControl

A poll control value used to control the network polling behavior while the event is active.

◆ sleepControl

EmberAfEventSleepControl EmberAfEventContext::sleepControl

A sleep control value used to control the processor's sleep behavior while the event is active.

The documentation for this struct was generated from the following file:
  • af-types.h