ZAF Event Handling

Collaboration diagram for ZAF Event Handling:

Macros
#define	JOB_QUEUE_BUFFER_SIZE   4

Functions
void	ZAF_JobHelperInit (void)
bool	ZAF_JobHelperJobEnqueue (uint8_t event)
bool	ZAF_JobHelperJobDequeue (uint8_t *pEvent)
uint8_t	ZAF_JobHelperGetNumberOfRemainingJobs (void)

Detailed Description

Macro Definition Documentation

JOB_QUEUE_BUFFER_SIZE

#define JOB_QUEUE_BUFFER_SIZE   4

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

Function Documentation

ZAF_JobHelperGetNumberOfRemainingJobs()

uint8_t ZAF_JobHelperGetNumberOfRemainingJobs

(

void

)

Returns the current number of jobs on the job queue.

Returns

Number of jobs on the job queue.

ZAF_JobHelperInit()

void ZAF_JobHelperInit

(

void

)

Initializes the job helper.

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.

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.