#include <C4GameControlNetwork.h>

Collaboration diagram for C4GameControlNetwork:

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)

C4GameControlClient *	getClient (int32_t iID)

void	AddClient (C4GameControlClient *pClient)

void	RemoveClient (C4GameControlClient *pClient)

C4GameControlPacket *	getCtrl (int32_t iClientID, int32_t iCtrlTick)

void	AddCtrl (C4GameControlPacket *pCtrl)

void	ClearCtrl (int32_t iBeforeTick=-1)

void	CheckCompleteCtrl (bool fSetEvent)

C4GameControlPacket *	PackCompleteCtrl (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

C4GameControlPacket *	pCtrlStack

CStdCSec	CtrlCSec

C4GameControlClient *	pClients

CStdCSec	ClientsCSec

C4Control	SyncControl

C4GameControlPacket *	pSyncCtrlQueue

C4TimeMilliseconds	tNextControlRequest

C4GameControl *const	pParent

C4Network2 *	pNetwork

Detailed Description

Definition at line 45 of file C4GameControlNetwork.h.

Constructor & Destructor Documentation

◆ C4GameControlNetwork()

C4GameControlNetwork::C4GameControlNetwork ( class C4GameControl * pParent )

Definition at line 27 of file C4GameControlNetwork.cpp.

         : fEnabled(false), fRunning(false), iClientID(C4ClientIDUnknown),
         fActivated(false), iTargetTick(-1),
         iControlPreSend(1), tWaitStart(C4TimeMilliseconds::PositiveInfinity), iAvgControlSendTime(0), iTargetFPS(38),
         iControlSent(0), iControlReady(0),
         pCtrlStack(nullptr),
         tNextControlRequest(0),
         pParent(pnParent)
 {
     assert(pParent);
 }

References pParent.

◆ ~C4GameControlNetwork()

C4GameControlNetwork::~C4GameControlNetwork ( )

Definition at line 39 of file C4GameControlNetwork.cpp.

 {
     Clear();
 }

References Clear().

Here is the call graph for this function:

Member Function Documentation

◆ AddClient() [1/2]

void C4GameControlNetwork::AddClient ( C4GameControlClient * pClient )

protected

Definition at line 610 of file C4GameControlNetwork.cpp.

 {
     if (!pClient) return;
     // lock
     CStdLock ClientsLock(&ClientsCSec);
     // add (ordered)
     C4GameControlClient *pPrev = nullptr, *pPos = pClients;
     for (; pPos; pPrev = pPos, pPos = pPos->pNext)
         if (pPos->getClientID() > pClient->getClientID())
             break;
     // insert
     (pPrev ? pPrev->pNext : pClients) = pClient;
     pClient->pNext = pPos;
 }

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

Here is the call graph for this function:

◆ AddClient() [2/2]

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

protected

Definition at line 306 of file C4GameControlNetwork.cpp.

 {
     // security
     if (!fEnabled || getClient(iClientID)) return;
     // create new
     C4GameControlClient *pClient = new C4GameControlClient();
     pClient->Set(iClientID, szName);
     pClient->SetNextControl(::Control.ControlTick);
     // add client
     AddClient(pClient);
 }

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

Referenced by CopyClientList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddCtrl()

void C4GameControlNetwork::AddCtrl ( C4GameControlPacket * pCtrl )

protected

Definition at line 654 of file C4GameControlNetwork.cpp.

 {
     // lock
     CStdLock CtrlLock(&CtrlCSec);
     // add to list
     pCtrl->pNext = pCtrlStack;
     pCtrlStack = pCtrl;
 }

References CtrlCSec, pCtrlStack, and C4GameControlPacket::pNext.

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

Here is the caller graph for this function:

◆ AddSyncCtrlToQueue()

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

protected

Definition at line 802 of file C4GameControlNetwork.cpp.

 {
     // search place in queue. It's vitally important that new packets are placed
     // behind packets for the same tick, so they will be executed in the right order.
     C4GameControlPacket *pAfter = nullptr, *pBefore = pSyncCtrlQueue;
     while (pBefore && pBefore->getCtrlTick() <= iTick)
         { pAfter = pBefore; pBefore = pBefore->pNext; }
     // create
     C4GameControlPacket *pnPkt = new C4GameControlPacket();
     pnPkt->Set(C4ClientIDUnknown, iTick, Ctrl);
     // insert
     (pAfter ? pAfter->pNext : pSyncCtrlQueue) = pnPkt;
     pnPkt->pNext = pBefore;
 }

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

Referenced by ExecSyncControl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalcPerformance()

void C4GameControlNetwork::CalcPerformance ( int32_t iCtrlTick )

Definition at line 388 of file C4GameControlNetwork.cpp.

 {
     CStdLock ControlLock(&CtrlCSec);
     CStdLock ClientLock(&ClientsCSec);
     // should only be called if ready
     assert(CtrlReady(iCtrlTick));
     // calc perfomance for all clients
     int32_t iClientsPing=0; int32_t iPingClientCount=0; int32_t iNumTunnels=0; int32_t iHostPing=0;
     for (C4GameControlClient *pClient = pClients; pClient; pClient = pClient->pNext)
     {
         // Some rudimentary PreSend-calculation
         // get associated connection - nullptr for self
         C4Network2Client *pNetClt = ::Network.Clients.GetClientByID(pClient->getClientID());
         if (pNetClt && !pNetClt->isLocal())
         {
             C4Network2IOConnection *pConn = pNetClt->getMsgConn();
             if (!pConn)
                 // remember tunnel
                 ++iNumTunnels;
             else
                 // store ping
                 if (pClient->getClientID() == C4ClientIDHost)
                     iHostPing = pConn->getPingTime();
                 else
                 {
                     iClientsPing += pConn->getPingTime();
                     ++iPingClientCount;
                 }
         }
         // Performance statistics
         // find control (may not be found, if we only got the complete ctrl)
         C4GameControlPacket *pCtrl = getCtrl(pClient->getClientID(), iCtrlTick);
         if (!pCtrl || tWaitStart.IsInfinite()) continue;
         // calc stats
         pClient->AddPerf(pCtrl->getTime() - tWaitStart);
     }
     // Now do PreSend-calcs based on ping times
     int32_t iControlSendTime;
     if (eMode == CNM_Decentral)
     {
         // average ping time
         iControlSendTime = (iClientsPing + iHostPing * (iNumTunnels + 1)) / (iPingClientCount + iNumTunnels + 1);
         // decentral mode: Only half the ping is used if there are no tunnels
         if (!iNumTunnels) iControlSendTime /= 2;
     }
     else
     {
         // central mode: Control must go to host and back
         iControlSendTime = iHostPing;
     }
     // calc some average
     if (iControlSendTime)
     {
         iAvgControlSendTime = (iAvgControlSendTime * 149 + iControlSendTime * 1000) / 150;
         // now calculate the all-time optimum PreSend there is
         int32_t iBestPreSend = Clamp((iTargetFPS * iAvgControlSendTime) / 1000000 + 1, 1, 15);
         // fixed PreSend?
         if (iTargetFPS <= 0) iBestPreSend = -iTargetFPS;
         // Ha! Set it!
         if (getControlPreSend() != iBestPreSend)
         {
             setControlPreSend(iBestPreSend);
             ::GraphicsSystem.FlashMessage(FormatString("PreSend: %d  - TargetFPS: %d", iBestPreSend, iTargetFPS).getData());
         }
     }
 }

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckCompleteCtrl()

void C4GameControlNetwork::CheckCompleteCtrl ( bool fSetEvent )

protected

Definition at line 689 of file C4GameControlNetwork.cpp.

 {
     // only when running (client list may be invalid)
     if (!fRunning || !fEnabled) return;
  
     CStdLock CtrlLock(&CtrlCSec);
     CStdLock ClientLock(&ClientsCSec);
  
     for (;;)
     {
         // control available?
         C4GameControlPacket *pComplete = getCtrl(C4ClientIDAll, iControlReady + 1);
         // get stop tick
         int32_t iStopTick = iTargetTick;
         if (pSyncCtrlQueue)
             if (iStopTick < 0 || iStopTick > pSyncCtrlQueue->getCtrlTick())
                 iStopTick = pSyncCtrlQueue->getCtrlTick();
         // pack control?
         if (!pComplete)
         {
             // own control not ready?
             if (fActivated && iControlSent <= iControlReady) break;
             // no clients? no need to pack more than one tick into the future
             if (!pClients && ::Control.ControlTick <= iControlReady) break;
             // stop packing?
             if (iStopTick >= 0 && iControlReady + 1 >= iStopTick) break;
             // central mode and not host?
             if (eMode != CNM_Decentral && !fHost) break;
             // (try to) pack
             if (!(pComplete = PackCompleteCtrl(iControlReady + 1)))
                 break;
         }
         // preexecute to check if it's ready for execute
         if (!pComplete->getControl().PreExecute())
             break;
         // ok, control for this tick is ready
         iControlReady++;
         // tell the main thread to move on
         if (fSetEvent && Game.GameGo && iControlReady >= ::Control.ControlTick)
             Application.NextTick();
     }
     // clear old ctrl
     if (::Control.ControlTick >= C4ControlBacklog)
         ClearCtrl(::Control.ControlTick - C4ControlBacklog);
     // target ctrl tick to reach?
     if (iControlReady < iTargetTick &&
         (!fActivated || iControlSent > iControlReady) &&
         C4TimeMilliseconds::Now() >= tNextControlRequest)
     {
         Application.InteractiveThread.ThreadLogS("Network: Recovering: Requesting control for tick %d...", iControlReady + 1);
         // make request
         C4NetIOPacket Pkt = MkC4NetIOPacket(PID_ControlReq, C4PacketControlReq(iControlReady + 1));
         // send control requests
         if (eMode == CNM_Central)
             ::Network.Clients.SendMsgToHost(Pkt);
         else
 			::Network.Clients.BroadcastMsgToConnClients(Pkt);
         // set time for next request
         tNextControlRequest = C4TimeMilliseconds::Now() + C4ControlRequestInterval;
     }
 }

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Clear()

void C4GameControlNetwork::Clear ( )

Definition at line 65 of file C4GameControlNetwork.cpp.

 {
     fEnabled = false; fRunning = false;
     iAvgControlSendTime = 0;
     ClearCtrl(); ClearClients();
     // clear sync control
     SyncControl.Clear();
     while (pSyncCtrlQueue)
     {
         C4GameControlPacket *pPkt = pSyncCtrlQueue;
         pSyncCtrlQueue = pPkt->pNext;
         delete pPkt;
     }
 }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClearClients()

void C4GameControlNetwork::ClearClients ( )

protected

Definition at line 318 of file C4GameControlNetwork.cpp.

 {
     CStdLock ClientsLock(&ClientsCSec);
     while (pClients) { C4GameControlClient *pClient = pClients; RemoveClient(pClient); delete pClient; }
 }

References ClientsCSec, pClients, and RemoveClient().

Referenced by Clear(), and CopyClientList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClearCtrl()

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

protected

Definition at line 663 of file C4GameControlNetwork.cpp.

 {
     // lock
     CStdLock CtrlLock(&CtrlCSec);
     // clear all old control
     C4GameControlPacket *pCtrl = pCtrlStack, *pLast = nullptr;
     while (pCtrl)
     {
         // old?
         if (iBeforeTick == -1 || pCtrl->getCtrlTick() < iBeforeTick)
         {
             // unlink
             C4GameControlPacket *pDelete = pCtrl;
             pCtrl = pCtrl->pNext;
             (pLast ? pLast->pNext : pCtrlStack) = pCtrl;
             // delete
             delete pDelete;
         }
         else
         {
             pLast = pCtrl;
             pCtrl = pCtrl->pNext;
         }
     }
 }

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

Referenced by CheckCompleteCtrl(), and Clear().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClientNextControl()

int32_t C4GameControlNetwork::ClientNextControl ( int32_t iClientID )

Definition at line 135 of file C4GameControlNetwork.cpp.

 {
     // get client
     CStdLock ClientsLock(&ClientsCSec);
     C4GameControlClient *pClient = getClient(iClientID);
     // return performance
     return pClient ? pClient->getNextControl() : 0;
 }

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

Referenced by C4Network2::DrawStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClientPerfStat()

int32_t C4GameControlNetwork::ClientPerfStat ( int32_t iClientID )

Definition at line 125 of file C4GameControlNetwork.cpp.

 {
     if (eMode == CNM_Central && !fHost) return true;
     // get client
     CStdLock ClientsLock(&ClientsCSec);
     C4GameControlClient *pClient = getClient(iClientID);
     // return performance
     return pClient ? pClient->getPerfStat() : 0;
 }

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

Referenced by C4Network2::DrawStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClientReady()

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

Definition at line 119 of file C4GameControlNetwork.cpp.

 {
     if (eMode == CNM_Central && !fHost) return true;
     return !!getCtrl(iClientID, iTick);
 }

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

Referenced by C4Network2::DrawStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CopyClientList()

void C4GameControlNetwork::CopyClientList ( const C4ClientList & rClients )

Definition at line 324 of file C4GameControlNetwork.cpp.

 {
     CStdLock ClientLock(&ClientsCSec);
     // create local copy of activated client list
     ClearClients();
     C4Client *pClient = nullptr;
     while ((pClient = rClients.getClient(pClient)))
         if (pClient->isActivated())
             AddClient(pClient->getID(), pClient->getName());
 }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CtrlNeeded()

bool C4GameControlNetwork::CtrlNeeded ( int32_t iTick ) const

Definition at line 144 of file C4GameControlNetwork.cpp.

 {
     if (!IsEnabled() || !fActivated) return false;
     // check: should we send something at the moment?
     int32_t iSendFor = pParent->getCtrlTick(iFrame + iControlPreSend);
     // target tick set? do special check
     if (iTargetTick >= 0 && iControlSent >= iTargetTick) return false;
     // control sent for this ctrl tick?
     return iSendFor > iControlSent;
 }

Referenced by C4GameControl::Prepare().

Here is the caller graph for this function:

◆ CtrlOverflow()

bool C4GameControlNetwork::CtrlOverflow ( int32_t iTick ) const

inline

Definition at line 110 of file C4GameControlNetwork.h.

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

C4ControlOverflowLimit

const int32_t C4ControlOverflowLimit

Definition: C4GameControlNetwork.h:28

References C4ControlOverflowLimit, fRunning, and iControlReady.

Referenced by C4GameControl::Ticks().

Here is the caller graph for this function:

◆ CtrlReady()

bool C4GameControlNetwork::CtrlReady ( int32_t iTick )

Definition at line 93 of file C4GameControlNetwork.cpp.

 {
     // check for complete control and pack it
     CheckCompleteCtrl(false);
     // control ready?
     return iControlReady >= iTick;
 }

References CheckCompleteCtrl(), and iControlReady.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DecideControlDelivery()

C4ControlDeliveryType C4GameControlNetwork::DecideControlDelivery ( ) const

Definition at line 248 of file C4GameControlNetwork.cpp.

 {
     // This doesn't make sense for clients
     if (!fHost)
         return CDT_Queue;
     // Decide the fastest control delivery type atm. Note this is a guess.
     // Control sent with the returned delivery type may in theory be delayed infinitely.
     if (::Network.isFrozen())
         return CDT_Sync;
     if (!Game.Clients.getLocal()->isActivated())
         return CDT_Sync;
     return CDT_Queue;
 }

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

Referenced by C4GameControl::DecideControlDelivery().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoInput() [1/2]

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

Definition at line 184 of file C4GameControlNetwork.cpp.

 {
     if (!fEnabled) return;
  
     // Create packet
     C4PacketControlPkt CtrlPkt(eDelivery, C4IDPacket(eCtrlType, pCtrl, false));
  
     switch (eDelivery)
     {
  
         // Sync control
     case CDT_Sync:
     {
         if (!fHost)
         {
             // Client: send to host
             if (!::Network.Clients.SendMsgToHost(MkC4NetIOPacket(PID_ControlPkt, CtrlPkt)))
                 { LogFatal("Network: could not send direct control packet!"); break; }
             delete pCtrl;
         }
         else
         {
             // Host: send to all clients
             ::Network.Clients.BroadcastMsgToClients(MkC4NetIOPacket(PID_ControlPkt, CtrlPkt));
             // Execute at once, if possible
             if (::Network.isFrozen())
             {
                 pParent->ExecControlPacket(eCtrlType, pCtrl);
                 delete pCtrl;
                 C4PacketExecSyncCtrl Pkt(pParent->ControlTick);
                 ::Network.Clients.BroadcastMsgToClients(MkC4NetIOPacket(PID_ExecSyncCtrl, Pkt));
             }
             else
             {
                 // Safe back otherwise
                 SyncControl.Add(eCtrlType, pCtrl);
                 // And sync
                 ::Network.Sync();
             }
         }
     }
     break;
  
     // Direct/private control:
     case CDT_Direct:
     case CDT_Private:
     {
         // Send to all clients
         if (!::Network.Clients.BroadcastMsgToClients(MkC4NetIOPacket(PID_ControlPkt, CtrlPkt)))
             { LogFatal("Network: could not send direct control packet!"); break; }
         // Exec at once
         pParent->ExecControlPacket(eCtrlType, pCtrl);
         delete pCtrl;
     }
     break;
  
     // Only some delivery types support single packets (queue control must be tick-stamped)
     default:
         assert(false);
  
     }
  
 }

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.

Here is the call graph for this function:

◆ DoInput() [2/2]

void C4GameControlNetwork::DoInput ( const C4Control & Input )

Definition at line 155 of file C4GameControlNetwork.cpp.

 {
     if (!fEnabled) return;
     // pack
     C4GameControlPacket *pCtrl = new C4GameControlPacket();
     pCtrl->Set(iClientID, iControlSent+1, Input);
     // client in central or async mode: send to host (will resend it to the other clients)
     C4NetIOPacket CtrlPkt = MkC4NetIOPacket(PID_Control, *pCtrl);
     if (eMode != CNM_Decentral)
     {
         if (!fHost)
             if (!pNetwork->Clients.SendMsgToHost(CtrlPkt))
                 Application.InteractiveThread.ThreadLog("Failed to send control to host!");
     }
     // decentral mode: always broadcast to everybody
     else
     {
         assert (eMode == CNM_Decentral);
         if (!pNetwork->Clients.BroadcastMsgToClients(CtrlPkt))
             Application.InteractiveThread.ThreadLog("Failed to broadcast control!");
     }
     // add to list
     AddCtrl(pCtrl);
     // ok, control is sent for this control tick
     iControlSent++;
     // ctrl complete?
     CheckCompleteCtrl(false);
 }

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ExecQueuedSyncCtrl()

void C4GameControlNetwork::ExecQueuedSyncCtrl ( )

protected

Definition at line 817 of file C4GameControlNetwork.cpp.

 {
     // security
     while (pSyncCtrlQueue && pSyncCtrlQueue->getCtrlTick() < pParent->ControlTick)
     {
         LogF("Network: Fatal: got sync control to execute for ctrl tick %d, but already in ctrl tick %d!", pSyncCtrlQueue->getCtrlTick(), pParent->ControlTick);
         // remove it
         C4GameControlPacket *pPkt = pSyncCtrlQueue;
         pSyncCtrlQueue = pPkt->pNext;
         delete pPkt;
     }
     // nothing to do?
     if (!pSyncCtrlQueue || pSyncCtrlQueue->getCtrlTick() > pParent->ControlTick)
         return;
     // this should hold by now
     assert(pSyncCtrlQueue && pSyncCtrlQueue->getCtrlTick() == pParent->ControlTick);
     do
     {
         // execute it
         pParent->ExecControl(pSyncCtrlQueue->getControl());
         // remove the packet
         C4GameControlPacket *pPkt = pSyncCtrlQueue;
         pSyncCtrlQueue = pPkt->pNext;
         delete pPkt;
     }
     while (pSyncCtrlQueue && pSyncCtrlQueue->getCtrlTick() == pParent->ControlTick);
     // refresh copy of client list
     CopyClientList(Game.Clients);
 }

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

Referenced by Execute(), and HandleControlPkt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ExecSyncControl() [1/2]

void C4GameControlNetwork::ExecSyncControl ( )

Definition at line 262 of file C4GameControlNetwork.cpp.

 {
     assert(fHost);
  
     // This is a callback from C4Network informing that a point where accumulated sync control
     // can be executed has been reached (it's "momentarily" safe to execute)
  
     // Nothing to do? Save some sweat.
     if (!SyncControl.firstPkt())
         return;
  
     // So let's spread the word, so clients will call ExecSyncControl, too.
     C4PacketExecSyncCtrl Pkt(pParent->ControlTick);
     ::Network.Clients.BroadcastMsgToClients(MkC4NetIOPacket(PID_ExecSyncCtrl, Pkt));
  
     // Execute it
     ExecSyncControl(Pkt.getControlTick());
  
 }

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ExecSyncControl() [2/2]

void C4GameControlNetwork::ExecSyncControl ( int32_t iControlTick )

Definition at line 282 of file C4GameControlNetwork.cpp.

 {
     // Nothing to do?
     if (!SyncControl.firstPkt())
         return;
  
     // Copy control and clear
     C4Control Control = SyncControl;
     SyncControl.Clear();
  
     // Given control tick reached?
     if (pParent->ControlTick == iControlTick)
         pParent->ExecControl(Control);
  
     else if (pParent->ControlTick > iControlTick)
         // The host should make sure this doesn't happen.
         LogF("Network: Fatal: got sync control to execute for ctrl tick %d, but already in ctrl tick %d!", iControlTick, pParent->ControlTick);
  
     else
         // This sync control must be executed later, so safe it back
         AddSyncCtrlToQueue(Control, iControlTick);
  
 }

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

Here is the call graph for this function:

◆ Execute()

void C4GameControlNetwork::Execute ( )

Definition at line 80 of file C4GameControlNetwork.cpp.

 {
     // Control ticks only
     if (Game.FrameCounter % ::Control.ControlRate)
         return;
  
     // Save time the control tick was reached
     tWaitStart = C4TimeMilliseconds::Now();
  
     // Execute any queued sync control
     ExecQueuedSyncCtrl();
 }

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

Referenced by C4GameControl::Prepare().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAvgControlSendTime()

int32_t C4GameControlNetwork::getAvgControlSendTime ( ) const

inline

Definition at line 101 of file C4GameControlNetwork.h.

101 { return iAvgControlSendTime; }

References iAvgControlSendTime.

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

Here is the caller graph for this function:

◆ GetBehind()

int32_t C4GameControlNetwork::GetBehind ( int32_t iTick ) const

inline

Definition at line 111 of file C4GameControlNetwork.h.

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

References iControlReady.

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

Here is the caller graph for this function:

◆ getClient()

C4GameControlClient * C4GameControlNetwork::getClient ( int32_t iID )

protected

Definition at line 601 of file C4GameControlNetwork.cpp.

 {
     CStdLock ClientsLock(&ClientsCSec);
     for (C4GameControlClient *pClient = pClients; pClient; pClient = pClient->pNext)
         if (pClient->getClientID() == iID)
             return pClient;
     return nullptr;
 }

References ClientsCSec, pClients, and C4GameControlClient::pNext.

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

Here is the caller graph for this function:

◆ GetControl()

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

Definition at line 101 of file C4GameControlNetwork.cpp.

 {
     // lock
     CStdLock CtrlLock(&CtrlCSec);
     // look for control
     C4GameControlPacket *pPkt = getCtrl(C4ClientIDAll, iTick);
     if (!pPkt)
         return false;
     // set
     pCtrl->Clear();
     pCtrl->Append(pPkt->getControl());
     // calc performance
     CalcPerformance(iTick);
     tWaitStart = C4TimeMilliseconds::PositiveInfinity;
     // ok
     return true;
 }

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

Referenced by C4GameControl::Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getControlPreSend()

int32_t C4GameControlNetwork::getControlPreSend ( ) const

inline

Definition at line 99 of file C4GameControlNetwork.h.

99 { return iControlPreSend; }

References iControlPreSend.

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

Here is the caller graph for this function:

◆ getCtrl()

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

protected

Definition at line 643 of file C4GameControlNetwork.cpp.

 {
     // lock
     CStdLock CtrlLock(&CtrlCSec);
     // search
     for (C4GameControlPacket *pCtrl = pCtrlStack; pCtrl; pCtrl = pCtrl->pNext)
         if (pCtrl->getClientID() == iClientID && pCtrl->getCtrlTick() == iCtrlTick)
             return pCtrl;
     return nullptr;
 }

References CtrlCSec, iClientID, pCtrlStack, and C4GameControlPacket::pNext.

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

Here is the caller graph for this function:

◆ GetCtrlMode()

C4GameControlNetworkMode C4GameControlNetwork::GetCtrlMode ( ) const

inline

Definition at line 133 of file C4GameControlNetwork.h.

133 { return eMode; } // by main thread

References eMode.

◆ HandleControl()

void C4GameControlNetwork::HandleControl	(	int32_t	iByClientID,
		const C4GameControlPacket &	rPkt
	)

protected

Definition at line 525 of file C4GameControlNetwork.cpp.

 {
     // already got that control? just ignore
     if (getCtrl(rPkt.getClientID(), rPkt.getCtrlTick())) return;
     // create copy, add to list
     C4GameControlPacket *pCopy = new C4GameControlPacket(rPkt);
     AddCtrl(pCopy);
     // check: control complete?
     if (IsEnabled())
         CheckCompleteCtrl(true);
     // note that C4GameControlNetwork will save incoming control even before
     // Init() was called.
 }

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

Referenced by HandlePacket().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HandleControlPkt()

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

protected

Definition at line 566 of file C4GameControlNetwork.cpp.

 {
  
     // direct control? execute at once
     if (eType == CDT_Direct || eType == CDT_Private)
     {
         pParent->ExecControlPacket(eCtrlType, pCtrl);
         delete pCtrl;
         return;
     }
  
     // sync ctrl from client? resend
     if (fHost && eType == CDT_Sync)
     {
         DoInput(eCtrlType, pCtrl, eType);
         return;
     }
  
     // Execute queued control first
     ExecQueuedSyncCtrl();
  
     // Execute at once, if possible
     if (::Network.isFrozen())
     {
         pParent->ExecControlPacket(eCtrlType, pCtrl);
         delete pCtrl;
     }
     else
     {
         // Safe back otherwise
         SyncControl.Add(eCtrlType, pCtrl);
     }
  
 }

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

Referenced by HandlePacket().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HandleControlReq()

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

protected

Definition at line 539 of file C4GameControlNetwork.cpp.

 {
     CStdLock CtrlLock(&CtrlCSec);
     for (int iTick = rPkt.getCtrlTick(); ; iTick++)
     {
         // search complete control
         C4GameControlPacket *pCtrl = getCtrl(C4ClientIDAll, iTick);
         if (pCtrl)
         {
             // send
             pConn->Send(MkC4NetIOPacket(PID_Control, *pCtrl));
             continue;
         }
         // send everything we have for this tick (this is an emergency case, so efficiency
         // isn't that important for now).
         bool fFound = false;
         for (pCtrl = pCtrlStack; pCtrl; pCtrl = pCtrl->pNext)
             if (pCtrl->getCtrlTick() == iTick)
             {
                 pConn->Send(MkC4NetIOPacket(PID_Control, *pCtrl));
                 fFound = true;
             }
         // nothing found for this tick?
         if (!fFound) break;
     }
 }

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

Referenced by HandlePacket().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HandlePacket()

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

Definition at line 455 of file C4GameControlNetwork.cpp.

 {
     // security
     if (!pConn)
         return;
  
 #define GETPKT(type, name) \
     assert(pPacket); const type &name = \
       static_cast<const type &>(*pPacket);
  
     switch (cStatus)
     {
  
     case PID_Control: // control
     {
         GETPKT(C4GameControlPacket, rPkt)
         HandleControl(pConn->getClientID(), rPkt);
     }
     break;
  
     case PID_ControlReq: // control request
     {
         if (!IsEnabled()) break;
         if (pConn->isClosed() || !pConn->isAccepted()) break;
         GETPKT(C4PacketControlReq, rPkt)
         HandleControlReq(rPkt, pConn);
     }
     break;
  
     case PID_ControlPkt: // single control packet (main thread!)
     {
         GETPKT(C4PacketControlPkt, rPkt)
         // security
         if (!fEnabled) break;
         if (rPkt.getCtrl().getPktType() < CID_First) break;
         // create copy (HandleControlPkt will store or delete)
         C4IDPacket Copy(rPkt.getCtrl());
         // some sanity checks
         C4ControlPacket *pCtrlPkt = static_cast<C4ControlPacket *>(Copy.getPkt());
         if (!pConn->isHost() && pConn->getClientID() != pCtrlPkt->getByClient())
             break;
         // handle
         HandleControlPkt(Copy.getPktType(), pCtrlPkt, rPkt.getDelivery());
         Copy.Default();
     }
     break;
  
     case PID_ExecSyncCtrl:
     {
         GETPKT(C4PacketExecSyncCtrl, rPkt)
         // security
         if (!fEnabled) break;
         // handle
         ExecSyncControl(rPkt.getControlTick());
     }
     break;
  
     }
  
 #undef GETPKT
 }

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

Referenced by C4Network2IO::CallHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Init()

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

Definition at line 44 of file C4GameControlNetwork.cpp.

 {
     if (IsEnabled()) Clear();
     // init
     iClientID = inClientID; fHost = fnHost;
     ::Control.ControlTick = iStartTick;
     iControlSent = iControlReady = ::Control.getNextControlTick() - 1;
     fActivated = fnActivated;
     pNetwork = pnNetwork;
     // check
     CheckCompleteCtrl(false);
     // make sure no control has been lost
     pNetwork->Clients.BroadcastMsgToConnClients(MkC4NetIOPacket(PID_ControlReq, C4PacketControlReq(iControlReady + 1)));
     // ok
     fEnabled = true; fRunning = false;
     iTargetFPS = 38;
     tNextControlRequest = C4TimeMilliseconds::Now() + C4ControlRequestInterval;
     tWaitStart = C4TimeMilliseconds::PositiveInfinity;
     return true;
 }

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsActivated()

bool C4GameControlNetwork::IsActivated ( ) const

inline

Definition at line 97 of file C4GameControlNetwork.h.

97 { return fActivated; }

References fActivated.

◆ IsEnabled()

bool C4GameControlNetwork::IsEnabled ( ) const

inline

Definition at line 95 of file C4GameControlNetwork.h.

95 { return fEnabled; }

References fEnabled.

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

Here is the caller graph for this function:

◆ IsRunning()

bool C4GameControlNetwork::IsRunning ( ) const

inline

Definition at line 96 of file C4GameControlNetwork.h.

96 { return fRunning; }

References fRunning.

◆ OnResComplete()

void C4GameControlNetwork::OnResComplete ( C4Network2Res * pRes )

Definition at line 517 of file C4GameControlNetwork.cpp.

 {
     // player?
     if (pRes->getType() == NRT_Player)
         // check for ctrl ready
         CheckCompleteCtrl(true);
 }

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

Referenced by C4Network2ResList::OnResComplete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PackCompleteCtrl()

C4GameControlPacket * C4GameControlNetwork::PackCompleteCtrl ( int32_t iTick )

protected

Definition at line 751 of file C4GameControlNetwork.cpp.

 {
     CStdLock CtrlLock(&CtrlCSec);
     CStdLock ClientLock(&ClientsCSec);
  
     // check if ctrl by all clients is ready
     C4GameControlClient *pClient;
     for (pClient = pClients; pClient; pClient = pClient->pNext)
         if (!getCtrl(pClient->getClientID(), iTick))
             break;
     if (pClient)
     {
         // async mode: wait n extra frames for slow clients
         const int iMaxWait = (Config.Network.AsyncMaxWait * 1000) / iTargetFPS;
         if (eMode != CNM_Async || C4TimeMilliseconds::Now() <= tWaitStart + iMaxWait)
             return nullptr;
     }
  
     // create packet
     C4GameControlPacket *pComplete = new C4GameControlPacket();
     pComplete->Set(C4ClientIDAll, iTick);
  
     // pack everything in ID order (client list is ordered this way)
     C4GameControlPacket *pCtrl;
     for (pClient = pClients; pClient; pClient = pClient->pNext)
         while (pClient->getNextControl() <= iTick)
         {
             // get control
             int32_t iNextControl = pClient->getNextControl();
             pCtrl = getCtrl(pClient->getClientID(), iNextControl);
             if (!pCtrl) break;
             pClient->SetNextControl(iNextControl + 1);
             assert(pCtrl);
             // add
             pComplete->Add(*pCtrl);
         }
  
     // add to list
     AddCtrl(pComplete);
  
     // host: send to clients (central and async mode)
     if (eMode != CNM_Decentral)
         ::Network.Clients.BroadcastMsgToConnClients(MkC4NetIOPacket(PID_Control, *pComplete));
  
     // advance control request time
     tNextControlRequest = std::max(tNextControlRequest, C4TimeMilliseconds::Now() + C4ControlRequestInterval);
  
     // return
     return pComplete;
 }

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemoveClient() [1/2]

void C4GameControlNetwork::RemoveClient ( C4GameControlClient * pClient )

protected

Definition at line 625 of file C4GameControlNetwork.cpp.

 {
     // obtain lock
     CStdLock ClientsLock(&ClientsCSec);
     // first client?
     if (pClient == pClients)
         pClients = pClient->pNext;
     else
     {
         C4GameControlClient *pPrev;
         for (pPrev = pClients; pPrev && pPrev->pNext; pPrev = pPrev->pNext)
             if (pPrev->pNext == pClient)
                 break;
         if (pPrev && pPrev->pNext == pClient)
             pPrev->pNext = pClient->pNext;
     }
 }

References ClientsCSec, pClients, and C4GameControlClient::pNext.

◆ RemoveClient() [2/2]

void C4GameControlNetwork::RemoveClient ( int32_t iClientID )

protected

Referenced by ClearClients().

Here is the caller graph for this function:

◆ SetActivated()

void C4GameControlNetwork::SetActivated ( bool fnActivated )

Definition at line 354 of file C4GameControlNetwork.cpp.

 {
     assert(fEnabled);
     // no change? ignore
     if (fActivated == fnActivated) return;
     // set
     fActivated = fnActivated;
     // Activated? Start to send control at next tick
     if (fActivated)
         iControlSent = ::Control.getNextControlTick() - 1;
 }

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

Referenced by C4GameControl::SetActivated().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setControlPreSend()

void C4GameControlNetwork::setControlPreSend ( int32_t iToVal )

inline

Definition at line 100 of file C4GameControlNetwork.h.

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

C4MaxPreSend

const int32_t C4MaxPreSend

Definition: C4GameControlNetwork.h:29

References C4MaxPreSend, and iControlPreSend.

Referenced by CalcPerformance().

Here is the caller graph for this function:

◆ SetCtrlMode()

void C4GameControlNetwork::SetCtrlMode ( C4GameControlNetworkMode enMode )

Definition at line 366 of file C4GameControlNetwork.cpp.

 {
     assert(fEnabled);
     // no change?
     if (eMode == enMode) return;
     // set mode
     eMode = enMode;
     // changed to decentral? rebroadcast all own control
     if (enMode == CNM_Decentral)
     {
         CStdLock CtrlLock(&CtrlCSec); C4GameControlPacket *pPkt;
         for (int32_t iCtrlTick = ::Control.ControlTick; (pPkt = getCtrl(iClientID, iCtrlTick)); iCtrlTick++)
             ::Network.Clients.BroadcastMsgToClients(MkC4NetIOPacket(PID_Control, *pPkt));
     }
     else if (enMode == CNM_Central && fHost)
     {
         CStdLock CtrlLock(&CtrlCSec); C4GameControlPacket *pPkt;
         for (int32_t iCtrlTick = ::Control.ControlTick; (pPkt = getCtrl(C4ClientIDAll, iCtrlTick)); iCtrlTick++)
             ::Network.Clients.BroadcastMsgToClients(MkC4NetIOPacket(PID_Control, *pPkt));
     }
 }

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetRunning()

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

Definition at line 335 of file C4GameControlNetwork.cpp.

 {
     assert(fEnabled);
     // check for redundant update, stop if running (safety)
     if (fRunning == fnRunning && iTargetTick == inTargetTick) return;
     fRunning = false;
     // set
     iTargetTick = inTargetTick;
     fRunning = fnRunning;
     // run?
     if (fRunning)
     {
         // refresh client list
         CopyClientList(Game.Clients);
         // check for complete ctrl
         CheckCompleteCtrl(false);
     }
 }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTargetFPS()

void C4GameControlNetwork::setTargetFPS ( int32_t iToVal )

inline

Definition at line 102 of file C4GameControlNetwork.h.

102 { iTargetFPS = iToVal; }

References iTargetFPS.

Member Data Documentation

◆ ClientsCSec

CStdCSec C4GameControlNetwork::ClientsCSec

protected

Definition at line 81 of file C4GameControlNetwork.h.

Referenced by AddClient(), CalcPerformance(), CheckCompleteCtrl(), ClearClients(), ClientNextControl(), ClientPerfStat(), CopyClientList(), getClient(), PackCompleteCtrl(), and RemoveClient().

◆ CtrlCSec

CStdCSec C4GameControlNetwork::CtrlCSec

protected

Definition at line 77 of file C4GameControlNetwork.h.

Referenced by AddCtrl(), CalcPerformance(), CheckCompleteCtrl(), ClearCtrl(), GetControl(), getCtrl(), HandleControlReq(), PackCompleteCtrl(), and SetCtrlMode().

◆ eMode

C4GameControlNetworkMode C4GameControlNetwork::eMode

protected

Definition at line 57 of file C4GameControlNetwork.h.

Referenced by CalcPerformance(), CheckCompleteCtrl(), ClientPerfStat(), ClientReady(), DoInput(), GetCtrlMode(), PackCompleteCtrl(), and SetCtrlMode().

◆ fActivated

bool C4GameControlNetwork::fActivated

protected

Definition at line 56 of file C4GameControlNetwork.h.

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

◆ fEnabled

volatile bool C4GameControlNetwork::fEnabled

protected

Definition at line 52 of file C4GameControlNetwork.h.

Referenced by AddClient(), CheckCompleteCtrl(), Clear(), DoInput(), HandlePacket(), Init(), IsEnabled(), SetActivated(), SetCtrlMode(), and SetRunning().

◆ fHost

bool C4GameControlNetwork::fHost

protected

Definition at line 56 of file C4GameControlNetwork.h.

Referenced by CheckCompleteCtrl(), ClientPerfStat(), ClientReady(), DecideControlDelivery(), DoInput(), ExecSyncControl(), HandleControlPkt(), Init(), and SetCtrlMode().

◆ fRunning

volatile bool C4GameControlNetwork::fRunning

protected

Definition at line 52 of file C4GameControlNetwork.h.

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

◆ iAvgControlSendTime

int32_t C4GameControlNetwork::iAvgControlSendTime

protected

Definition at line 69 of file C4GameControlNetwork.h.

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

◆ iClientID

int32_t C4GameControlNetwork::iClientID

protected

Definition at line 55 of file C4GameControlNetwork.h.

Referenced by AddClient(), ClientNextControl(), ClientPerfStat(), ClientReady(), DoInput(), getCtrl(), Init(), and SetCtrlMode().

◆ iControlPreSend

volatile int32_t C4GameControlNetwork::iControlPreSend

protected

Definition at line 61 of file C4GameControlNetwork.h.

Referenced by getControlPreSend(), and setControlPreSend().

◆ iControlReady

volatile int32_t C4GameControlNetwork::iControlReady

protected

Definition at line 73 of file C4GameControlNetwork.h.

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

◆ iControlSent

volatile int32_t C4GameControlNetwork::iControlSent

protected

Definition at line 73 of file C4GameControlNetwork.h.

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

◆ iTargetFPS

int32_t C4GameControlNetwork::iTargetFPS

protected

Definition at line 70 of file C4GameControlNetwork.h.

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

◆ iTargetTick

int32_t C4GameControlNetwork::iTargetTick

protected

Definition at line 58 of file C4GameControlNetwork.h.

Referenced by CheckCompleteCtrl(), and SetRunning().

◆ pClients

C4GameControlClient* C4GameControlNetwork::pClients

protected

Definition at line 80 of file C4GameControlNetwork.h.

Referenced by AddClient(), CalcPerformance(), CheckCompleteCtrl(), ClearClients(), getClient(), PackCompleteCtrl(), and RemoveClient().

◆ pCtrlStack

C4GameControlPacket* C4GameControlNetwork::pCtrlStack

protected

Definition at line 76 of file C4GameControlNetwork.h.

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

◆ pNetwork

C4Network2* C4GameControlNetwork::pNetwork

protected

Definition at line 92 of file C4GameControlNetwork.h.

Referenced by DoInput(), and Init().

◆ pParent

C4GameControl* const C4GameControlNetwork::pParent

protected

Definition at line 91 of file C4GameControlNetwork.h.

Referenced by C4GameControlNetwork(), DoInput(), ExecQueuedSyncCtrl(), ExecSyncControl(), and HandleControlPkt().

◆ pSyncCtrlQueue

C4GameControlPacket* C4GameControlNetwork::pSyncCtrlQueue

protected

Definition at line 85 of file C4GameControlNetwork.h.

Referenced by AddSyncCtrlToQueue(), CheckCompleteCtrl(), Clear(), and ExecQueuedSyncCtrl().

◆ SyncControl

C4Control C4GameControlNetwork::SyncControl

protected

Definition at line 84 of file C4GameControlNetwork.h.

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

◆ tNextControlRequest

C4TimeMilliseconds C4GameControlNetwork::tNextControlRequest

protected

Definition at line 88 of file C4GameControlNetwork.h.

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

◆ tWaitStart

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:

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ C4GameControlNetwork()

◆ ~C4GameControlNetwork()

Member Function Documentation

◆ AddClient() [1/2]

◆ AddClient() [2/2]

◆ AddCtrl()

◆ AddSyncCtrlToQueue()

◆ CalcPerformance()

◆ CheckCompleteCtrl()

◆ Clear()

◆ ClearClients()

◆ ClearCtrl()

◆ ClientNextControl()

◆ ClientPerfStat()

◆ ClientReady()

◆ CopyClientList()

◆ CtrlNeeded()

◆ CtrlOverflow()

◆ CtrlReady()

◆ DecideControlDelivery()

◆ DoInput() [1/2]

◆ DoInput() [2/2]

◆ ExecQueuedSyncCtrl()

◆ ExecSyncControl() [1/2]

◆ ExecSyncControl() [2/2]

◆ Execute()

◆ getAvgControlSendTime()

◆ GetBehind()

◆ getClient()

◆ GetControl()

◆ getControlPreSend()

◆ getCtrl()

◆ GetCtrlMode()

◆ HandleControl()

◆ HandleControlPkt()

◆ HandleControlReq()

◆ HandlePacket()

◆ Init()

◆ IsActivated()

◆ IsEnabled()

◆ IsRunning()

◆ OnResComplete()

◆ PackCompleteCtrl()

◆ RemoveClient() [1/2]

◆ RemoveClient() [2/2]

◆ SetActivated()

◆ setControlPreSend()

◆ SetCtrlMode()

◆ SetRunning()

◆ setTargetFPS()

Member Data Documentation

◆ ClientsCSec

◆ CtrlCSec

◆ eMode

◆ fActivated

◆ fEnabled

◆ fHost

◆ fRunning

◆ iAvgControlSendTime

◆ iClientID

◆ iControlPreSend

◆ iControlReady

◆ iControlSent

◆ iTargetFPS

◆ iTargetTick

◆ pClients

◆ pCtrlStack

◆ pNetwork

◆ pParent

◆ pSyncCtrlQueue

◆ SyncControl

◆ tNextControlRequest

◆ tWaitStart