OpenClonk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
C4GameControlNetwork Class Reference

#include <C4GameControlNetwork.h>

Collaboration diagram for C4GameControlNetwork:
[legend]

Public Member Functions

 C4GameControlNetwork (class C4GameControl *pParent)
 
 ~C4GameControlNetwork ()
 
bool IsEnabled () const
 
bool IsRunning () const
 
bool IsActivated () const
 
int32_t getControlPreSend () const
 
void setControlPreSend (int32_t iToVal)
 
int32_t getAvgControlSendTime () const
 
void setTargetFPS (int32_t iToVal)
 
bool Init (int32_t iClientID, bool fHost, int32_t iStartTick, bool fActivated, C4Network2 *pNetwork)
 
void Clear ()
 
void Execute ()
 
bool CtrlReady (int32_t iTick)
 
bool CtrlOverflow (int32_t iTick) const
 
int32_t GetBehind (int32_t iTick) const
 
bool GetControl (C4Control *pCtrl, int32_t iTick)
 
bool ClientReady (int32_t iClientID, int32_t iTick)
 
int32_t ClientPerfStat (int32_t iClientID)
 
int32_t ClientNextControl (int32_t iClientID)
 
bool CtrlNeeded (int32_t iTick) const
 
void DoInput (const C4Control &Input)
 
void DoInput (C4PacketType eCtrlType, C4ControlPacket *pPkt, enum C4ControlDeliveryType eType)
 
C4ControlDeliveryType DecideControlDelivery () const
 
void ExecSyncControl ()
 
void ExecSyncControl (int32_t iControlTick)
 
void CopyClientList (const C4ClientList &rClients)
 
void SetRunning (bool fnRunning, int32_t inTargetTick=-1)
 
void SetActivated (bool fnActivated)
 
void SetCtrlMode (C4GameControlNetworkMode enMode)
 
C4GameControlNetworkMode GetCtrlMode () const
 
void CalcPerformance (int32_t iCtrlTick)
 
void HandlePacket (char cStatus, const C4PacketBase *pPacket, C4Network2IOConnection *pConn)
 
void OnResComplete (C4Network2Res *pRes)
 

Protected Member Functions

void AddClient (int32_t iClientID, const char *szName)
 
void RemoveClient (int32_t iClientID)
 
void ClearClients ()
 
void HandleControl (int32_t iByClientID, const C4GameControlPacket &rPkt)
 
void HandleControlReq (const C4PacketControlReq &rPkt, C4Network2IOConnection *pConn)
 
void HandleControlPkt (C4PacketType eCtrlType, C4ControlPacket *pPkt, enum C4ControlDeliveryType eType)
 
C4GameControlClientgetClient (int32_t iID)
 
void AddClient (C4GameControlClient *pClient)
 
void RemoveClient (C4GameControlClient *pClient)
 
C4GameControlPacketgetCtrl (int32_t iClientID, int32_t iCtrlTick)
 
void AddCtrl (C4GameControlPacket *pCtrl)
 
void ClearCtrl (int32_t iBeforeTick=-1)
 
void CheckCompleteCtrl (bool fSetEvent)
 
C4GameControlPacketPackCompleteCtrl (int32_t iTick)
 
void AddSyncCtrlToQueue (const C4Control &Ctrl, int32_t iTick)
 
void ExecQueuedSyncCtrl ()
 

Protected Attributes

volatile bool fEnabled
 
volatile bool fRunning
 
int32_t iClientID
 
bool fHost
 
bool fActivated
 
C4GameControlNetworkMode eMode
 
int32_t iTargetTick
 
volatile int32_t iControlPreSend
 
C4TimeMilliseconds tWaitStart
 
int32_t iAvgControlSendTime
 
int32_t iTargetFPS
 
volatile int32_t iControlSent
 
volatile int32_t iControlReady
 
C4GameControlPacketpCtrlStack
 
CStdCSec CtrlCSec
 
C4GameControlClientpClients
 
CStdCSec ClientsCSec
 
C4Control SyncControl
 
C4GameControlPacketpSyncCtrlQueue
 
C4TimeMilliseconds tNextControlRequest
 
C4GameControl *const pParent
 
C4Network2pNetwork
 

Detailed Description

Definition at line 45 of file C4GameControlNetwork.h.

Constructor & Destructor Documentation

C4GameControlNetwork::C4GameControlNetwork ( class C4GameControl pParent)

Definition at line 27 of file C4GameControlNetwork.cpp.

References pParent.

28  : fEnabled(false), fRunning(false), iClientID(C4ClientIDUnknown),
29  fActivated(false), iTargetTick(-1),
32  pCtrlStack(nullptr),
34  pParent(pnParent)
35 {
36  assert(pParent);
37 }
volatile int32_t iControlSent
volatile int32_t iControlPreSend
const int32_t C4ClientIDUnknown
Definition: C4Client.h:24
C4GameControlPacket * pCtrlStack
C4TimeMilliseconds tWaitStart
C4GameControl *const pParent
C4TimeMilliseconds tNextControlRequest
volatile int32_t iControlReady
C4GameControlNetwork::~C4GameControlNetwork ( )

Definition at line 39 of file C4GameControlNetwork.cpp.

References Clear().

40 {
41  Clear();
42 }

Here is the call graph for this function:

Member Function Documentation

void C4GameControlNetwork::AddClient ( int32_t  iClientID,
const char *  szName 
)
protected

Definition at line 306 of file C4GameControlNetwork.cpp.

References Control, C4GameControl::ControlTick, fEnabled, getClient(), C4GameControlClient::Set(), and C4GameControlClient::SetNextControl().

Referenced by CopyClientList().

307 {
308  // security
309  if (!fEnabled || getClient(iClientID)) return;
310  // create new
311  C4GameControlClient *pClient = new C4GameControlClient();
312  pClient->Set(iClientID, szName);
313  pClient->SetNextControl(::Control.ControlTick);
314  // add client
315  AddClient(pClient);
316 }
void SetNextControl(int32_t inNextControl)
int32_t ControlTick
Definition: C4GameControl.h:89
void Set(int32_t iClientID, const char *szName)
C4GameControl Control
C4GameControlClient * getClient(int32_t iID)
void AddClient(int32_t iClientID, const char *szName)

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::AddClient ( C4GameControlClient pClient)
protected

Definition at line 610 of file C4GameControlNetwork.cpp.

References ClientsCSec, C4GameControlClient::getClientID(), pClients, and C4GameControlClient::pNext.

611 {
612  if (!pClient) return;
613  // lock
614  CStdLock ClientsLock(&ClientsCSec);
615  // add (ordered)
616  C4GameControlClient *pPrev = nullptr, *pPos = pClients;
617  for (; pPos; pPrev = pPos, pPos = pPos->pNext)
618  if (pPos->getClientID() > pClient->getClientID())
619  break;
620  // insert
621  (pPrev ? pPrev->pNext : pClients) = pClient;
622  pClient->pNext = pPos;
623 }
C4GameControlClient * pNext
C4GameControlClient * pClients
int32_t getClientID() const

Here is the call graph for this function:

void C4GameControlNetwork::AddCtrl ( C4GameControlPacket pCtrl)
protected

Definition at line 654 of file C4GameControlNetwork.cpp.

References CtrlCSec, pCtrlStack, and C4GameControlPacket::pNext.

Referenced by DoInput(), HandleControl(), and PackCompleteCtrl().

655 {
656  // lock
657  CStdLock CtrlLock(&CtrlCSec);
658  // add to list
659  pCtrl->pNext = pCtrlStack;
660  pCtrlStack = pCtrl;
661 }
C4GameControlPacket * pNext
C4GameControlPacket * pCtrlStack

Here is the caller graph for this function:

void C4GameControlNetwork::AddSyncCtrlToQueue ( const C4Control Ctrl,
int32_t  iTick 
)
protected

Definition at line 802 of file C4GameControlNetwork.cpp.

References C4ClientIDUnknown, C4GameControlPacket::pNext, pSyncCtrlQueue, and C4GameControlPacket::Set().

Referenced by ExecSyncControl().

803 {
804  // search place in queue. It's vitally important that new packets are placed
805  // behind packets for the same tick, so they will be executed in the right order.
806  C4GameControlPacket *pAfter = nullptr, *pBefore = pSyncCtrlQueue;
807  while (pBefore && pBefore->getCtrlTick() <= iTick)
808  { pAfter = pBefore; pBefore = pBefore->pNext; }
809  // create
811  pnPkt->Set(C4ClientIDUnknown, iTick, Ctrl);
812  // insert
813  (pAfter ? pAfter->pNext : pSyncCtrlQueue) = pnPkt;
814  pnPkt->pNext = pBefore;
815 }
C4GameControlPacket * pNext
void Set(int32_t iClientID, int32_t iCtrlTick)
const int32_t C4ClientIDUnknown
Definition: C4Client.h:24
C4GameControlPacket * pSyncCtrlQueue

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::CalcPerformance ( int32_t  iCtrlTick)

Definition at line 388 of file C4GameControlNetwork.cpp.

References C4ClientIDHost, Clamp(), C4Network2::Clients, ClientsCSec, CNM_Decentral, CtrlCSec, CtrlReady(), eMode, C4GraphicsSystem::FlashMessage(), FormatString(), C4Network2ClientList::GetClientByID(), getControlPreSend(), getCtrl(), C4Network2Client::getMsgConn(), C4Network2IOConnection::getPingTime(), C4GameControlPacket::getTime(), GraphicsSystem, iAvgControlSendTime, C4TimeMilliseconds::IsInfinite(), C4Network2Client::isLocal(), iTargetFPS, Network, pClients, C4GameControlClient::pNext, setControlPreSend(), and tWaitStart.

Referenced by GetControl().

389 {
390  CStdLock ControlLock(&CtrlCSec);
391  CStdLock ClientLock(&ClientsCSec);
392  // should only be called if ready
393  assert(CtrlReady(iCtrlTick));
394  // calc perfomance for all clients
395  int32_t iClientsPing=0; int32_t iPingClientCount=0; int32_t iNumTunnels=0; int32_t iHostPing=0;
396  for (C4GameControlClient *pClient = pClients; pClient; pClient = pClient->pNext)
397  {
398  // Some rudimentary PreSend-calculation
399  // get associated connection - nullptr for self
400  C4Network2Client *pNetClt = ::Network.Clients.GetClientByID(pClient->getClientID());
401  if (pNetClt && !pNetClt->isLocal())
402  {
403  C4Network2IOConnection *pConn = pNetClt->getMsgConn();
404  if (!pConn)
405  // remember tunnel
406  ++iNumTunnels;
407  else
408  // store ping
409  if (pClient->getClientID() == C4ClientIDHost)
410  iHostPing = pConn->getPingTime();
411  else
412  {
413  iClientsPing += pConn->getPingTime();
414  ++iPingClientCount;
415  }
416  }
417  // Performance statistics
418  // find control (may not be found, if we only got the complete ctrl)
419  C4GameControlPacket *pCtrl = getCtrl(pClient->getClientID(), iCtrlTick);
420  if (!pCtrl || tWaitStart.IsInfinite()) continue;
421  // calc stats
422  pClient->AddPerf(pCtrl->getTime() - tWaitStart);
423  }
424  // Now do PreSend-calcs based on ping times
425  int32_t iControlSendTime;
426  if (eMode == CNM_Decentral)
427  {
428  // average ping time
429  iControlSendTime = (iClientsPing + iHostPing * (iNumTunnels + 1)) / (iPingClientCount + iNumTunnels + 1);
430  // decentral mode: Only half the ping is used if there are no tunnels
431  if (!iNumTunnels) iControlSendTime /= 2;
432  }
433  else
434  {
435  // central mode: Control must go to host and back
436  iControlSendTime = iHostPing;
437  }
438  // calc some average
439  if (iControlSendTime)
440  {
441  iAvgControlSendTime = (iAvgControlSendTime * 149 + iControlSendTime * 1000) / 150;
442  // now calculate the all-time optimum PreSend there is
443  int32_t iBestPreSend = Clamp((iTargetFPS * iAvgControlSendTime) / 1000000 + 1, 1, 15);
444  // fixed PreSend?
445  if (iTargetFPS <= 0) iBestPreSend = -iTargetFPS;
446  // Ha! Set it!
447  if (getControlPreSend() != iBestPreSend)
448  {
449  setControlPreSend(iBestPreSend);
450  ::GraphicsSystem.FlashMessage(FormatString("PreSend: %d - TargetFPS: %d", iBestPreSend, iTargetFPS).getData());
451  }
452  }
453 }
C4Network2Client * GetClientByID(int32_t iID) const
C4GameControlNetworkMode eMode
C4Network2IOConnection * getMsgConn() const
C4GameControlClient * pNext
bool CtrlReady(int32_t iTick)
T Clamp(T bval, T lbound, T rbound)
Definition: Standard.h:44
C4Network2 Network
Definition: C4Globals.cpp:53
C4GraphicsSystem GraphicsSystem
Definition: C4Globals.cpp:51
int getPingTime() const
Definition: C4Network2IO.h:273
void setControlPreSend(int32_t iToVal)
int32_t getControlPreSend() const
C4TimeMilliseconds tWaitStart
C4Network2ClientList Clients
Definition: C4Network2.h:116
void FlashMessage(const char *szMessage)
bool IsInfinite() const
C4GameControlClient * pClients
bool isLocal() const
C4TimeMilliseconds getTime() const
const int32_t C4ClientIDHost
Definition: C4Client.h:25
StdStrBuf FormatString(const char *szFmt,...)
Definition: StdBuf.cpp:270
C4GameControlPacket * getCtrl(int32_t iClientID, int32_t iCtrlTick)

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::CheckCompleteCtrl ( bool  fSetEvent)
protected

Definition at line 689 of file C4GameControlNetwork.cpp.

References Application, C4Network2ClientList::BroadcastMsgToConnClients(), C4ClientIDAll, C4ControlBacklog, C4ControlRequestInterval, ClearCtrl(), C4Network2::Clients, ClientsCSec, CNM_Central, CNM_Decentral, Control, C4GameControl::ControlTick, CtrlCSec, eMode, fActivated, fEnabled, fHost, fRunning, Game, C4Game::GameGo, C4GameControlPacket::getControl(), getCtrl(), C4GameControlPacket::getCtrlTick(), iControlReady, iControlSent, C4Application::InteractiveThread, iTargetTick, MkC4NetIOPacket(), Network, C4Application::NextTick(), C4TimeMilliseconds::Now(), PackCompleteCtrl(), pClients, PID_ControlReq, C4Control::PreExecute(), pSyncCtrlQueue, C4Network2ClientList::SendMsgToHost(), C4InteractiveThread::ThreadLogS(), and tNextControlRequest.

Referenced by CtrlReady(), DoInput(), HandleControl(), Init(), OnResComplete(), and SetRunning().

690 {
691  // only when running (client list may be invalid)
692  if (!fRunning || !fEnabled) return;
693 
694  CStdLock CtrlLock(&CtrlCSec);
695  CStdLock ClientLock(&ClientsCSec);
696 
697  for (;;)
698  {
699  // control available?
701  // get stop tick
702  int32_t iStopTick = iTargetTick;
703  if (pSyncCtrlQueue)
704  if (iStopTick < 0 || iStopTick > pSyncCtrlQueue->getCtrlTick())
705  iStopTick = pSyncCtrlQueue->getCtrlTick();
706  // pack control?
707  if (!pComplete)
708  {
709  // own control not ready?
710  if (fActivated && iControlSent <= iControlReady) break;
711  // no clients? no need to pack more than one tick into the future
712  if (!pClients && ::Control.ControlTick <= iControlReady) break;
713  // stop packing?
714  if (iStopTick >= 0 && iControlReady + 1 >= iStopTick) break;
715  // central mode and not host?
716  if (eMode != CNM_Decentral && !fHost) break;
717  // (try to) pack
718  if (!(pComplete = PackCompleteCtrl(iControlReady + 1)))
719  break;
720  }
721  // preexecute to check if it's ready for execute
722  if (!pComplete->getControl().PreExecute())
723  break;
724  // ok, control for this tick is ready
725  iControlReady++;
726  // tell the main thread to move on
727  if (fSetEvent && Game.GameGo && iControlReady >= ::Control.ControlTick)
729  }
730  // clear old ctrl
733  // target ctrl tick to reach?
734  if (iControlReady < iTargetTick &&
737  {
738  Application.InteractiveThread.ThreadLogS("Network: Recovering: Requesting control for tick %d...", iControlReady + 1);
739  // make request
741  // send control requests
742  if (eMode == CNM_Central)
744  else
746  // set time for next request
748  }
749 }
const int32_t C4ClientIDAll
bool SendMsgToHost(C4NetIOPacket rPkt)
int32_t ControlTick
Definition: C4GameControl.h:89
C4GameControlNetworkMode eMode
C4Game Game
Definition: C4Globals.cpp:52
C4GameControlPacket * PackCompleteCtrl(int32_t iTick)
bool ThreadLogS(const char *szMessage,...) GNUC_FORMAT_ATTRIBUTE_O
const int32_t C4ControlBacklog
bool PreExecute() const
Definition: C4Control.cpp:90
volatile int32_t iControlSent
C4Network2 Network
Definition: C4Globals.cpp:53
C4GameControl Control
C4NetIOPacket MkC4NetIOPacket(char cStatus, const class C4PacketBase &Pkt, const C4NetIO::addr_t &addr=C4NetIO::addr_t())
Definition: C4PacketBase.h:40
int32_t getCtrlTick() const
void ClearCtrl(int32_t iBeforeTick=-1)
const C4Control & getControl() const
C4Network2ClientList Clients
Definition: C4Network2.h:116
C4GameControlClient * pClients
const uint32_t C4ControlRequestInterval
bool GameGo
Definition: C4Game.h:135
bool BroadcastMsgToConnClients(const C4NetIOPacket &rPkt)
C4TimeMilliseconds tNextControlRequest
volatile int32_t iControlReady
C4GameControlPacket * pSyncCtrlQueue
C4Application Application
Definition: C4Globals.cpp:44
C4InteractiveThread InteractiveThread
Definition: C4Application.h:45
static C4TimeMilliseconds Now()
C4GameControlPacket * getCtrl(int32_t iClientID, int32_t iCtrlTick)

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::Clear ( )

Definition at line 65 of file C4GameControlNetwork.cpp.

References C4Control::Clear(), ClearClients(), ClearCtrl(), fEnabled, fRunning, iAvgControlSendTime, C4GameControlPacket::pNext, pSyncCtrlQueue, and SyncControl.

Referenced by C4GameControl::ChangeToLocal(), C4GameControl::Default(), Init(), and ~C4GameControlNetwork().

66 {
67  fEnabled = false; fRunning = false;
70  // clear sync control
72  while (pSyncCtrlQueue)
73  {
75  pSyncCtrlQueue = pPkt->pNext;
76  delete pPkt;
77  }
78 }
C4GameControlPacket * pNext
void Clear()
Definition: C4Control.cpp:85
void ClearCtrl(int32_t iBeforeTick=-1)
C4GameControlPacket * pSyncCtrlQueue

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::ClearClients ( )
protected

Definition at line 318 of file C4GameControlNetwork.cpp.

References ClientsCSec, pClients, and RemoveClient().

Referenced by Clear(), and CopyClientList().

319 {
320  CStdLock ClientsLock(&ClientsCSec);
321  while (pClients) { C4GameControlClient *pClient = pClients; RemoveClient(pClient); delete pClient; }
322 }
C4GameControlClient * pClients
void RemoveClient(int32_t iClientID)

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::ClearCtrl ( int32_t  iBeforeTick = -1)
protected

Definition at line 663 of file C4GameControlNetwork.cpp.

References CtrlCSec, C4GameControlPacket::getCtrlTick(), pCtrlStack, and C4GameControlPacket::pNext.

Referenced by CheckCompleteCtrl(), and Clear().

664 {
665  // lock
666  CStdLock CtrlLock(&CtrlCSec);
667  // clear all old control
668  C4GameControlPacket *pCtrl = pCtrlStack, *pLast = nullptr;
669  while (pCtrl)
670  {
671  // old?
672  if (iBeforeTick == -1 || pCtrl->getCtrlTick() < iBeforeTick)
673  {
674  // unlink
675  C4GameControlPacket *pDelete = pCtrl;
676  pCtrl = pCtrl->pNext;
677  (pLast ? pLast->pNext : pCtrlStack) = pCtrl;
678  // delete
679  delete pDelete;
680  }
681  else
682  {
683  pLast = pCtrl;
684  pCtrl = pCtrl->pNext;
685  }
686  }
687 }
C4GameControlPacket * pNext
int32_t getCtrlTick() const
C4GameControlPacket * pCtrlStack

Here is the call graph for this function:

Here is the caller graph for this function:

int32_t C4GameControlNetwork::ClientNextControl ( int32_t  iClientID)

Definition at line 135 of file C4GameControlNetwork.cpp.

References ClientsCSec, getClient(), and C4GameControlClient::getNextControl().

Referenced by C4Network2::DrawStatus().

136 {
137  // get client
138  CStdLock ClientsLock(&ClientsCSec);
140  // return performance
141  return pClient ? pClient->getNextControl() : 0;
142 }
C4GameControlClient * getClient(int32_t iID)
int32_t getNextControl() const

Here is the call graph for this function:

Here is the caller graph for this function:

int32_t C4GameControlNetwork::ClientPerfStat ( int32_t  iClientID)

Definition at line 125 of file C4GameControlNetwork.cpp.

References ClientsCSec, CNM_Central, eMode, fHost, getClient(), and C4GameControlClient::getPerfStat().

Referenced by C4Network2::DrawStatus().

126 {
127  if (eMode == CNM_Central && !fHost) return true;
128  // get client
129  CStdLock ClientsLock(&ClientsCSec);
131  // return performance
132  return pClient ? pClient->getPerfStat() : 0;
133 }
C4GameControlNetworkMode eMode
C4GameControlClient * getClient(int32_t iID)
int32_t getPerfStat() const

Here is the call graph for this function:

Here is the caller graph for this function:

bool C4GameControlNetwork::ClientReady ( int32_t  iClientID,
int32_t  iTick 
)

Definition at line 119 of file C4GameControlNetwork.cpp.

References CNM_Central, eMode, fHost, and getCtrl().

Referenced by C4Network2::DrawStatus().

120 {
121  if (eMode == CNM_Central && !fHost) return true;
122  return !!getCtrl(iClientID, iTick);
123 }
C4GameControlNetworkMode eMode
C4GameControlPacket * getCtrl(int32_t iClientID, int32_t iCtrlTick)

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::CopyClientList ( const C4ClientList rClients)

Definition at line 324 of file C4GameControlNetwork.cpp.

References AddClient(), ClearClients(), ClientsCSec, C4ClientList::getClient(), C4Client::getID(), C4Client::getName(), and C4Client::isActivated().

Referenced by ExecQueuedSyncCtrl(), C4Network2::HandleJoinData(), and SetRunning().

325 {
326  CStdLock ClientLock(&ClientsCSec);
327  // create local copy of activated client list
328  ClearClients();
329  C4Client *pClient = nullptr;
330  while ((pClient = rClients.getClient(pClient)))
331  if (pClient->isActivated())
332  AddClient(pClient->getID(), pClient->getName());
333 }
bool isActivated() const
Definition: C4Client.h:110
int32_t getID() const
Definition: C4Client.h:105
const char * getName() const
Definition: C4Client.h:107
void AddClient(int32_t iClientID, const char *szName)
C4Client * getClient(const C4Client *pAfter=nullptr) const
Definition: C4Client.h:160

Here is the call graph for this function:

Here is the caller graph for this function:

bool C4GameControlNetwork::CtrlNeeded ( int32_t  iTick) const

Definition at line 144 of file C4GameControlNetwork.cpp.

References fActivated, C4GameControl::getCtrlTick(), iControlPreSend, iControlSent, IsEnabled(), iTargetTick, and pParent.

Referenced by C4GameControl::Prepare().

145 {
146  if (!IsEnabled() || !fActivated) return false;
147  // check: should we send something at the moment?
148  int32_t iSendFor = pParent->getCtrlTick(iFrame + iControlPreSend);
149  // target tick set? do special check
150  if (iTargetTick >= 0 && iControlSent >= iTargetTick) return false;
151  // control sent for this ctrl tick?
152  return iSendFor > iControlSent;
153 }
volatile int32_t iControlSent
volatile int32_t iControlPreSend
C4GameControl *const pParent
int32_t getCtrlTick(int32_t iFrame) const

Here is the call graph for this function:

Here is the caller graph for this function:

bool C4GameControlNetwork::CtrlOverflow ( int32_t  iTick) const
inline

Definition at line 110 of file C4GameControlNetwork.h.

References C4ControlOverflowLimit.

Referenced by C4GameControl::Ticks().

110 { return fRunning && iControlReady >= iTick + C4ControlOverflowLimit; } // by main thread
volatile int32_t iControlReady
const int32_t C4ControlOverflowLimit

Here is the caller graph for this function:

bool C4GameControlNetwork::CtrlReady ( int32_t  iTick)

Definition at line 93 of file C4GameControlNetwork.cpp.

References CheckCompleteCtrl(), and iControlReady.

Referenced by CalcPerformance(), C4Network2::CheckStatusReached(), and C4GameControl::Prepare().

94 {
95  // check for complete control and pack it
96  CheckCompleteCtrl(false);
97  // control ready?
98  return iControlReady >= iTick;
99 }
void CheckCompleteCtrl(bool fSetEvent)
volatile int32_t iControlReady

Here is the call graph for this function:

Here is the caller graph for this function:

C4ControlDeliveryType C4GameControlNetwork::DecideControlDelivery ( ) const

Definition at line 248 of file C4GameControlNetwork.cpp.

References CDT_Queue, CDT_Sync, C4Game::Clients, fHost, Game, C4ClientList::getLocal(), C4Client::isActivated(), C4Network2::isFrozen(), and Network.

Referenced by C4GameControl::DecideControlDelivery().

249 {
250  // This doesn't make sense for clients
251  if (!fHost)
252  return CDT_Queue;
253  // Decide the fastest control delivery type atm. Note this is a guess.
254  // Control sent with the returned delivery type may in theory be delayed infinitely.
255  if (::Network.isFrozen())
256  return CDT_Sync;
257  if (!Game.Clients.getLocal()->isActivated())
258  return CDT_Sync;
259  return CDT_Queue;
260 }
C4Client * getLocal() const
Definition: C4Client.h:161
C4Game Game
Definition: C4Globals.cpp:52
bool isActivated() const
Definition: C4Client.h:110
C4Network2 Network
Definition: C4Globals.cpp:53
bool isFrozen() const
C4ClientList & Clients
Definition: C4Game.h:69

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::DoInput ( const C4Control Input)

Definition at line 155 of file C4GameControlNetwork.cpp.

References AddCtrl(), Application, C4Network2ClientList::BroadcastMsgToClients(), CheckCompleteCtrl(), C4Network2::Clients, CNM_Decentral, eMode, fEnabled, fHost, iClientID, iControlSent, C4Application::InteractiveThread, MkC4NetIOPacket(), PID_Control, pNetwork, C4Network2ClientList::SendMsgToHost(), C4GameControlPacket::Set(), and C4InteractiveThread::ThreadLog().

Referenced by C4GameControl::DoInput(), HandleControlPkt(), and C4GameControl::Prepare().

156 {
157  if (!fEnabled) return;
158  // pack
160  pCtrl->Set(iClientID, iControlSent+1, Input);
161  // client in central or async mode: send to host (will resend it to the other clients)
162  C4NetIOPacket CtrlPkt = MkC4NetIOPacket(PID_Control, *pCtrl);
163  if (eMode != CNM_Decentral)
164  {
165  if (!fHost)
166  if (!pNetwork->Clients.SendMsgToHost(CtrlPkt))
167  Application.InteractiveThread.ThreadLog("Failed to send control to host!");
168  }
169  // decentral mode: always broadcast to everybody
170  else
171  {
172  assert (eMode == CNM_Decentral);
173  if (!pNetwork->Clients.BroadcastMsgToClients(CtrlPkt))
174  Application.InteractiveThread.ThreadLog("Failed to broadcast control!");
175  }
176  // add to list
177  AddCtrl(pCtrl);
178  // ok, control is sent for this control tick
179  iControlSent++;
180  // ctrl complete?
181  CheckCompleteCtrl(false);
182 }
bool SendMsgToHost(C4NetIOPacket rPkt)
C4GameControlNetworkMode eMode
void AddCtrl(C4GameControlPacket *pCtrl)
bool BroadcastMsgToClients(const C4NetIOPacket &rPkt)
void Set(int32_t iClientID, int32_t iCtrlTick)
bool ThreadLog(const char *szMessage,...) GNUC_FORMAT_ATTRIBUTE_O
volatile int32_t iControlSent
C4NetIOPacket MkC4NetIOPacket(char cStatus, const class C4PacketBase &Pkt, const C4NetIO::addr_t &addr=C4NetIO::addr_t())
Definition: C4PacketBase.h:40
C4Network2ClientList Clients
Definition: C4Network2.h:116
void CheckCompleteCtrl(bool fSetEvent)
C4Application Application
Definition: C4Globals.cpp:44
C4InteractiveThread InteractiveThread
Definition: C4Application.h:45

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::DoInput ( C4PacketType  eCtrlType,
C4ControlPacket pPkt,
enum C4ControlDeliveryType  eType 
)

Definition at line 184 of file C4GameControlNetwork.cpp.

References C4Control::Add(), C4Network2ClientList::BroadcastMsgToClients(), CDT_Direct, CDT_Private, CDT_Sync, C4Network2::Clients, C4GameControl::ControlTick, C4GameControl::ExecControlPacket(), fEnabled, fHost, C4Network2::isFrozen(), LogFatal(), MkC4NetIOPacket(), Network, PID_ControlPkt, PID_ExecSyncCtrl, pParent, C4Network2ClientList::SendMsgToHost(), C4Network2::Sync(), and SyncControl.

185 {
186  if (!fEnabled) return;
187 
188  // Create packet
189  C4PacketControlPkt CtrlPkt(eDelivery, C4IDPacket(eCtrlType, pCtrl, false));
190 
191  switch (eDelivery)
192  {
193 
194  // Sync control
195  case CDT_Sync:
196  {
197  if (!fHost)
198  {
199  // Client: send to host
201  { LogFatal("Network: could not send direct control packet!"); break; }
202  delete pCtrl;
203  }
204  else
205  {
206  // Host: send to all clients
208  // Execute at once, if possible
209  if (::Network.isFrozen())
210  {
211  pParent->ExecControlPacket(eCtrlType, pCtrl);
212  delete pCtrl;
215  }
216  else
217  {
218  // Safe back otherwise
219  SyncControl.Add(eCtrlType, pCtrl);
220  // And sync
221  ::Network.Sync();
222  }
223  }
224  }
225  break;
226 
227  // Direct/private control:
228  case CDT_Direct:
229  case CDT_Private:
230  {
231  // Send to all clients
233  { LogFatal("Network: could not send direct control packet!"); break; }
234  // Exec at once
235  pParent->ExecControlPacket(eCtrlType, pCtrl);
236  delete pCtrl;
237  }
238  break;
239 
240  // Only some delivery types support single packets (queue control must be tick-stamped)
241  default:
242  assert(false);
243 
244  }
245 
246 }
bool SendMsgToHost(C4NetIOPacket rPkt)
int32_t ControlTick
Definition: C4GameControl.h:89
bool BroadcastMsgToClients(const C4NetIOPacket &rPkt)
void Add(C4PacketType eType, C4ControlPacket *pCtrl)
Definition: C4Control.h:82
void ExecControlPacket(C4PacketType eCtrlType, class C4ControlPacket *pPkt)
C4Network2 Network
Definition: C4Globals.cpp:53
C4NetIOPacket MkC4NetIOPacket(char cStatus, const class C4PacketBase &Pkt, const C4NetIO::addr_t &addr=C4NetIO::addr_t())
Definition: C4PacketBase.h:40
bool isFrozen() const
bool LogFatal(const char *szMessage)
Definition: C4Log.cpp:227
C4Network2ClientList Clients
Definition: C4Network2.h:116
C4GameControl *const pParent
bool Sync()
Definition: C4Network2.cpp:520

Here is the call graph for this function:

void C4GameControlNetwork::ExecQueuedSyncCtrl ( )
protected

Definition at line 817 of file C4GameControlNetwork.cpp.

References C4Game::Clients, C4GameControl::ControlTick, CopyClientList(), C4GameControl::ExecControl(), Game, C4GameControlPacket::getControl(), C4GameControlPacket::getCtrlTick(), LogF(), C4GameControlPacket::pNext, pParent, and pSyncCtrlQueue.

Referenced by Execute(), and HandleControlPkt().

818 {
819  // security
821  {
822  LogF("Network: Fatal: got sync control to execute for ctrl tick %d, but already in ctrl tick %d!", pSyncCtrlQueue->getCtrlTick(), pParent->ControlTick);
823  // remove it
825  pSyncCtrlQueue = pPkt->pNext;
826  delete pPkt;
827  }
828  // nothing to do?
830  return;
831  // this should hold by now
833  do
834  {
835  // execute it
837  // remove the packet
839  pSyncCtrlQueue = pPkt->pNext;
840  delete pPkt;
841  }
843  // refresh copy of client list
845 }
int32_t ControlTick
Definition: C4GameControl.h:89
C4Game Game
Definition: C4Globals.cpp:52
C4GameControlPacket * pNext
void CopyClientList(const C4ClientList &rClients)
int32_t getCtrlTick() const
const C4Control & getControl() const
C4GameControl *const pParent
C4ClientList & Clients
Definition: C4Game.h:69
void ExecControl(const C4Control &rCtrl)
C4GameControlPacket * pSyncCtrlQueue
bool LogF(const char *strMessage,...)
Definition: C4Log.cpp:250

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::ExecSyncControl ( )

Definition at line 262 of file C4GameControlNetwork.cpp.

References C4Network2ClientList::BroadcastMsgToClients(), C4Network2::Clients, C4GameControl::ControlTick, fHost, C4Control::firstPkt(), C4PacketExecSyncCtrl::getControlTick(), MkC4NetIOPacket(), Network, PID_ExecSyncCtrl, pParent, and SyncControl.

Referenced by C4Network2::CheckStatusAck(), and HandlePacket().

263 {
264  assert(fHost);
265 
266  // This is a callback from C4Network informing that a point where accumulated sync control
267  // can be executed has been reached (it's "momentarily" safe to execute)
268 
269  // Nothing to do? Save some sweat.
270  if (!SyncControl.firstPkt())
271  return;
272 
273  // So let's spread the word, so clients will call ExecSyncControl, too.
276 
277  // Execute it
278  ExecSyncControl(Pkt.getControlTick());
279 
280 }
C4IDPacket * firstPkt() const
Definition: C4Control.h:78
int32_t ControlTick
Definition: C4GameControl.h:89
bool BroadcastMsgToClients(const C4NetIOPacket &rPkt)
C4Network2 Network
Definition: C4Globals.cpp:53
C4NetIOPacket MkC4NetIOPacket(char cStatus, const class C4PacketBase &Pkt, const C4NetIO::addr_t &addr=C4NetIO::addr_t())
Definition: C4PacketBase.h:40
C4Network2ClientList Clients
Definition: C4Network2.h:116
C4GameControl *const pParent

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::ExecSyncControl ( int32_t  iControlTick)

Definition at line 282 of file C4GameControlNetwork.cpp.

References AddSyncCtrlToQueue(), C4Control::Clear(), Control, C4GameControl::ControlTick, C4GameControl::ExecControl(), C4Control::firstPkt(), LogF(), pParent, and SyncControl.

283 {
284  // Nothing to do?
285  if (!SyncControl.firstPkt())
286  return;
287 
288  // Copy control and clear
290  SyncControl.Clear();
291 
292  // Given control tick reached?
293  if (pParent->ControlTick == iControlTick)
294  pParent->ExecControl(Control);
295 
296  else if (pParent->ControlTick > iControlTick)
297  // The host should make sure this doesn't happen.
298  LogF("Network: Fatal: got sync control to execute for ctrl tick %d, but already in ctrl tick %d!", iControlTick, pParent->ControlTick);
299 
300  else
301  // This sync control must be executed later, so safe it back
302  AddSyncCtrlToQueue(Control, iControlTick);
303 
304 }
C4IDPacket * firstPkt() const
Definition: C4Control.h:78
int32_t ControlTick
Definition: C4GameControl.h:89
C4GameControl Control
void Clear()
Definition: C4Control.cpp:85
void AddSyncCtrlToQueue(const C4Control &Ctrl, int32_t iTick)
C4GameControl *const pParent
void ExecControl(const C4Control &rCtrl)
bool LogF(const char *strMessage,...)
Definition: C4Log.cpp:250

Here is the call graph for this function:

void C4GameControlNetwork::Execute ( )

Definition at line 80 of file C4GameControlNetwork.cpp.

References Control, C4GameControl::ControlRate, ExecQueuedSyncCtrl(), C4Game::FrameCounter, Game, C4TimeMilliseconds::Now(), and tWaitStart.

Referenced by C4GameControl::Prepare().

81 {
82  // Control ticks only
84  return;
85 
86  // Save time the control tick was reached
88 
89  // Execute any queued sync control
91 }
C4Game Game
Definition: C4Globals.cpp:52
int32_t FrameCounter
Definition: C4Game.h:128
C4GameControl Control
C4TimeMilliseconds tWaitStart
static C4TimeMilliseconds Now()
int32_t ControlRate
Definition: C4GameControl.h:88

Here is the call graph for this function:

Here is the caller graph for this function:

int32_t C4GameControlNetwork::getAvgControlSendTime ( ) const
inline

Definition at line 101 of file C4GameControlNetwork.h.

References iAvgControlSendTime.

Referenced by C4Network2::DrawStatus(), and C4Network2ClientListDlg::Update().

101 { return iAvgControlSendTime; }

Here is the caller graph for this function:

int32_t C4GameControlNetwork::GetBehind ( int32_t  iTick) const
inline

Definition at line 111 of file C4GameControlNetwork.h.

Referenced by C4Network2::DrawStatus(), C4GameControl::Ticks(), and C4Network2ClientListDlg::Update().

111 { return iControlReady - iTick + 1; } // by main thread
volatile int32_t iControlReady

Here is the caller graph for this function:

C4GameControlClient * C4GameControlNetwork::getClient ( int32_t  iID)
protected

Definition at line 601 of file C4GameControlNetwork.cpp.

References ClientsCSec, pClients, and C4GameControlClient::pNext.

Referenced by AddClient(), ClientNextControl(), and ClientPerfStat().

602 {
603  CStdLock ClientsLock(&ClientsCSec);
604  for (C4GameControlClient *pClient = pClients; pClient; pClient = pClient->pNext)
605  if (pClient->getClientID() == iID)
606  return pClient;
607  return nullptr;
608 }
C4GameControlClient * pNext
C4GameControlClient * pClients

Here is the caller graph for this function:

bool C4GameControlNetwork::GetControl ( C4Control pCtrl,
int32_t  iTick 
)

Definition at line 101 of file C4GameControlNetwork.cpp.

References C4Control::Append(), C4ClientIDAll, CalcPerformance(), C4Control::Clear(), CtrlCSec, C4GameControlPacket::getControl(), getCtrl(), C4TimeMilliseconds::PositiveInfinity, and tWaitStart.

Referenced by C4GameControl::Execute().

102 {
103  // lock
104  CStdLock CtrlLock(&CtrlCSec);
105  // look for control
106  C4GameControlPacket *pPkt = getCtrl(C4ClientIDAll, iTick);
107  if (!pPkt)
108  return false;
109  // set
110  pCtrl->Clear();
111  pCtrl->Append(pPkt->getControl());
112  // calc performance
113  CalcPerformance(iTick);
115  // ok
116  return true;
117 }
const int32_t C4ClientIDAll
void Clear()
Definition: C4Control.cpp:85
C4TimeMilliseconds tWaitStart
const C4Control & getControl() const
void Append(const C4Control &Ctrl)
Definition: C4Control.h:85
void CalcPerformance(int32_t iCtrlTick)
C4GameControlPacket * getCtrl(int32_t iClientID, int32_t iCtrlTick)

Here is the call graph for this function:

Here is the caller graph for this function:

int32_t C4GameControlNetwork::getControlPreSend ( ) const
inline

Definition at line 99 of file C4GameControlNetwork.h.

References iControlPreSend.

Referenced by CalcPerformance(), C4Network2::DrawStatus(), and C4Network2ClientListDlg::Update().

99 { return iControlPreSend; }
volatile int32_t iControlPreSend

Here is the caller graph for this function:

C4GameControlPacket * C4GameControlNetwork::getCtrl ( int32_t  iClientID,
int32_t  iCtrlTick 
)
protected

Definition at line 643 of file C4GameControlNetwork.cpp.

References CtrlCSec, pCtrlStack, and C4GameControlPacket::pNext.

Referenced by CalcPerformance(), CheckCompleteCtrl(), ClientReady(), GetControl(), HandleControl(), HandleControlReq(), PackCompleteCtrl(), and SetCtrlMode().

644 {
645  // lock
646  CStdLock CtrlLock(&CtrlCSec);
647  // search
648  for (C4GameControlPacket *pCtrl = pCtrlStack; pCtrl; pCtrl = pCtrl->pNext)
649  if (pCtrl->getClientID() == iClientID && pCtrl->getCtrlTick() == iCtrlTick)
650  return pCtrl;
651  return nullptr;
652 }
C4GameControlPacket * pNext
C4GameControlPacket * pCtrlStack

Here is the caller graph for this function:

C4GameControlNetworkMode C4GameControlNetwork::GetCtrlMode ( ) const
inline

Definition at line 133 of file C4GameControlNetwork.h.

References eMode.

133 { return eMode; } // by main thread
C4GameControlNetworkMode eMode
void C4GameControlNetwork::HandleControl ( int32_t  iByClientID,
const C4GameControlPacket rPkt 
)
protected

Definition at line 525 of file C4GameControlNetwork.cpp.

References AddCtrl(), CheckCompleteCtrl(), C4GameControlPacket::getClientID(), getCtrl(), C4GameControlPacket::getCtrlTick(), and IsEnabled().

Referenced by HandlePacket().

526 {
527  // already got that control? just ignore
528  if (getCtrl(rPkt.getClientID(), rPkt.getCtrlTick())) return;
529  // create copy, add to list
530  C4GameControlPacket *pCopy = new C4GameControlPacket(rPkt);
531  AddCtrl(pCopy);
532  // check: control complete?
533  if (IsEnabled())
534  CheckCompleteCtrl(true);
535  // note that C4GameControlNetwork will save incoming control even before
536  // Init() was called.
537 }
void AddCtrl(C4GameControlPacket *pCtrl)
int32_t getCtrlTick() const
int32_t getClientID() const
void CheckCompleteCtrl(bool fSetEvent)
C4GameControlPacket * getCtrl(int32_t iClientID, int32_t iCtrlTick)

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::HandleControlPkt ( C4PacketType  eCtrlType,
C4ControlPacket pPkt,
enum C4ControlDeliveryType  eType 
)
protected

Definition at line 566 of file C4GameControlNetwork.cpp.

References C4Control::Add(), CDT_Direct, CDT_Private, CDT_Sync, DoInput(), C4GameControl::ExecControlPacket(), ExecQueuedSyncCtrl(), fHost, C4Network2::isFrozen(), Network, pParent, and SyncControl.

Referenced by HandlePacket().

567 {
568 
569  // direct control? execute at once
570  if (eType == CDT_Direct || eType == CDT_Private)
571  {
572  pParent->ExecControlPacket(eCtrlType, pCtrl);
573  delete pCtrl;
574  return;
575  }
576 
577  // sync ctrl from client? resend
578  if (fHost && eType == CDT_Sync)
579  {
580  DoInput(eCtrlType, pCtrl, eType);
581  return;
582  }
583 
584  // Execute queued control first
586 
587  // Execute at once, if possible
588  if (::Network.isFrozen())
589  {
590  pParent->ExecControlPacket(eCtrlType, pCtrl);
591  delete pCtrl;
592  }
593  else
594  {
595  // Safe back otherwise
596  SyncControl.Add(eCtrlType, pCtrl);
597  }
598 
599 }
void DoInput(const C4Control &Input)
void Add(C4PacketType eType, C4ControlPacket *pCtrl)
Definition: C4Control.h:82
void ExecControlPacket(C4PacketType eCtrlType, class C4ControlPacket *pPkt)
C4Network2 Network
Definition: C4Globals.cpp:53
bool isFrozen() const
C4GameControl *const pParent

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::HandleControlReq ( const C4PacketControlReq rPkt,
C4Network2IOConnection pConn 
)
protected

Definition at line 539 of file C4GameControlNetwork.cpp.

References C4ClientIDAll, CtrlCSec, getCtrl(), C4GameControlPacket::getCtrlTick(), C4PacketControlReq::getCtrlTick(), MkC4NetIOPacket(), pCtrlStack, PID_Control, C4GameControlPacket::pNext, and C4Network2IOConnection::Send().

Referenced by HandlePacket().

540 {
541  CStdLock CtrlLock(&CtrlCSec);
542  for (int iTick = rPkt.getCtrlTick(); ; iTick++)
543  {
544  // search complete control
545  C4GameControlPacket *pCtrl = getCtrl(C4ClientIDAll, iTick);
546  if (pCtrl)
547  {
548  // send
549  pConn->Send(MkC4NetIOPacket(PID_Control, *pCtrl));
550  continue;
551  }
552  // send everything we have for this tick (this is an emergency case, so efficiency
553  // isn't that important for now).
554  bool fFound = false;
555  for (pCtrl = pCtrlStack; pCtrl; pCtrl = pCtrl->pNext)
556  if (pCtrl->getCtrlTick() == iTick)
557  {
558  pConn->Send(MkC4NetIOPacket(PID_Control, *pCtrl));
559  fFound = true;
560  }
561  // nothing found for this tick?
562  if (!fFound) break;
563  }
564 }
const int32_t C4ClientIDAll
int32_t getCtrlTick() const
C4GameControlPacket * pNext
bool Send(const C4NetIOPacket &rPkt)
C4NetIOPacket MkC4NetIOPacket(char cStatus, const class C4PacketBase &Pkt, const C4NetIO::addr_t &addr=C4NetIO::addr_t())
Definition: C4PacketBase.h:40
int32_t getCtrlTick() const
C4GameControlPacket * pCtrlStack
C4GameControlPacket * getCtrl(int32_t iClientID, int32_t iCtrlTick)

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::HandlePacket ( char  cStatus,
const C4PacketBase pPacket,
C4Network2IOConnection pConn 
)

Definition at line 455 of file C4GameControlNetwork.cpp.

References CID_First, ExecSyncControl(), fEnabled, C4Network2IOConnection::getClientID(), GETPKT, HandleControl(), HandleControlPkt(), HandleControlReq(), C4Network2IOConnection::isAccepted(), C4Network2IOConnection::isClosed(), IsEnabled(), C4Network2IOConnection::isHost(), PID_Control, PID_ControlPkt, PID_ControlReq, and PID_ExecSyncCtrl.

Referenced by C4Network2IO::CallHandlers().

456 {
457  // security
458  if (!pConn)
459  return;
460 
461 #define GETPKT(type, name) \
462  assert(pPacket); const type &name = \
463  static_cast<const type &>(*pPacket);
464 
465  switch (cStatus)
466  {
467 
468  case PID_Control: // control
469  {
471  HandleControl(pConn->getClientID(), rPkt);
472  }
473  break;
474 
475  case PID_ControlReq: // control request
476  {
477  if (!IsEnabled()) break;
478  if (pConn->isClosed() || !pConn->isAccepted()) break;
480  HandleControlReq(rPkt, pConn);
481  }
482  break;
483 
484  case PID_ControlPkt: // single control packet (main thread!)
485  {
487  // security
488  if (!fEnabled) break;
489  if (rPkt.getCtrl().getPktType() < CID_First) break;
490  // create copy (HandleControlPkt will store or delete)
491  C4IDPacket Copy(rPkt.getCtrl());
492  // some sanity checks
493  C4ControlPacket *pCtrlPkt = static_cast<C4ControlPacket *>(Copy.getPkt());
494  if (!pConn->isHost() && pConn->getClientID() != pCtrlPkt->getByClient())
495  break;
496  // handle
497  HandleControlPkt(Copy.getPktType(), pCtrlPkt, rPkt.getDelivery());
498  Copy.Default();
499  }
500  break;
501 
502  case PID_ExecSyncCtrl:
503  {
505  // security
506  if (!fEnabled) break;
507  // handle
508  ExecSyncControl(rPkt.getControlTick());
509  }
510  break;
511 
512  }
513 
514 #undef GETPKT
515 }
bool isAccepted() const
Definition: C4Network2IO.h:287
void HandleControl(int32_t iByClientID, const C4GameControlPacket &rPkt)
#define GETPKT(type, name)
void HandleControlReq(const C4PacketControlReq &rPkt, C4Network2IOConnection *pConn)
bool isClosed() const
Definition: C4Network2IO.h:288
void HandleControlPkt(C4PacketType eCtrlType, C4ControlPacket *pPkt, enum C4ControlDeliveryType eType)
C4GameControlPacket * getCtrl(int32_t iClientID, int32_t iCtrlTick)

Here is the call graph for this function:

Here is the caller graph for this function:

bool C4GameControlNetwork::Init ( int32_t  iClientID,
bool  fHost,
int32_t  iStartTick,
bool  fActivated,
C4Network2 pNetwork 
)

Definition at line 44 of file C4GameControlNetwork.cpp.

References C4Network2ClientList::BroadcastMsgToConnClients(), C4ControlRequestInterval, CheckCompleteCtrl(), Clear(), C4Network2::Clients, Control, C4GameControl::ControlTick, fActivated, fEnabled, fHost, fRunning, C4GameControl::getNextControlTick(), iClientID, iControlReady, iControlSent, IsEnabled(), iTargetFPS, MkC4NetIOPacket(), C4TimeMilliseconds::Now(), PID_ControlReq, pNetwork, C4TimeMilliseconds::PositiveInfinity, tNextControlRequest, and tWaitStart.

Referenced by C4Network2::HandleJoinData(), and C4Network2::InitHost().

45 {
46  if (IsEnabled()) Clear();
47  // init
48  iClientID = inClientID; fHost = fnHost;
49  ::Control.ControlTick = iStartTick;
51  fActivated = fnActivated;
52  pNetwork = pnNetwork;
53  // check
54  CheckCompleteCtrl(false);
55  // make sure no control has been lost
57  // ok
58  fEnabled = true; fRunning = false;
59  iTargetFPS = 38;
62  return true;
63 }
int32_t ControlTick
Definition: C4GameControl.h:89
volatile int32_t iControlSent
C4GameControl Control
C4NetIOPacket MkC4NetIOPacket(char cStatus, const class C4PacketBase &Pkt, const C4NetIO::addr_t &addr=C4NetIO::addr_t())
Definition: C4PacketBase.h:40
C4TimeMilliseconds tWaitStart
C4Network2ClientList Clients
Definition: C4Network2.h:116
void CheckCompleteCtrl(bool fSetEvent)
const uint32_t C4ControlRequestInterval
int32_t getNextControlTick() const
bool BroadcastMsgToConnClients(const C4NetIOPacket &rPkt)
C4TimeMilliseconds tNextControlRequest
volatile int32_t iControlReady
static C4TimeMilliseconds Now()

Here is the call graph for this function:

Here is the caller graph for this function:

bool C4GameControlNetwork::IsActivated ( ) const
inline

Definition at line 97 of file C4GameControlNetwork.h.

References fActivated.

97 { return fActivated; }
bool C4GameControlNetwork::IsEnabled ( ) const
inline

Definition at line 95 of file C4GameControlNetwork.h.

References fEnabled.

Referenced by CtrlNeeded(), HandleControl(), HandlePacket(), Init(), C4GameControl::InitNetwork(), and C4Network2::OnStatusReached().

95 { return fEnabled; }

Here is the caller graph for this function:

bool C4GameControlNetwork::IsRunning ( ) const
inline

Definition at line 96 of file C4GameControlNetwork.h.

References fRunning.

96 { return fRunning; }
void C4GameControlNetwork::OnResComplete ( C4Network2Res pRes)

Definition at line 517 of file C4GameControlNetwork.cpp.

References CheckCompleteCtrl(), C4Network2Res::getType(), and NRT_Player.

Referenced by C4Network2ResList::OnResComplete().

518 {
519  // player?
520  if (pRes->getType() == NRT_Player)
521  // check for ctrl ready
522  CheckCompleteCtrl(true);
523 }
C4Network2ResType getType() const
void CheckCompleteCtrl(bool fSetEvent)

Here is the call graph for this function:

Here is the caller graph for this function:

C4GameControlPacket * C4GameControlNetwork::PackCompleteCtrl ( int32_t  iTick)
protected

Definition at line 751 of file C4GameControlNetwork.cpp.

References C4GameControlPacket::Add(), AddCtrl(), C4ConfigNetwork::AsyncMaxWait, C4Network2ClientList::BroadcastMsgToConnClients(), C4ClientIDAll, C4ControlRequestInterval, C4Network2::Clients, ClientsCSec, CNM_Async, CNM_Decentral, Config, CtrlCSec, eMode, C4GameControlClient::getClientID(), getCtrl(), C4GameControlClient::getNextControl(), iTargetFPS, MkC4NetIOPacket(), Network, C4Config::Network, C4TimeMilliseconds::Now(), pClients, PID_Control, C4GameControlClient::pNext, C4GameControlPacket::Set(), C4GameControlClient::SetNextControl(), tNextControlRequest, and tWaitStart.

Referenced by CheckCompleteCtrl().

752 {
753  CStdLock CtrlLock(&CtrlCSec);
754  CStdLock ClientLock(&ClientsCSec);
755 
756  // check if ctrl by all clients is ready
757  C4GameControlClient *pClient;
758  for (pClient = pClients; pClient; pClient = pClient->pNext)
759  if (!getCtrl(pClient->getClientID(), iTick))
760  break;
761  if (pClient)
762  {
763  // async mode: wait n extra frames for slow clients
764  const int iMaxWait = (Config.Network.AsyncMaxWait * 1000) / iTargetFPS;
765  if (eMode != CNM_Async || C4TimeMilliseconds::Now() <= tWaitStart + iMaxWait)
766  return nullptr;
767  }
768 
769  // create packet
770  C4GameControlPacket *pComplete = new C4GameControlPacket();
771  pComplete->Set(C4ClientIDAll, iTick);
772 
773  // pack everything in ID order (client list is ordered this way)
774  C4GameControlPacket *pCtrl;
775  for (pClient = pClients; pClient; pClient = pClient->pNext)
776  while (pClient->getNextControl() <= iTick)
777  {
778  // get control
779  int32_t iNextControl = pClient->getNextControl();
780  pCtrl = getCtrl(pClient->getClientID(), iNextControl);
781  if (!pCtrl) break;
782  pClient->SetNextControl(iNextControl + 1);
783  assert(pCtrl);
784  // add
785  pComplete->Add(*pCtrl);
786  }
787 
788  // add to list
789  AddCtrl(pComplete);
790 
791  // host: send to clients (central and async mode)
792  if (eMode != CNM_Decentral)
794 
795  // advance control request time
797 
798  // return
799  return pComplete;
800 }
const int32_t C4ClientIDAll
C4Config Config
Definition: C4Config.cpp:833
void SetNextControl(int32_t inNextControl)
C4GameControlNetworkMode eMode
void AddCtrl(C4GameControlPacket *pCtrl)
void Set(int32_t iClientID, int32_t iCtrlTick)
C4GameControlClient * pNext
C4Network2 Network
Definition: C4Globals.cpp:53
C4NetIOPacket MkC4NetIOPacket(char cStatus, const class C4PacketBase &Pkt, const C4NetIO::addr_t &addr=C4NetIO::addr_t())
Definition: C4PacketBase.h:40
C4ConfigNetwork Network
Definition: C4Config.h:255
int32_t getNextControl() const
C4TimeMilliseconds tWaitStart
C4Network2ClientList Clients
Definition: C4Network2.h:116
C4GameControlClient * pClients
const uint32_t C4ControlRequestInterval
int32_t AsyncMaxWait
Definition: C4Config.h:167
int32_t getClientID() const
bool BroadcastMsgToConnClients(const C4NetIOPacket &rPkt)
C4TimeMilliseconds tNextControlRequest
static C4TimeMilliseconds Now()
void Add(const C4GameControlPacket &Ctrl)
C4GameControlPacket * getCtrl(int32_t iClientID, int32_t iCtrlTick)

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::RemoveClient ( int32_t  iClientID)
protected

Referenced by ClearClients().

Here is the caller graph for this function:

void C4GameControlNetwork::RemoveClient ( C4GameControlClient pClient)
protected

Definition at line 625 of file C4GameControlNetwork.cpp.

References ClientsCSec, pClients, and C4GameControlClient::pNext.

626 {
627  // obtain lock
628  CStdLock ClientsLock(&ClientsCSec);
629  // first client?
630  if (pClient == pClients)
631  pClients = pClient->pNext;
632  else
633  {
634  C4GameControlClient *pPrev;
635  for (pPrev = pClients; pPrev && pPrev->pNext; pPrev = pPrev->pNext)
636  if (pPrev->pNext == pClient)
637  break;
638  if (pPrev && pPrev->pNext == pClient)
639  pPrev->pNext = pClient->pNext;
640  }
641 }
C4GameControlClient * pNext
C4GameControlClient * pClients
void C4GameControlNetwork::SetActivated ( bool  fnActivated)

Definition at line 354 of file C4GameControlNetwork.cpp.

References Control, fActivated, fEnabled, C4GameControl::getNextControlTick(), and iControlSent.

Referenced by C4GameControl::SetActivated().

355 {
356  assert(fEnabled);
357  // no change? ignore
358  if (fActivated == fnActivated) return;
359  // set
360  fActivated = fnActivated;
361  // Activated? Start to send control at next tick
362  if (fActivated)
364 }
volatile int32_t iControlSent
C4GameControl Control
int32_t getNextControlTick() const

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::setControlPreSend ( int32_t  iToVal)
inline

Definition at line 100 of file C4GameControlNetwork.h.

References C4MaxPreSend.

Referenced by CalcPerformance().

100 { iControlPreSend = std::min(iToVal, C4MaxPreSend); }
volatile int32_t iControlPreSend
const int32_t C4MaxPreSend

Here is the caller graph for this function:

void C4GameControlNetwork::SetCtrlMode ( C4GameControlNetworkMode  enMode)

Definition at line 366 of file C4GameControlNetwork.cpp.

References C4Network2ClientList::BroadcastMsgToClients(), C4ClientIDAll, C4Network2::Clients, CNM_Central, CNM_Decentral, Control, C4GameControl::ControlTick, CtrlCSec, eMode, fEnabled, fHost, getCtrl(), iClientID, MkC4NetIOPacket(), Network, and PID_Control.

Referenced by C4Network2::OnStatusAck().

367 {
368  assert(fEnabled);
369  // no change?
370  if (eMode == enMode) return;
371  // set mode
372  eMode = enMode;
373  // changed to decentral? rebroadcast all own control
374  if (enMode == CNM_Decentral)
375  {
376  CStdLock CtrlLock(&CtrlCSec); C4GameControlPacket *pPkt;
377  for (int32_t iCtrlTick = ::Control.ControlTick; (pPkt = getCtrl(iClientID, iCtrlTick)); iCtrlTick++)
379  }
380  else if (enMode == CNM_Central && fHost)
381  {
382  CStdLock CtrlLock(&CtrlCSec); C4GameControlPacket *pPkt;
383  for (int32_t iCtrlTick = ::Control.ControlTick; (pPkt = getCtrl(C4ClientIDAll, iCtrlTick)); iCtrlTick++)
385  }
386 }
const int32_t C4ClientIDAll
int32_t ControlTick
Definition: C4GameControl.h:89
C4GameControlNetworkMode eMode
bool BroadcastMsgToClients(const C4NetIOPacket &rPkt)
C4Network2 Network
Definition: C4Globals.cpp:53
C4GameControl Control
C4NetIOPacket MkC4NetIOPacket(char cStatus, const class C4PacketBase &Pkt, const C4NetIO::addr_t &addr=C4NetIO::addr_t())
Definition: C4PacketBase.h:40
C4Network2ClientList Clients
Definition: C4Network2.h:116
C4GameControlPacket * getCtrl(int32_t iClientID, int32_t iCtrlTick)

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::SetRunning ( bool  fnRunning,
int32_t  inTargetTick = -1 
)

Definition at line 335 of file C4GameControlNetwork.cpp.

References CheckCompleteCtrl(), C4Game::Clients, CopyClientList(), fEnabled, fRunning, Game, and iTargetTick.

Referenced by C4Network2::CheckStatusReached(), C4Network2::OnStatusAck(), and C4Network2::OnStatusReached().

336 {
337  assert(fEnabled);
338  // check for redundant update, stop if running (safety)
339  if (fRunning == fnRunning && iTargetTick == inTargetTick) return;
340  fRunning = false;
341  // set
342  iTargetTick = inTargetTick;
343  fRunning = fnRunning;
344  // run?
345  if (fRunning)
346  {
347  // refresh client list
349  // check for complete ctrl
350  CheckCompleteCtrl(false);
351  }
352 }
C4Game Game
Definition: C4Globals.cpp:52
void CopyClientList(const C4ClientList &rClients)
void CheckCompleteCtrl(bool fSetEvent)
C4ClientList & Clients
Definition: C4Game.h:69

Here is the call graph for this function:

Here is the caller graph for this function:

void C4GameControlNetwork::setTargetFPS ( int32_t  iToVal)
inline

Definition at line 102 of file C4GameControlNetwork.h.

102 { iTargetFPS = iToVal; }

Member Data Documentation

CStdCSec C4GameControlNetwork::CtrlCSec
protected
bool C4GameControlNetwork::fActivated
protected

Definition at line 56 of file C4GameControlNetwork.h.

Referenced by CheckCompleteCtrl(), CtrlNeeded(), Init(), IsActivated(), and SetActivated().

volatile bool C4GameControlNetwork::fEnabled
protected
bool C4GameControlNetwork::fHost
protected
volatile bool C4GameControlNetwork::fRunning
protected

Definition at line 52 of file C4GameControlNetwork.h.

Referenced by CheckCompleteCtrl(), Clear(), Init(), IsRunning(), and SetRunning().

int32_t C4GameControlNetwork::iAvgControlSendTime
protected

Definition at line 69 of file C4GameControlNetwork.h.

Referenced by CalcPerformance(), Clear(), and getAvgControlSendTime().

int32_t C4GameControlNetwork::iClientID
protected

Definition at line 55 of file C4GameControlNetwork.h.

Referenced by DoInput(), Init(), and SetCtrlMode().

volatile int32_t C4GameControlNetwork::iControlPreSend
protected

Definition at line 61 of file C4GameControlNetwork.h.

Referenced by CtrlNeeded(), and getControlPreSend().

volatile int32_t C4GameControlNetwork::iControlReady
protected

Definition at line 73 of file C4GameControlNetwork.h.

Referenced by CheckCompleteCtrl(), CtrlReady(), and Init().

volatile int32_t C4GameControlNetwork::iControlSent
protected

Definition at line 73 of file C4GameControlNetwork.h.

Referenced by CheckCompleteCtrl(), CtrlNeeded(), DoInput(), Init(), and SetActivated().

int32_t C4GameControlNetwork::iTargetFPS
protected

Definition at line 70 of file C4GameControlNetwork.h.

Referenced by CalcPerformance(), Init(), and PackCompleteCtrl().

int32_t C4GameControlNetwork::iTargetTick
protected

Definition at line 58 of file C4GameControlNetwork.h.

Referenced by CheckCompleteCtrl(), CtrlNeeded(), and SetRunning().

C4GameControlClient* C4GameControlNetwork::pClients
protected
C4GameControlPacket* C4GameControlNetwork::pCtrlStack
protected

Definition at line 76 of file C4GameControlNetwork.h.

Referenced by AddCtrl(), ClearCtrl(), getCtrl(), and HandleControlReq().

C4Network2* C4GameControlNetwork::pNetwork
protected

Definition at line 92 of file C4GameControlNetwork.h.

Referenced by DoInput(), and Init().

C4GameControl* const C4GameControlNetwork::pParent
protected
C4GameControlPacket* C4GameControlNetwork::pSyncCtrlQueue
protected
C4Control C4GameControlNetwork::SyncControl
protected

Definition at line 84 of file C4GameControlNetwork.h.

Referenced by Clear(), DoInput(), ExecSyncControl(), and HandleControlPkt().

C4TimeMilliseconds C4GameControlNetwork::tNextControlRequest
protected

Definition at line 88 of file C4GameControlNetwork.h.

Referenced by CheckCompleteCtrl(), Init(), and PackCompleteCtrl().

C4TimeMilliseconds C4GameControlNetwork::tWaitStart
protected

Definition at line 67 of file C4GameControlNetwork.h.

Referenced by CalcPerformance(), Execute(), GetControl(), Init(), and PackCompleteCtrl().


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