C4Network2ClientList Class Reference

#include <C4Network2Client.h>

Collaboration diagram for C4Network2ClientList:

Public Member Functions
	C4Network2ClientList (C4Network2IO *pIO)
	~C4Network2ClientList ()
C4Network2Client *	GetClientByID (int32_t iID) const
C4Network2Client *	GetNextClientAfterID (int32_t iSmallerClientID) const
C4Network2Client *	GetClient (const char *szName) const
C4Network2Client *	GetClient (const C4ClientCore &CCore, int32_t iMaxDiffLevel=C4ClientCoreDL_IDMatch)
C4Network2Client *	GetClient (C4Network2IOConnection *pConn) const
C4Network2Client *	GetLocal () const
C4Network2Client *	GetHost ()
C4Network2Client *	GetNextClient (C4Network2Client *pClient)
unsigned int	Count ()
void	Init (C4ClientList *pClientList, bool fHost)
C4Network2Client *	RegClient (C4Client *pClient)
void	DeleteClient (C4Network2Client *pClient)
void	Clear ()
bool	BroadcastMsgToConnClients (const C4NetIOPacket &rPkt)
bool	BroadcastMsgToClients (const C4NetIOPacket &rPkt)
bool	SendMsgToHost (C4NetIOPacket rPkt)
bool	SendMsgToClient (int32_t iClient, C4NetIOPacket &&rPkt)
void	HandlePacket (char cStatus, const C4PacketBase *pBasePkt, C4Network2IOConnection *pConn)
void	SendAddresses (C4Network2IOConnection *pConn)
void	DoConnectAttempts ()
void	ResetReady ()
bool	AllClientsReady () const
void	UpdateClientActivity ()

Protected Attributes
C4Network2IO *	pIO
C4Network2Client *	pFirst
C4Network2Client *	pLocal
C4ClientList *	pClientList
bool	fHost

Detailed Description

Definition at line 143 of file C4Network2Client.h.

Constructor & Destructor Documentation

C4Network2ClientList()

C4Network2ClientList::C4Network2ClientList

(

C4Network2IO *

pIO

)

Definition at line 325 of file C4Network2Client.cpp.

        : pIO(pIO), pFirst(nullptr), pLocal(nullptr)
{
 
}

~C4Network2ClientList()

C4Network2ClientList::~C4Network2ClientList

(

)

Definition at line 331 of file C4Network2Client.cpp.

{
    Clear();
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

AllClientsReady()

bool C4Network2ClientList::AllClientsReady

(

)

const

Definition at line 620 of file C4Network2Client.cpp.

{
    for (C4Network2Client *pClient = pFirst; pClient; pClient = pClient->getNext())
        if (!pClient->isLocal() && pClient->isWaitedFor() && !pClient->isReady())
            return false;
    return true;
}

References C4Network2Client::getNext(), and pFirst.

Referenced by C4Network2::CheckStatusAck().

Here is the call graph for this function:

Here is the caller graph for this function:

BroadcastMsgToClients()

bool C4Network2ClientList::BroadcastMsgToClients

(

const C4NetIOPacket &

rPkt

)

Definition at line 489 of file C4Network2Client.cpp.

{
    // Send a msg to all clients, including clients that are not connected to
    // this computer (will get forwarded by host).
 
    C4PacketFwd Fwd; Fwd.SetListType(true);
    // lock
    pIO->BeginBroadcast(false);
    // select connections for broadcast
    for (C4Network2Client *pClient = pFirst; pClient; pClient = pClient->getNext())
        if (!pClient->isHost())
            if (pClient->isConnected())
            {
                pClient->getMsgConn()->SetBroadcastTarget(true);
                Fwd.AddClient(pClient->getID());
            }
    // broadcast
    bool fSuccess = pIO->Broadcast(rPkt);
    // unlock
    pIO->EndBroadcast();
    // clients: send forward request to host
    if (!fHost)
    {
        Fwd.SetData(rPkt);
        fSuccess &= SendMsgToHost(MkC4NetIOPacket(PID_FwdReq, Fwd));
    }
    return fSuccess;
}

References C4PacketFwd::AddClient(), C4Network2IO::BeginBroadcast(), C4Network2IO::Broadcast(), C4Network2IO::EndBroadcast(), fHost, C4Network2Client::getNext(), MkC4NetIOPacket(), pFirst, PID_FwdReq, pIO, SendMsgToHost(), C4PacketFwd::SetData(), and C4PacketFwd::SetListType().

Referenced by C4GameLobby::Countdown::Abort(), C4Network2::ChangeGameStatus(), C4Network2::CheckStatusAck(), C4GameLobby::Countdown::Countdown(), C4GameControlNetwork::DoInput(), C4GameControlNetwork::ExecSyncControl(), C4Network2::LeagueEnd(), C4GameLobby::Countdown::OnSec1Timer(), and C4GameControlNetwork::SetCtrlMode().

Here is the call graph for this function:

Here is the caller graph for this function:

BroadcastMsgToConnClients()

bool C4Network2ClientList::BroadcastMsgToConnClients

(

const C4NetIOPacket &

rPkt

)

Definition at line 471 of file C4Network2Client.cpp.

{
    // Send a msg to all clients that are currently directly reachable.
 
    // lock
    pIO->BeginBroadcast(false);
    // select connections for broadcast
    for (C4Network2Client *pClient = pFirst; pClient; pClient = pClient->getNext())
        if (pClient->isConnected())
            pClient->getMsgConn()->SetBroadcastTarget(true);
    // broadcast
    bool fSuccess = pIO->Broadcast(rPkt);
    // unlock
    pIO->EndBroadcast();
    // finished
    return fSuccess;
}

References C4Network2IO::BeginBroadcast(), C4Network2IO::Broadcast(), C4Network2IO::EndBroadcast(), C4Network2Client::getNext(), pFirst, and pIO.

Referenced by C4Network2Client::AddAddr(), C4GameControlNetwork::CheckCompleteCtrl(), C4GameControlNetwork::Init(), C4GameControlNetwork::PackCompleteCtrl(), and C4Network2Client::SendAddresses().

Here is the call graph for this function:

Here is the caller graph for this function:

Clear()

void C4Network2ClientList::Clear

(

)

Definition at line 454 of file C4Network2Client.cpp.

{
    // remove link to main client list
    if (pClientList)
    {
        C4ClientList *poClientList = pClientList;
        pClientList = nullptr;
        poClientList->ClearNetwork();
    }
    // delete clients
    while (pFirst)
    {
        DeleteClient(pFirst);
    }
    pLocal = nullptr;
}

References C4ClientList::ClearNetwork(), DeleteClient(), pClientList, pFirst, and pLocal.

Referenced by C4Network2::Clear(), C4ClientList::ClearNetwork(), C4ClientList::InitNetwork(), and ~C4Network2ClientList().

Here is the call graph for this function:

Here is the caller graph for this function:

Count()

unsigned int C4Network2ClientList::Count

(

)

Definition at line 379 of file C4Network2Client.cpp.

{
    unsigned int ret(0);
    for (C4Network2Client *pClient = pFirst; pClient; pClient = pClient->pNext) ret++;
    return ret;
}

References pFirst, and C4Network2Client::pNext.

Referenced by C4Network2::OnClientDisconnect(), and C4GameLobby::Countdown::OnSec1Timer().

Here is the caller graph for this function:

DeleteClient()

void C4Network2ClientList::DeleteClient

(

C4Network2Client *

pClient

)

Definition at line 432 of file C4Network2Client.cpp.

{
    // close connections
    pClient->CloseConns("removing client");
    // remove from list
    if (pClient == pFirst)
        pFirst = pClient->getNext();
    else
    {
        C4Network2Client *pPrev;
        for (pPrev = pFirst; pPrev && pPrev->getNext(); pPrev = pPrev->getNext())
            if (pPrev->getNext() == pClient)
                break;
        if (pPrev && pPrev->getNext() == pClient)
            pPrev->pNext = pClient->getNext();
    }
    // remove auto-accept
    pIO->RemoveAutoAccept(pClient->getCore());
    // delete
    delete pClient;
}

References C4Network2Client::CloseConns(), C4Network2Client::getCore(), C4Network2Client::getNext(), pFirst, pIO, C4Network2Client::pNext, and C4Network2IO::RemoveAutoAccept().

Referenced by Clear(), and C4ClientList::Remove().

Here is the call graph for this function:

Here is the caller graph for this function:

DoConnectAttempts()

void C4Network2ClientList::DoConnectAttempts

(

)

Definition at line 601 of file C4Network2Client.cpp.

{
    // check interval
    time_t t; time(&t);
    for (C4Network2Client *pClient = pFirst; pClient; pClient = pClient->getNext())
    {
        if (!pClient->isLocal() && !pClient->isRemoved() && pClient->getNextConnAttempt() && pClient->getNextConnAttempt() <= t)
            // attempt connect
            pClient->DoConnectAttempt(pIO);
    }
}

References C4Network2Client::getNext(), pFirst, and pIO.

Referenced by C4Network2::Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

GetClient() [1/3]

C4Network2Client * C4Network2ClientList::GetClient

(

C4Network2IOConnection *

pConn

)

const

Definition at line 363 of file C4Network2Client.cpp.

{
    for (C4Network2Client *pClient = pFirst; pClient; pClient = pClient->pNext)
        if (pClient->hasConn(pConn))
            return pClient;
    return nullptr;
}

References pFirst, and C4Network2Client::pNext.

GetClient() [2/3]

C4Network2Client * C4Network2ClientList::GetClient	(	const C4ClientCore &	CCore,
		int32_t	iMaxDiffLevel = C4ClientCoreDL_IDMatch
	)

Definition at line 371 of file C4Network2Client.cpp.

{
    for (C4Network2Client *pClient = pFirst; pClient; pClient = pClient->pNext)
        if (pClient->getCore().getDiffLevel(CCore) <= iMaxDiffLevel)
            return pClient;
    return nullptr;
}

References pFirst, and C4Network2Client::pNext.

GetClient() [3/3]

C4Network2Client * C4Network2ClientList::GetClient

(

const char *

szName

)

const

Definition at line 355 of file C4Network2Client.cpp.

{
    for (C4Network2Client *pClient = pFirst; pClient; pClient = pClient->pNext)
        if (SEqual(pClient->getName(), szName))
            return pClient;
    return nullptr;
}

References pFirst, C4Network2Client::pNext, and SEqual().

Referenced by C4Network2::HandleConn(), C4Network2::HandleLobbyPacket(), C4Network2::HandlePacket(), HandlePacket(), C4Network2Players::HandlePacket(), C4Network2::Join(), and C4Network2::OnDisconn().

Here is the call graph for this function:

Here is the caller graph for this function:

GetClientByID()

C4Network2Client * C4Network2ClientList::GetClientByID

(

int32_t

iID

)

const

Definition at line 336 of file C4Network2Client.cpp.

{
    for (C4Network2Client *pClient = pFirst; pClient; pClient = pClient->pNext)
        if (pClient->getID() == iID)
            return pClient;
    return nullptr;
}

References pFirst, and C4Network2Client::pNext.

Referenced by C4GameControlNetwork::CalcPerformance(), GetHost(), C4Network2::HandleLobbyPacket(), C4Network2::HandlePacket(), HandlePacket(), C4Network2Players::HandlePacket(), C4Network2::OnConnectFail(), C4Network2::OnDisconn(), and SendMsgToClient().

Here is the caller graph for this function:

GetHost()

C4Network2Client * C4Network2ClientList::GetHost

(

)

Definition at line 386 of file C4Network2Client.cpp.

{
    return GetClientByID(C4ClientIDHost);
}

References C4ClientIDHost, and GetClientByID().

Referenced by C4Network2::HandleConn(), C4Network2::OnDisconn(), and SendMsgToHost().

Here is the call graph for this function:

Here is the caller graph for this function:

GetLocal()

C4Network2Client* C4Network2ClientList::GetLocal ( ) const

inline

Definition at line 162 of file C4Network2Client.h.

{ return pLocal; }

References pLocal.

Referenced by C4Network2Client::DoConnectAttempt(), C4Network2Client::DoTCPSimultaneousOpen(), C4Network2::DrawStatus(), C4Viewport::Execute(), C4Network2::InitNetIO(), C4Network2::LeagueNotifyDisconnect(), C4Network2::OnPuncherConnect(), and C4MessageInput::ProcessCommand().

Here is the caller graph for this function:

GetNextClient()

C4Network2Client * C4Network2ClientList::GetNextClient

(

C4Network2Client *

pClient

)

Definition at line 391 of file C4Network2Client.cpp.

{
    return pClient ? pClient->pNext : pFirst;
}

References pFirst, and C4Network2Client::pNext.

Referenced by C4MainMenu::ActivateHost(), C4Network2Stats::C4Network2Stats(), C4Network2::DeactivateInactiveClients(), C4Network2::DrawStatus(), C4Network2Stats::ExecuteSecond(), C4Network2::OnGameSynchronized(), C4Network2::UpdateChaseTarget(), C4Console::UpdateNetMenu(), C4GameSave::WriteDescNetworkClients(), and C4Network2Stats::~C4Network2Stats().

Here is the caller graph for this function:

GetNextClientAfterID()

C4Network2Client * C4Network2ClientList::GetNextClientAfterID

(

int32_t

iSmallerClientID

)

const

Definition at line 344 of file C4Network2Client.cpp.

{
    // return client with smallest ID > iSmallerClientID
    C4Network2Client *pBest = nullptr;
    for (C4Network2Client *pClient = pFirst; pClient; pClient = pClient->pNext)
        if (pClient->getID() > iSmallerClientID)
            if (!pBest || pBest->getID() > pClient->getID())
                pBest = pClient;
    return pBest;
}

References C4Network2Client::getID(), pFirst, and C4Network2Client::pNext.

Here is the call graph for this function:

HandlePacket()

void C4Network2ClientList::HandlePacket	(	char	cStatus,
		const C4PacketBase *	pBasePkt,
		C4Network2IOConnection *	pConn
	)

Definition at line 543 of file C4Network2Client.cpp.

{
    // find associated client
    C4Network2Client *pClient = GetClient(pConn);
    if (!pClient) return;
 
#define GETPKT(type, name) \
    assert(pBasePkt); const type &name = \
     static_cast<const type &>(*pBasePkt);
 
    switch (cStatus)
    {
 
    case PID_Addr: // address propagation
    {
        GETPKT(C4PacketAddr, rPkt)
        // find client
        pClient = GetClientByID(rPkt.getClientID());
        if (pClient)
        {
            C4Network2Address addr = rPkt.getAddr();
            // IP zero? Set to IP from where the packet came
            if (addr.isIPNull())
            {
                addr.SetIP(pConn->getPeerAddr());
            }
            // add (no announce)
            if (pClient->AddAddr(addr, true))
                // new address? Try to connect
                pClient->DoConnectAttempt(pIO);
        }
    }
    break;
 
    case PID_TCPSimOpen:
    {
        GETPKT(C4PacketTCPSimOpen, rPkt)
        pClient = GetClientByID(rPkt.getClientID());
        if (pClient)
        {
            C4Network2Address addr = rPkt.getAddr();
            pClient->DoTCPSimultaneousOpen(pIO, addr);
        }
    }
    break;
 
    }
 
#undef GETPKT
}

References C4Network2Client::AddAddr(), C4Network2Client::DoConnectAttempt(), C4Network2Client::DoTCPSimultaneousOpen(), C4Network2Address::getAddr(), GetClient(), GetClientByID(), C4Network2IOConnection::getPeerAddr(), GETPKT, C4Network2Address::isIPNull(), PID_Addr, PID_TCPSimOpen, pIO, and C4Network2Address::SetIP().

Referenced by C4Network2IO::CallHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

Init()

void C4Network2ClientList::Init	(	C4ClientList *	pClientList,
		bool	fHost
	)

Definition at line 396 of file C4Network2Client.cpp.

{
    // save flag
    fHost = fnHost;
    // initialize
    pClientList = pnClientList;
    pClientList->InitNetwork(this);
}

References fHost, C4ClientList::InitNetwork(), and pClientList.

Referenced by C4Network2::InitHost().

Here is the call graph for this function:

Here is the caller graph for this function:

RegClient()

C4Network2Client * C4Network2ClientList::RegClient

(

C4Client *

pClient

)

Definition at line 405 of file C4Network2Client.cpp.

{
    // security
    if (pClient->getNetClient())
        return pClient->getNetClient();
    // find insert position
    C4Network2Client *pPos = pFirst, *pLast = nullptr;
    for (; pPos; pLast = pPos, pPos = pPos->getNext())
        if (pPos->getID() > pClient->getID())
            break;
    assert(!pLast || pLast->getID() != pClient->getID());
    // create new client
    C4Network2Client *pNetClient = new C4Network2Client(pClient);
    // add to list
    pNetClient->pNext = pPos;
    (pLast ? pLast->pNext : pFirst) = pNetClient;
    pNetClient->pParent = this;
    // local?
    if (pClient->isLocal())
        pLocal = pNetClient;
    else
        // set auto-accept
        pIO->AddAutoAccept(pClient->getCore());
    // add
    return pNetClient;
}

References C4Network2IO::AddAutoAccept(), C4Client::getCore(), C4Client::getID(), C4Network2Client::getID(), C4Client::getNetClient(), C4Network2Client::getNext(), C4Client::isLocal(), pFirst, pIO, pLocal, C4Network2Client::pNext, and C4Network2Client::pParent.

Referenced by C4ClientList::Add(), and C4ClientList::InitNetwork().

Here is the call graph for this function:

Here is the caller graph for this function:

ResetReady()

void C4Network2ClientList::ResetReady

(

)

Definition at line 613 of file C4Network2Client.cpp.

{
    for (C4Network2Client *pClient = pFirst; pClient; pClient = pClient->getNext())
        if (pClient->isWaitedFor())
            pClient->SetStatus(NCS_NotReady);
}

References C4Network2Client::getNext(), NCS_NotReady, and pFirst.

Referenced by C4Network2::ChangeGameStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

SendAddresses()

void C4Network2ClientList::SendAddresses

(

C4Network2IOConnection *

pConn

)

Definition at line 594 of file C4Network2Client.cpp.

{
    // send all client addresses known
    for (C4Network2Client *pClient = pFirst; pClient; pClient = pClient->getNext())
        pClient->SendAddresses(pConn);
}

References C4Network2Client::getNext(), and pFirst.

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

Here is the call graph for this function:

Here is the caller graph for this function:

SendMsgToClient()

bool C4Network2ClientList::SendMsgToClient	(	int32_t	iClient,
		C4NetIOPacket &&	rPkt
	)

Definition at line 528 of file C4Network2Client.cpp.

{
    // find client
    C4Network2Client *pClient = GetClientByID(iClient);
    if (!pClient) return false;
    // connected? send directly
    if (pClient->isConnected())
        return pClient->SendMsg(rPkt);
    // forward
    C4PacketFwd Fwd; Fwd.SetListType(false);
    Fwd.AddClient(iClient);
    Fwd.SetData(rPkt);
    return SendMsgToHost(MkC4NetIOPacket(PID_FwdReq, Fwd));
}

References C4PacketFwd::AddClient(), GetClientByID(), C4Network2Client::isConnected(), MkC4NetIOPacket(), PID_FwdReq, C4Network2Client::SendMsg(), SendMsgToHost(), C4PacketFwd::SetData(), and C4PacketFwd::SetListType().

Referenced by C4Network2::OnDisconn().

Here is the call graph for this function:

Here is the caller graph for this function:

SendMsgToHost()

bool C4Network2ClientList::SendMsgToHost

(

C4NetIOPacket

rPkt

)

Definition at line 518 of file C4Network2Client.cpp.

{
    // find host
    C4Network2Client *pHost = GetHost();
    if (!pHost) return false;
    // send message
    if (!pHost->getMsgConn()) return false;
    return pHost->SendMsg(rPkt);
}

References GetHost(), C4Network2Client::getMsgConn(), and C4Network2Client::SendMsg().

Referenced by BroadcastMsgToClients(), C4GameControlNetwork::CheckCompleteCtrl(), C4Network2::CheckStatusReached(), C4GameControlNetwork::DoInput(), C4Network2Players::JoinLocalPlayer(), C4Network2::RequestActivate(), C4Network2Players::RequestPlayerInfoUpdate(), and SendMsgToClient().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateClientActivity()

void C4Network2ClientList::UpdateClientActivity

(

)

Definition at line 628 of file C4Network2Client.cpp.

{
    for (C4Network2Client *pClient = pFirst; pClient; pClient = pClient->getNext())
        if (pClient->isActivated())
            if (::Players.GetAtClient(pClient->getID()))
                pClient->SetLastActivity(Game.FrameCounter);
}

References C4Game::FrameCounter, Game, C4PlayerList::GetAtClient(), C4Network2Client::getNext(), pFirst, and Players.

Referenced by C4Network2::DeactivateInactiveClients().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

fHost

bool C4Network2ClientList::fHost

protected

Definition at line 154 of file C4Network2Client.h.

Referenced by BroadcastMsgToClients(), and Init().

pClientList

C4ClientList* C4Network2ClientList::pClientList

protected

Definition at line 153 of file C4Network2Client.h.

Referenced by Clear(), and Init().

pFirst

C4Network2Client* C4Network2ClientList::pFirst

protected

Definition at line 151 of file C4Network2Client.h.

Referenced by AllClientsReady(), BroadcastMsgToClients(), BroadcastMsgToConnClients(), Clear(), Count(), DeleteClient(), DoConnectAttempts(), GetClient(), GetClientByID(), GetNextClient(), GetNextClientAfterID(), RegClient(), ResetReady(), SendAddresses(), and UpdateClientActivity().

pIO

C4Network2IO* C4Network2ClientList::pIO

protected

Definition at line 150 of file C4Network2Client.h.

Referenced by BroadcastMsgToClients(), BroadcastMsgToConnClients(), DeleteClient(), DoConnectAttempts(), HandlePacket(), and RegClient().

pLocal

C4Network2Client* C4Network2ClientList::pLocal

protected

Definition at line 152 of file C4Network2Client.h.

Referenced by Clear(), GetLocal(), and RegClient().

---

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

• C4Network2Client.h
• C4Network2Client.cpp