OSTimerQueue Class Reference

#include <avbts_ostimerq.hpp>

Inheritance diagram for OSTimerQueue:

Collaboration diagram for OSTimerQueue:

Public Member Functions
virtual bool	addEvent (unsigned long micros, int type, ostimerq_handler func, event_descriptor_t *arg, bool dynamic, unsigned *event)=0
	Add an event to the timer queue. More...
virtual bool	cancelEvent (int type, unsigned *event)=0
	Removes an event from the timer queue. More...

Protected Member Functions
virtual bool	init ()
	Initializes timer queue. More...
	OSTimerQueue ()

Detailed Description

OSTimerQueue generic interface

Constructor & Destructor Documentation

OSTimerQueue::OSTimerQueue ( )

inlineprotected

Default constructor

Member Function Documentation

virtual bool OSTimerQueue::addEvent ( unsigned long  micros, int  type, ostimerq_handler  func, event_descriptor_t *  arg, bool  dynamic, unsigned *  event  )

pure virtual

Add an event to the timer queue.

Parameters

micros	Time in microsseconds
type	Event type
func	Callback
arg	inner argument of type event_descriptor_t
dynamic	when true, allows elements to be deleted from the queue
event	[inout] Pointer to the event

Returns

TRUE success, FALSE fail

Implemented in LinuxTimerQueue, and WindowsTimerQueue.

virtual bool OSTimerQueue::cancelEvent ( int  type, unsigned *  event  )

pure virtual

Removes an event from the timer queue.

Parameters

type	Event type
event	[inout] Pointer to the event

Returns

TRUE success, FALSE fail

Implemented in LinuxTimerQueue, and WindowsTimerQueue.

virtual bool OSTimerQueue::init ( )

inlineprotectedvirtual

Initializes timer queue.

Returns

TRUE

Reimplemented in LinuxTimerQueue.

---

The documentation for this class was generated from the following file:

• avbts_ostimerq.hpp