the TimerList class. This class implements a doubly-linked-list of timer objects. More...

#include <timerlist.h>

Inheritance diagram for Mark3::TimerList:

Public Member Functions
void	Init ()
	Init Initialize the TimerList object. Must be called before using the object. More...

void	Add (Timer *pclListNode_)
	Add Add a timer to the TimerList. More...

void	Remove (Timer *pclLinkListNode_)
	Remove Remove a timer from the TimerList, cancelling its expiry. More...

void	Process ()
	Process Process all timers in the timerlist as a result of the timer expiring. This will select a new timer epoch based on the next timer to expire. More...

Public Member Functions inherited from Mark3::TypedDoubleLinkList< Timer >
void *	operator new (size_t sz, void *pv)

	TypedDoubleLinkList ()

Timer *	GetHead ()
	GetHead Get the head node in the linked list. More...

void	SetHead (Timer *pclNode_)
	SetHead Set the head node of a linked list. More...

Timer *	GetTail ()
	GetTail Get the tail node of the linked list. More...

void	SetTail (Timer *pclNode_)
	SetTail Set the tail node of the linked list. More...

void	Add (Timer *pNode_)
	Add Add the linked list node to this linked list. More...

void	Remove (Timer *pNode_)
	Remove Add the linked list node to this linked list. More...

Public Member Functions inherited from Mark3::DoubleLinkList
void *	operator new (size_t sz, void *pv)

	DoubleLinkList ()
	DoubleLinkList. More...

void	Add (LinkListNode *node_)
	Add. More...

void	Remove (LinkListNode *node_)
	Remove. More...

Public Member Functions inherited from Mark3::LinkList
void	Init ()
	Init. More...

LinkListNode *	GetHead ()
	GetHead. More...

void	SetHead (LinkListNode *pclNode_)
	SetHead. More...

LinkListNode *	GetTail ()
	GetTail. More...

void	SetTail (LinkListNode *pclNode_)
	SetTail. More...

Private Attributes
uint32_t	m_u32NextWakeup
	The time (in system clock ticks) of the next wakeup event. More...

bool	m_bTimerActive
	Whether or not the timer is active. More...

Mutex	m_clMutex
	Guards against concurrent access to the timer list - Only needed when running threaded. More...

Additional Inherited Members
Protected Attributes inherited from Mark3::LinkList
LinkListNode *	m_pclHead
	Pointer to the head node in the list. More...

LinkListNode *	m_pclTail
	Pointer to the tail node in the list. More...

Detailed Description

the TimerList class. This class implements a doubly-linked-list of timer objects.

Definition at line 40 of file timerlist.h.

Member Function Documentation

◆ Add()

void Mark3::TimerList::Add ( Timer * pclListNode_ )

Add Add a timer to the TimerList.

Parameters

pclListNode_ Pointer to the Timer to Add

Definition at line 35 of file timerlist.cpp.

◆ Init()

void Mark3::TimerList::Init ( void )

Init Initialize the TimerList object. Must be called before using the object.

Definition at line 27 of file timerlist.cpp.

◆ Process()

void Mark3::TimerList::Process ( void )

Process Process all timers in the timerlist as a result of the timer expiring. This will select a new timer epoch based on the next timer to expire.

Definition at line 61 of file timerlist.cpp.

◆ Remove()

void Mark3::TimerList::Remove ( Timer * pclLinkListNode_ )

Remove Remove a timer from the TimerList, cancelling its expiry.

Parameters

pclLinkListNode_ Pointer to the Timer to remove

Definition at line 51 of file timerlist.cpp.

Member Data Documentation

◆ m_bTimerActive

bool Mark3::TimerList::m_bTimerActive

private

Whether or not the timer is active.

Definition at line 78 of file timerlist.h.

◆ m_clMutex

Mutex Mark3::TimerList::m_clMutex

private

Guards against concurrent access to the timer list - Only needed when running threaded.

Definition at line 81 of file timerlist.h.

◆ m_u32NextWakeup

uint32_t Mark3::TimerList::m_u32NextWakeup

private

The time (in system clock ticks) of the next wakeup event.

Definition at line 75 of file timerlist.h.

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

/mnt/c/Users/moslevin/m3-repo2/kernel/src/public/timerlist.h
/mnt/c/Users/moslevin/m3-repo2/kernel/src/timerlist.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Add()

◆ Init()

◆ Process()

◆ Remove()

Member Data Documentation

◆ m_bTimerActive

◆ m_clMutex

◆ m_u32NextWakeup