WindowsTimerQueue Class Reference

#include <windows_hal.hpp>

Inheritance diagram for WindowsTimerQueue:

Collaboration diagram for WindowsTimerQueue:

Public Member Functions
bool	addEvent (unsigned long micros, int type, ostimerq_handler func, event_descriptor_t *arg, bool rm, unsigned *event)
	Create a new event and add it to the timer queue. More...
bool	cancelEvent (int type, unsigned *event)
	Cancels an event from the queue. More...

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

Friends
class	WindowsTimerQueueFactory
VOID CALLBACK	WindowsTimerQueueHandler (PVOID arg_in, BOOLEAN ignore)

Detailed Description

Windows timer queue interface

Constructor & Destructor Documentation

WindowsTimerQueue::WindowsTimerQueue ( )

inlineprotected

Default constructor. Initializes timers lock

Member Function Documentation

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

inlinevirtual

Create a new event and add it to the timer queue.

Parameters

micros	Time in microsseconds
type	Event type
func	Callback function
arg	[in] Event arguments
rm	when true, allows elements to be deleted from the queue
event	[in] Pointer to the event to be created

Returns

Always return true

Implements OSTimerQueue.

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

inlinevirtual

Cancels an event from the queue.

Parameters

type	Event type
event	[in] Pointer to the event to be removed

Returns

Always returns true.

Implements OSTimerQueue.

Friends And Related Function Documentation

VOID CALLBACK WindowsTimerQueueHandler ( PVOID  arg_in, BOOLEAN  ignore  )

friend

Windows Timer queue handler callback definition

Windows callback for the timer queue handler

---

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

• windows_hal.hpp