StdSchedulerThread Class Reference

#include <StdScheduler.h>

Inheritance diagram for StdSchedulerThread:

Collaboration diagram for StdSchedulerThread:

Public Member Functions
	StdSchedulerThread ()
	~StdSchedulerThread () override
void	Clear ()
void	Set (StdSchedulerProc **ppProcs, int iProcCnt)
void	Add (StdSchedulerProc *pProc)
void	Remove (StdSchedulerProc *pProc)
bool	Start ()
void	Stop ()
int	getProcCnt () const
bool	hasProc (StdSchedulerProc *pProc)
bool	IsInManualLoop ()
void	Added (StdSchedulerProc *pProc)
void	Removing (StdSchedulerProc *pProc)
void	Changed (StdSchedulerProc *pProc)
void	StartOnCurrentThread ()
C4TimeMilliseconds	GetNextTick (C4TimeMilliseconds tNow)
bool	ScheduleProcs (int iTimeout=1000/36)
void	UnBlock ()

Protected Member Functions
virtual void	OnError (StdSchedulerProc *)
virtual bool	DoScheduleProcs (int iTimeout)

Detailed Description

Definition at line 273 of file StdScheduler.h.

Constructor & Destructor Documentation

StdSchedulerThread()

StdSchedulerThread::StdSchedulerThread ( )

default

~StdSchedulerThread()

StdSchedulerThread::~StdSchedulerThread ( )

override

Definition at line 159 of file StdScheduler.cpp.

{
    Clear();
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

Add()

void StdSchedulerThread::Add

(

StdSchedulerProc *

pProc

)

Definition at line 183 of file StdScheduler.cpp.

{
    // Thread is running? Stop it first
    bool fGotThread = fThread;
    if (fGotThread) Stop();
    // Set
    StdScheduler::Add(pProc);
    // Restart
    if (fGotThread) Start();
}

References StdScheduler::Add(), Start(), and Stop().

Referenced by C4NetIOMan::AddIO(), and C4InteractiveThread::AddProc().

Here is the call graph for this function:

Here is the caller graph for this function:

Added()

void StdScheduler::Added ( StdSchedulerProc *  pProc )

inherited

Definition at line 281 of file StdSchedulerMac.mm.

{
    [[SCHAdditions requestAdditionsForScheduler:this] assignAdditionForProc:pProc];
}

References SCHAdditions::assignAdditionForProc:, and SCHAdditions::requestAdditionsForScheduler:.

Referenced by StdScheduler::Add().

Here is the call graph for this function:

Here is the caller graph for this function:

Changed()

void StdScheduler::Changed ( StdSchedulerProc *  pProc )

inherited

Definition at line 294 of file StdSchedulerMac.mm.

{
    [[[SCHAdditions requestAdditionsForScheduler:this] additionForProc:pProc] changed];
}

References SCHAdditions::additionForProc:, SCHAddition::changed, and SCHAdditions::requestAdditionsForScheduler:.

Here is the call graph for this function:

Clear()

void StdSchedulerThread::Clear

(

)

Definition at line 164 of file StdScheduler.cpp.

{
    // Stop thread
    if (fThread) Stop();
    // Clear scheduler
    StdScheduler::Clear();
}

References StdScheduler::Clear(), and Stop().

Referenced by C4NetIOMan::Clear(), and ~StdSchedulerThread().

Here is the call graph for this function:

Here is the caller graph for this function:

DoScheduleProcs()

virtual bool StdScheduler::DoScheduleProcs ( int  iTimeout )

protectedvirtualinherited

Reimplemented in C4AbstractApp.

Referenced by C4AbstractApp::DoScheduleProcs(), and StdScheduler::ScheduleProcs().

Here is the caller graph for this function:

GetNextTick()

C4TimeMilliseconds StdScheduler::GetNextTick ( C4TimeMilliseconds  tNow )

inherited

Definition at line 120 of file StdScheduler.cpp.

{
    C4TimeMilliseconds tProcTick = C4TimeMilliseconds::PositiveInfinity;
    for (auto proc : procs)
    {
        tProcTick = std::min(tProcTick, proc->GetNextTick(tNow));
    }
    return tProcTick;
}

References C4TimeMilliseconds::PositiveInfinity.

Referenced by C4AbstractApp::Run(), and StdScheduler::ScheduleProcs().

Here is the caller graph for this function:

getProcCnt()

int StdScheduler::getProcCnt ( ) const

inlineinherited

Definition at line 245 of file StdScheduler.h.

{ return procs.size()-1; } // ignore internal NoopNotifyProc

Referenced by C4InteractiveThread::AddProc(), and C4InteractiveThread::RemoveProc().

Here is the caller graph for this function:

hasProc()

bool StdScheduler::hasProc ( StdSchedulerProc *  pProc )

inlineinherited

Definition at line 246 of file StdScheduler.h.

{ return std::find(procs.begin(), procs.end(), pProc) != procs.end(); }

Referenced by C4InteractiveThread::RemoveProc().

Here is the caller graph for this function:

IsInManualLoop()

bool StdScheduler::IsInManualLoop ( )

inlineinherited

Definition at line 247 of file StdScheduler.h.

{ return isInManualLoop; }

OnError()

virtual void StdScheduler::OnError ( StdSchedulerProc *  )

inlineprotectedvirtualinherited

Definition at line 268 of file StdScheduler.h.

{ }

Remove()

void StdSchedulerThread::Remove

(

StdSchedulerProc *

pProc

)

Definition at line 194 of file StdScheduler.cpp.

{
    // Thread is running? Stop it first
    bool fGotThread = fThread;
    if (fGotThread) Stop();
    // Set
    StdScheduler::Remove(pProc);
    // Restart
    if (fGotThread) Start();
}

References StdScheduler::Remove(), Start(), and Stop().

Referenced by C4InteractiveThread::RemoveProc().

Here is the call graph for this function:

Here is the caller graph for this function:

Removing()

void StdScheduler::Removing ( StdSchedulerProc *  pProc )

inherited

Definition at line 286 of file StdSchedulerMac.mm.

{
    auto x = [SCHAdditions requestAdditionsForScheduler:this];
    [x removeAdditionForProc:pProc];
    if ([x numberOfAdditions] == 0)
        [SCHAdditions removeAdditions:x];
}

References SCHAdditions::requestAdditionsForScheduler:.

Referenced by StdScheduler::Remove().

Here is the call graph for this function:

Here is the caller graph for this function:

ScheduleProcs()

bool StdScheduler::ScheduleProcs ( int  iTimeout = 1000/36 )

inherited

Definition at line 130 of file StdScheduler.cpp.

{
    // Needs at least one process to work properly
    if (!procs.size()) return false;
 
    // Get timeout
    C4TimeMilliseconds tNow = C4TimeMilliseconds::Now();
    C4TimeMilliseconds tProcTick = GetNextTick(tNow);
    if (iTimeout == -1 || tNow + iTimeout > tProcTick)
    {
        iTimeout = std::max<decltype(iTimeout)>(tProcTick - tNow, 0);
    }
    
    bool old = isInManualLoop;
    isInManualLoop = true;
    bool res = DoScheduleProcs(iTimeout);
    isInManualLoop = old;
    return res;
}

References StdScheduler::DoScheduleProcs(), StdScheduler::GetNextTick(), and C4TimeMilliseconds::Now().

Referenced by C4AulDebug::DebugStep(), C4Network2::DoLobby(), C4GUI::Dialog::DoModal(), C4ScenarioListLoader::DoProcessCallback(), C4GUI::Dialog::Execute(), C4Network2::FinalInit(), C4Game::InitNetworkFromAddress(), C4Network2::LeaguePlrAuth(), C4Network2::LeagueStart(), C4AulDebug::Listen(), C4Network2::RetrieveRes(), and C4AbstractApp::Run().

Here is the call graph for this function:

Here is the caller graph for this function:

Set()

void StdSchedulerThread::Set	(	StdSchedulerProc **	ppProcs,
		int	iProcCnt
	)

Definition at line 172 of file StdScheduler.cpp.

{
    // Thread is running? Stop it first
    bool fGotThread = fThread;
    if (fGotThread) Stop();
    // Set
    StdScheduler::Set(ppProcs, iProcCnt);
    // Restart
    if (fGotThread) Start();
}

References StdScheduler::Set(), Start(), and Stop().

Here is the call graph for this function:

Start()

bool StdSchedulerThread::Start

(

)

Definition at line 205 of file StdScheduler.cpp.

{
    // already running? stop
    if (fThread) Stop();
    // begin thread
    fRunThreadRun = true;
#ifdef HAVE_WINTHREAD
    iThread = _beginthread(_ThreadFunc, 0, this);
    fThread = (iThread != -1);
#elif defined(HAVE_PTHREAD)
    fThread = !pthread_create(&Thread, nullptr, _ThreadFunc, this);
#endif
    // success?
    return fThread;
}

References Stop().

Referenced by Add(), C4InteractiveThread::AddProc(), main(), Remove(), and Set().

Here is the call graph for this function:

Here is the caller graph for this function:

StartOnCurrentThread()

void StdScheduler::StartOnCurrentThread ( )

inherited

Definition at line 276 of file StdSchedulerMac.mm.

{
    [[SCHAdditions requestAdditionsForScheduler:this] start];
}

References SCHAdditions::requestAdditionsForScheduler:, and SCHAdditions::start.

Here is the call graph for this function:

Stop()

void StdSchedulerThread::Stop

(

)

Definition at line 221 of file StdScheduler.cpp.

{
    // Not running?
    if (!fThread) return;
    // Set flag
    fRunThreadRun = false;
    // Unblock
    UnBlock();
#ifdef HAVE_WINTHREAD
    // Wait for thread to terminate itself
    HANDLE hThread = reinterpret_cast<HANDLE>(iThread);
    if (WaitForSingleObject(hThread, 10000) == WAIT_TIMEOUT)
        // ... or kill it in case it refuses to do so
        TerminateThread(hThread, -1);
#elif defined(HAVE_PTHREAD)
    // wait for thread to terminate itself
    // (without security - let's trust these unwashed hackers for once)
    pthread_join(Thread, nullptr);
#endif
    fThread = false;
    // ok
    return;
}

References StdScheduler::UnBlock().

Referenced by Add(), Clear(), main(), Remove(), C4InteractiveThread::RemoveProc(), Set(), and Start().

Here is the call graph for this function:

Here is the caller graph for this function:

UnBlock()

void StdScheduler::UnBlock ( )

inherited

Definition at line 150 of file StdScheduler.cpp.

{
    Unblocker.Notify();
}

Referenced by Stop().

Here is the caller graph for this function:

---

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

• StdScheduler.h
• StdScheduler.cpp