StdScheduler Class Reference

#include <StdScheduler.h>

Inheritance diagram for StdScheduler:

Public Member Functions
	StdScheduler ()
virtual	~StdScheduler ()
int	getProcCnt () const
bool	hasProc (StdSchedulerProc *pProc)
bool	IsInManualLoop ()
void	Clear ()
void	Set (StdSchedulerProc **ppProcs, int iProcCnt)
void	Add (StdSchedulerProc *pProc)
void	Remove (StdSchedulerProc *pProc)
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 220 of file StdScheduler.h.

Constructor & Destructor Documentation

StdScheduler()

StdScheduler::StdScheduler

(

)

Definition at line 59 of file StdScheduler.cpp.

{
    Add(&Unblocker);
}

References Add().

Here is the call graph for this function:

~StdScheduler()

StdScheduler::~StdScheduler ( )

virtual

Definition at line 64 of file StdScheduler.cpp.

{
    Clear();
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

Add()

void StdScheduler::Add

(

StdSchedulerProc *

pProc

)

Definition at line 84 of file StdScheduler.cpp.

{
    // Already added to some scheduler
    if (pProc->scheduler)
        return;
    // Add
    procs.push_back(pProc);
    pProc->scheduler = this;
    
    Added(pProc);
}

References Added().

Referenced by C4GameLobby::ScenDesc::Activate(), C4GameOptionsList::Activate(), C4Network2ResDlg::Activate(), StdSchedulerThread::Add(), C4GameOverDlg::C4GameOverDlg(), C4GameSec1Timer::C4GameSec1Timer(), C4InteractiveThread::C4InteractiveThread(), C4Network2ClientListBox::C4Network2ClientListBox(), C4Network2ClientListDlg::C4Network2ClientListDlg(), C4Network2Stats::C4Network2Stats(), C4StartupModsDlg::C4StartupModsDlg(), C4StartupModsDownloader::C4StartupModsDownloader(), C4StartupNetDlg::C4StartupNetDlg(), C4GameLobby::Countdown::Countdown(), C4Application::DoInit(), C4GUI::InfoDialog::InfoDialog(), C4Network2::InitHost(), C4Network2::InitialConnect::InitialConnect(), C4Network2::InitLeague(), C4AulDebug::Listen(), C4GameLobby::MainDlg::MainDlg(), Set(), C4Network2::StartStreaming(), and StdScheduler().

Here is the call graph for this function:

Here is the caller graph for this function:

Added()

void StdScheduler::Added

(

StdSchedulerProc *

pProc

)

Definition at line 281 of file StdSchedulerMac.mm.

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

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

Referenced by Add().

Here is the call graph for this function:

Here is the caller graph for this function:

Changed()

void StdScheduler::Changed

(

StdSchedulerProc *

pProc

)

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 StdScheduler::Clear

(

)

Definition at line 69 of file StdScheduler.cpp.

{
    while (procs.size() > 0)
        Remove(procs[procs.size()-1]);
}

References Remove().

Referenced by StdSchedulerThread::Clear(), Set(), and ~StdScheduler().

Here is the call graph for this function:

Here is the caller graph for this function:

DoScheduleProcs()

virtual bool StdScheduler::DoScheduleProcs ( int  iTimeout )

protectedvirtual

Reimplemented in C4AbstractApp.

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

Here is the caller graph for this function:

GetNextTick()

C4TimeMilliseconds StdScheduler::GetNextTick

(

C4TimeMilliseconds

tNow

)

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 ScheduleProcs().

Here is the caller graph for this function:

getProcCnt()

int StdScheduler::getProcCnt ( ) const

inline

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 )

inline

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 ( )

inline

Definition at line 247 of file StdScheduler.h.

{ return isInManualLoop; }

OnError()

virtual void StdScheduler::OnError ( StdSchedulerProc *  )

inlineprotectedvirtual

Definition at line 268 of file StdScheduler.h.

{ }

Remove()

void StdScheduler::Remove

(

StdSchedulerProc *

pProc

)

Definition at line 96 of file StdScheduler.cpp.

{
    // :o ?
    if (pProc->scheduler != this)
        return;
    Removing(pProc);
    pProc->scheduler = nullptr;
    auto pos = std::find(procs.begin(), procs.end(), pProc);
    if (pos != procs.end())
        procs.erase(pos);
}

References Removing().

Referenced by C4Network2::Clear(), Clear(), C4Application::Clear(), C4GameLobby::ScenDesc::Deactivate(), C4GameOptionsList::Deactivate(), C4Network2ResDlg::Deactivate(), C4Network2::DeinitLeague(), StdSchedulerThread::Remove(), C4Network2::StopStreaming(), C4AbstractApp::~C4AbstractApp(), C4GameOverDlg::~C4GameOverDlg(), C4GameSec1Timer::~C4GameSec1Timer(), C4InteractiveThread::~C4InteractiveThread(), C4Network2ClientListBox::~C4Network2ClientListBox(), C4Network2ClientListDlg::~C4Network2ClientListDlg(), C4Network2Stats::~C4Network2Stats(), C4StartupModsDlg::~C4StartupModsDlg(), C4StartupModsDownloader::~C4StartupModsDownloader(), C4StartupNetDlg::~C4StartupNetDlg(), C4GameLobby::Countdown::~Countdown(), C4GUI::InfoDialog::~InfoDialog(), and C4GameLobby::MainDlg::~MainDlg().

Here is the call graph for this function:

Here is the caller graph for this function:

Removing()

void StdScheduler::Removing

(

StdSchedulerProc *

pProc

)

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 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

)

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 DoScheduleProcs(), GetNextTick(), and C4TimeMilliseconds::Now().

Referenced by C4AulDebug::DebugStep(), C4Network2::DoLobby(), C4GUI::Dialog::DoModal(), C4ScenarioListLoader::DoProcessCallback(), C4GUI::Dialog::Execute(), C4Network2::FinalInit(), C4Game::InitNetworkFromAddress(), C4Network2::LeagueEnd(), C4Network2::LeaguePlrAuth(), C4Network2::LeaguePlrAuthCheck(), C4Network2::LeagueStart(), C4Network2::LeagueWaitNotBusy(), 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 StdScheduler::Set	(	StdSchedulerProc **	ppProcs,
		int	iProcCnt
	)

Definition at line 75 of file StdScheduler.cpp.

{
    // Remove previous data
    Clear();
    // Copy new
    for (int i = 0; i < inProcCnt; i++)
        Add(ppnProcs[i]);
}

References Add(), and Clear().

Referenced by StdSchedulerThread::Set().

Here is the call graph for this function:

Here is the caller graph for this function:

StartOnCurrentThread()

void StdScheduler::StartOnCurrentThread

(

)

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:

UnBlock()

void StdScheduler::UnBlock

(

)

Definition at line 150 of file StdScheduler.cpp.

{
    Unblocker.Notify();
}

Referenced by StdSchedulerThread::Stop().

Here is the caller graph for this function:

---

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

• StdScheduler.h
• StdScheduler.cpp
• StdSchedulerMac.mm