LinuxTimerQueue Class Reference

#include <linux_hal_common.hpp>

Inheritance diagram for LinuxTimerQueue:

Collaboration diagram for LinuxTimerQueue:

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

Protected Member Functions
	LinuxTimerQueue ()
virtual bool	init ()
	Initializes internal variables. More...
Protected Member Functions inherited from OSTimerQueue
	OSTimerQueue ()

Friends
class	LinuxTimerQueueFactory
void *	LinuxTimerQueueHandler (void *arg)
	Linux timer queue handler. Deals with linux queues. More...

Detailed Description

Extends OSTimerQueue to Linux

Constructor & Destructor Documentation

LinuxTimerQueue::LinuxTimerQueue ( )

inlineprotected

Default constructor

LinuxTimerQueue::~LinuxTimerQueue

(

)

Deletes pre-allocated internal variables.

Member Function Documentation

bool LinuxTimerQueue::addEvent ( unsigned long  micros, int  type, ostimerq_handler  func, event_descriptor_t *  arg, bool  rm, unsigned *  event  )

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
rm	when true, allows elements to be deleted from the queue
event	[inout] Pointer to the event

Returns

TRUE success, FALSE fail

Implements OSTimerQueue.

bool LinuxTimerQueue::cancelEvent ( int  type, unsigned *  event  )

virtual

Removes an event from the timer queue.

Parameters

type	Event type
event	[inout] Pointer to the event

Returns

TRUE success, FALSE fail

Implements OSTimerQueue.

virtual bool LinuxTimerQueue::init ( )

protectedvirtual

Initializes internal variables.

Returns

TRUE if success, FALSE otherwise.

Reimplemented from OSTimerQueue.

Friends And Related Function Documentation

void* LinuxTimerQueueHandler ( void *  arg )

friend

Linux timer queue handler. Deals with linux queues.

Parameters

arg	[in] LinuxTimerQueue arguments

Returns

void

---

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

• linux_hal_common.hpp