Functions
DPS_Event *	DPS_CreateEvent ()
	Create and initialize an event. More...

void	DPS_DestroyEvent (DPS_Event *event)
	Destroy an event and free resources. More...

void	DPS_SetEventData (DPS_Event event, void data)
	Set the event application data pointer. More...

void *	DPS_GetEventData (const DPS_Event *event)
	Get the event application data pointer. More...

void	DPS_SignalEvent (DPS_Event *event, DPS_Status status)
	Signal an event. More...

DPS_Status	DPS_WaitForEvent (DPS_Event *event)
	Wait for an event to be signalled. More...

DPS_Status	DPS_TimedWaitForEvent (DPS_Event *event, uint16_t timeout)
	Wait for an event to be signalled with a timeout. More...

Typedef Documentation

typedef struct _DPS_Event DPS_Event

Opaque type for an event.

Function Documentation

DPS_Event* DPS_CreateEvent ( )

Create and initialize an event.

void DPS_DestroyEvent ( DPS_Event * event )

Destroy an event and free resources.

Parameters

event The event to destroy

void* DPS_GetEventData ( const DPS_Event * event )

Get the event application data pointer.

Parameters

event The event to get the application data pointer from

Set the event application data pointer.

Parameters

event	The event to set an application data pointer on
data	The data pointer to set

Signal an event.

Parameters

event	Event to signal
status	A status code to pass to the event waiter

DPS_Status DPS_TimedWaitForEvent	(	DPS_Event *	event,
		uint16_t	timeout
	)

Wait for an event to be signalled with a timeout.

Parameters

event	Event to wait for
timeout	Timeout in milliseconds

Returns: The status passed to DPS_SignalEvent() or DPS_ERR_TIMEOUT if the call timed out.

DPS_Status DPS_WaitForEvent ( DPS_Event * event )

Wait for an event to be signalled.

Parameters

event Event to wait for