OpenClonk
CStdTimerProc Class Referenceabstract

#include <StdScheduler.h>

Inheritance diagram for CStdTimerProc:
[legend]
Collaboration diagram for CStdTimerProc:
[legend]

Public Member Functions

 CStdTimerProc (uint32_t iDelay)
 
 ~CStdTimerProc () override
 
void Set ()
 
void SetDelay (uint32_t inDelay)
 
bool CheckAndReset ()
 
C4TimeMilliseconds GetNextTick (C4TimeMilliseconds tNow) override
 
uint32_t TimerInterval () override
 
virtual bool Execute (int iTimeout=-1, pollfd *readyfds=nullptr)=0
 
bool ExecuteUntil (int iTimeout=-1)
 
virtual void GetFDs (std::vector< struct pollfd > &)
 
bool IsSignaled ()
 
virtual bool IsLowPriority ()
 
virtual bool IsNotify ()
 

Protected Member Functions

void Changed ()
 

Detailed Description

Definition at line 91 of file StdScheduler.h.

Constructor & Destructor Documentation

◆ CStdTimerProc()

CStdTimerProc::CStdTimerProc ( uint32_t  iDelay)
inline

Definition at line 94 of file StdScheduler.h.

94 : tLastTimer(C4TimeMilliseconds::NegativeInfinity), iDelay(iDelay) { }

◆ ~CStdTimerProc()

CStdTimerProc::~CStdTimerProc ( )
inlineoverride

Definition at line 95 of file StdScheduler.h.

95 { Set(); }

References Set().

Here is the call graph for this function:

Member Function Documentation

◆ Changed()

void StdSchedulerProc::Changed ( )
protectedinherited

Definition at line 108 of file StdScheduler.cpp.

109 {
110  auto s = scheduler;
111  if (s)
112  s->Changed(this);
113 }
#define s

References s.

Referenced by C4NetIOTCP::Accept(), C4NetIOTCP::AddConnectWait(), C4NetIOUDP::AddPeer(), C4NetIOTCP::Listen(), and SetDelay().

Here is the caller graph for this function:

◆ CheckAndReset()

bool CStdTimerProc::CheckAndReset ( )
inline

Definition at line 107 of file StdScheduler.h.

108  {
110  if (tTime < tLastTimer + iDelay) return false;
111  // Compensate light drifting
112  int32_t iDrift = tTime - (tLastTimer + iDelay); // a positive time difference because of above check
113  tLastTimer = tTime - std::min(iDrift, (int32_t) iDelay / 2);
114  return true;
115  }
static C4TimeMilliseconds Now()

References C4TimeMilliseconds::Now().

Referenced by C4Network2::InitialConnect::Execute(), and C4ApplicationSec1Timer::Execute().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Execute()

virtual bool StdSchedulerProc::Execute ( int  iTimeout = -1,
pollfd *  readyfds = nullptr 
)
pure virtualinherited

Implemented in C4ApplicationSec1Timer, C4Network2::InitialConnect, C4NetIO, C4FileMonitor, C4InteractiveThreadNotifyProc, C4StdInProc, C4Network2IO, C4NetIOTCP, C4NetIOUDP, C4NetIOSimpleUDP, and C4HTTPClient.

Referenced by StdSchedulerProc::ExecuteUntil(), and SCHNotify::registerAt:.

Here is the caller graph for this function:

◆ ExecuteUntil()

bool StdSchedulerProc::ExecuteUntil ( int  iTimeout = -1)
inherited

Definition at line 33 of file StdScheduler.cpp.

34 {
35  // Infinite?
36  if (iTimeout < 0)
37  for (;;)
38  if (!Execute())
39  return false;
40  // Calculate endpoint
41  C4TimeMilliseconds tStopTime = C4TimeMilliseconds::Now() + iTimeout;
42  for (;;)
43  {
44  // Call execute with given timeout
45  if (!Execute(std::max(iTimeout, 0)))
46  return false;
47  // Calculate timeout
49  if (tTime >= tStopTime)
50  break;
51  iTimeout = tStopTime - tTime;
52  }
53  // All ok.
54  return true;
55 }
virtual bool Execute(int iTimeout=-1, pollfd *readyfds=nullptr)=0

References StdSchedulerProc::Execute(), and C4TimeMilliseconds::Now().

Referenced by main().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetFDs()

virtual void StdSchedulerProc::GetFDs ( std::vector< struct pollfd > &  )
inlinevirtualinherited

Reimplemented in C4FileMonitor, C4NetIOSimpleUDP, C4NetIOTCP, CStdNotifyProc, C4StdInProc, and C4HTTPClient.

Definition at line 72 of file StdScheduler.h.

72 { }

◆ GetNextTick()

C4TimeMilliseconds CStdTimerProc::GetNextTick ( C4TimeMilliseconds  tNow)
inlineoverridevirtual

Reimplemented from StdSchedulerProc.

Definition at line 118 of file StdScheduler.h.

119  {
120  return tLastTimer + iDelay;
121  }

◆ IsLowPriority()

virtual bool StdSchedulerProc::IsLowPriority ( )
inlinevirtualinherited

Definition at line 82 of file StdScheduler.h.

82 { return false; }

◆ IsNotify()

virtual bool StdSchedulerProc::IsNotify ( )
inlinevirtualinherited

Reimplemented in CStdNotifyProc, and C4NetIO.

Definition at line 83 of file StdScheduler.h.

83 { return false; }

◆ IsSignaled()

bool StdSchedulerProc::IsSignaled ( )
inherited

◆ Set()

void CStdTimerProc::Set ( )
inline

Definition at line 102 of file StdScheduler.h.

103  {
105  }

References C4TimeMilliseconds::NegativeInfinity.

Referenced by ~CStdTimerProc().

Here is the caller graph for this function:

◆ SetDelay()

void CStdTimerProc::SetDelay ( uint32_t  inDelay)
inline

Definition at line 106 of file StdScheduler.h.

106 { iDelay = inDelay; Changed(); }

References StdSchedulerProc::Changed().

Here is the call graph for this function:

◆ TimerInterval()

uint32_t CStdTimerProc::TimerInterval ( )
inlineoverridevirtual

Reimplemented from StdSchedulerProc.

Definition at line 122 of file StdScheduler.h.

122 { return iDelay; }

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