ZAF Event Handling#

Functions#

void
ZAF_JobHelperInit(void)

Initializes the job helper.

bool
ZAF_JobHelperJobEnqueue(uint8_t event)

Adds a given event to the job queue.

bool
ZAF_JobHelperJobDequeue(uint8_t *pEvent)

Dequeues a job from the job queue.

uint8_t
ZAF_JobHelperGetNumberOfRemainingJobs(void)

Returns the current number of jobs on the job queue.

Macros#

#define
JOB_QUEUE_BUFFER_SIZE 4

Defines the maximum number of jobs to queue for this module.

Function Documentation#

ZAF_JobHelperInit#

void ZAF_JobHelperInit (void )

Initializes the job helper.

Parameters
N/A

Definition at line 27 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/EventHandling/zaf_job_helper.h

ZAF_JobHelperJobEnqueue#

bool ZAF_JobHelperJobEnqueue (uint8_t event)

Adds a given event to the job queue.

Parameters
[in]event

An event.

Returns

  • true if the event was added to the job queue, false otherwise.


Definition at line 34 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/EventHandling/zaf_job_helper.h

ZAF_JobHelperJobDequeue#

bool ZAF_JobHelperJobDequeue (uint8_t * pEvent)

Dequeues a job from the job queue.

Parameters
[out]pEvent

return event from the queue.

Returns

  • true if a job was dequeued, false otherwise.


Definition at line 41 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/EventHandling/zaf_job_helper.h

ZAF_JobHelperGetNumberOfRemainingJobs#

uint8_t ZAF_JobHelperGetNumberOfRemainingJobs (void )

Returns the current number of jobs on the job queue.

Parameters
N/A

Returns

  • Number of jobs on the job queue.


Definition at line 47 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/EventHandling/zaf_job_helper.h

Macro Definition Documentation#

JOB_QUEUE_BUFFER_SIZE#

#define JOB_QUEUE_BUFFER_SIZE
Value:
4

Defines the maximum number of jobs to queue for this module.


Definition at line 22 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/EventHandling/zaf_job_helper.h