SingleThreadedSchedulerClient Class Reference

Class used by CScheduler clients which may schedule multiple jobs which are required to be run serially. More...

#include <scheduler.h>

Collaboration diagram for SingleThreadedSchedulerClient:

Public Member Functions
	SingleThreadedSchedulerClient (CScheduler *pschedulerIn)
void	AddToProcessQueue (std::function< void(void)> func)
void	EmptyQueue ()

Private Member Functions
void	MaybeScheduleProcessQueue ()
void	ProcessQueue ()

Private Attributes
CScheduler *	m_pscheduler
CCriticalSection	m_cs_callbacks_pending
std::list< std::function< void(void)> >	m_callbacks_pending
bool	m_are_callbacks_running = false

Detailed Description

Class used by CScheduler clients which may schedule multiple jobs which are required to be run serially.

Does not require such jobs to be executed on the same thread, but no two jobs will be executed at the same time.

Definition at line 94 of file scheduler.h.

Constructor & Destructor Documentation

SingleThreadedSchedulerClient()

SingleThreadedSchedulerClient::SingleThreadedSchedulerClient ( CScheduler *  pschedulerIn )

inlineexplicit

Definition at line 106 of file scheduler.h.

Member Function Documentation

AddToProcessQueue()

void SingleThreadedSchedulerClient::AddToProcessQueue

(

std::function< void(void)>

func

)

Definition at line 191 of file scheduler.cpp.

EmptyQueue()

void SingleThreadedSchedulerClient::EmptyQueue

(

)

Definition at line 201 of file scheduler.cpp.

MaybeScheduleProcessQueue()

void SingleThreadedSchedulerClient::MaybeScheduleProcessQueue ( )

private

Definition at line 150 of file scheduler.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ProcessQueue()

void SingleThreadedSchedulerClient::ProcessQueue ( )

private

Definition at line 162 of file scheduler.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_are_callbacks_running

bool SingleThreadedSchedulerClient::m_are_callbacks_running = false

private

Definition at line 100 of file scheduler.h.

m_callbacks_pending

std::list<std::function<void (void)> > SingleThreadedSchedulerClient::m_callbacks_pending

private

Definition at line 99 of file scheduler.h.

m_cs_callbacks_pending

CCriticalSection SingleThreadedSchedulerClient::m_cs_callbacks_pending

private

Definition at line 98 of file scheduler.h.

m_pscheduler

CScheduler* SingleThreadedSchedulerClient::m_pscheduler

private

Definition at line 96 of file scheduler.h.

---

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

• src/scheduler.h
• src/scheduler.cpp