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
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
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
ZAF_JobHelperJobEnqueue#
bool ZAF_JobHelperJobEnqueue (uint8_t event)
Adds a given event to the job queue.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | [in] | event | An event. |
Returns
true if the event was added to the job queue, false otherwise.
ZAF_JobHelperJobDequeue#
bool ZAF_JobHelperJobDequeue (uint8_t * pEvent)
Dequeues a job from the job queue.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t * | [out] | pEvent | return event from the queue. |
Returns
true if a job was dequeued, false otherwise.
ZAF_JobHelperGetNumberOfRemainingJobs#
uint8_t ZAF_JobHelperGetNumberOfRemainingJobs (void )
Returns the current number of jobs on the job queue.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
Number of jobs on the job queue.