#include <C4Client.h>

Inheritance diagram for C4ClientCore:

Collaboration diagram for C4ClientCore:

Public Member Functions
	C4ClientCore ()

	~C4ClientCore () override

int32_t	getID () const

bool	isHost () const

bool	isActivated () const

bool	isObserver () const

bool	isLobbyReady () const

void	SetID (int32_t inID)

void	SetName (const char *sznName)

void	SetActivated (bool fnActivated)

void	SetObserver (bool fnObserver)

void	SetLobbyReady (bool fnLobbyReady)

const char *	getName () const

const char *	getCUID () const

const char *	getNick () const

const char *	getRevision () const

bool	isRegistered () const

void	SetLocal (int32_t iID, bool fnActivated, bool fnObserver)

void	SetUnknown (int32_t iID)

int32_t	getDiffLevel (const C4ClientCore &CCore2) const

void	CompileFunc (StdCompiler *pComp) override

C4NetIOPacket	pack (const C4NetIO::addr_t &addr=C4NetIO::addr_t()) const

C4NetIOPacket	pack (uint8_t cStatus, const C4NetIO::addr_t &addr=C4NetIO::addr_t()) const

void	unpack (const C4NetIOPacket &Pkt, char *pStatus=nullptr)

Protected Attributes
int32_t	iID {-1}

ValidatedStdCopyStrBuf< C4InVal::VAL_NameNoEmpty >	Name

ValidatedStdCopyStrBuf< C4InVal::VAL_NameNoEmpty >	Nick

ValidatedStdCopyStrBuf< C4InVal::VAL_NameAllowEmpty >	CUID

ValidatedStdCopyStrBuf< C4InVal::VAL_NameAllowEmpty >	Revision

int	iVersion [4]

bool	fActivated {false}

bool	fObserver {false}

bool	fLobbyReady {false}

Detailed Description

Definition at line 34 of file C4Client.h.

Constructor & Destructor Documentation

◆ C4ClientCore()

C4ClientCore::C4ClientCore ( )

Definition at line 31 of file C4Client.cpp.

 {
     Name.Ref(""); CUID.Ref(""); Nick.Ref("");
 }

References CUID, Name, Nick, and StdStrBuf::Ref().

Here is the call graph for this function:

◆ ~C4ClientCore()

C4ClientCore::~C4ClientCore ( )

overridedefault

Member Function Documentation

◆ CompileFunc()

void C4ClientCore::CompileFunc ( StdCompiler * pComp )

overridevirtual

Implements C4PacketBase.

Definition at line 92 of file C4Client.cpp.

 {
     pComp->Value(mkNamingAdapt(iID, "ID", C4ClientIDUnknown));
     pComp->Value(mkNamingAdapt(fActivated, "Activated", false));
     pComp->Value(mkNamingAdapt(fObserver, "Observer", false));
     pComp->Value(mkNamingAdapt(fLobbyReady, "Ready", false));
     pComp->Value(mkNamingAdapt(Name, "Name", ""));
     pComp->Value(mkNamingAdapt(CUID, "CUID", ""));
     pComp->Value(mkNamingAdapt(Nick, "Nick", ""));
     pComp->Value(mkNamingAdapt(Revision, "Revision", ""));
 }

References C4ClientIDUnknown, CUID, fActivated, fLobbyReady, fObserver, iID, mkNamingAdapt(), Name, Nick, Revision, and StdCompiler::Value().

Here is the call graph for this function:

◆ getCUID()

const char* C4ClientCore::getCUID ( ) const

inline

Definition at line 70 of file C4Client.h.

70 { return CUID.getData(); }

StdStrBuf::getData

const char * getData() const

Definition: StdBuf.h:442

References CUID, and StdStrBuf::getData().

Referenced by C4Client::getCUID(), and getDiffLevel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDiffLevel()

int32_t C4ClientCore::getDiffLevel ( const C4ClientCore & CCore2 ) const

Definition at line 75 of file C4Client.cpp.

 {
     // nick & cuid won't ever be changed
     if (CUID != CCore2.getCUID() || Nick != CCore2.getNick())
         return C4ClientCoreDL_Different;
     // identification changed?
     if (iID != CCore2.getID() || Name != CCore2.getName())
         return C4ClientCoreDL_IDChange;
     // status change?
     if (fActivated != CCore2.isActivated() || fObserver != CCore2.isObserver() || fLobbyReady != CCore2.isLobbyReady())
         return C4ClientCoreDL_IDMatch;
     // otherwise: identical
     return C4ClientCoreDL_None;
 }

References C4ClientCoreDL_Different, C4ClientCoreDL_IDChange, C4ClientCoreDL_IDMatch, C4ClientCoreDL_None, CUID, fActivated, fLobbyReady, fObserver, getCUID(), getID(), getName(), getNick(), iID, isActivated(), isLobbyReady(), isObserver(), Name, and Nick.

Referenced by C4Network2::CheckConn(), C4Network2IO::doAutoAccept(), and C4Network2IO::RemoveAutoAccept().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getID()

int32_t C4ClientCore::getID ( ) const

inline

Definition at line 57 of file C4Client.h.

57 { return iID; }

References iID.

Referenced by C4ClientList::Add(), C4Network2::DrawStatus(), C4Network2IOConnection::getClientID(), getDiffLevel(), C4Client::getID(), C4Network2Client::getID(), C4ClientList::getLocalID(), C4Network2::HandleConn(), C4Network2IO::HandleFwdReq(), C4Network2IO::HandlePacket(), C4Network2::Join(), and C4Network2IO::SendConnPackets().

Here is the caller graph for this function:

◆ getName()

const char* C4ClientCore::getName ( ) const

inline

Definition at line 69 of file C4Client.h.

69 { return Name.getData(); }

References StdStrBuf::getData(), and Name.

Referenced by C4Network2::DrawStatus(), getDiffLevel(), C4ClientList::getLocalName(), C4Client::getName(), C4Network2Client::getName(), C4Network2::HandleConn(), and C4Network2::Join().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNick()

const char* C4ClientCore::getNick ( ) const

inline

Definition at line 71 of file C4Client.h.

71 { return Nick.getData(); }

References StdStrBuf::getData(), and Nick.

Referenced by getDiffLevel(), and C4Client::getNick().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRevision()

const char* C4ClientCore::getRevision ( ) const

inline

Definition at line 72 of file C4Client.h.

72 { return Revision.getData(); }

References StdStrBuf::getData(), and Revision.

Referenced by C4Network2::Join().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isActivated()

bool C4ClientCore::isActivated ( ) const

inline

Definition at line 59 of file C4Client.h.

59 { return fActivated; }

References fActivated.

Referenced by C4Network2::DrawStatus(), getDiffLevel(), C4Client::isActivated(), and C4Network2Client::isActivated().

Here is the caller graph for this function:

◆ isHost()

bool C4ClientCore::isHost ( ) const

inline

Definition at line 58 of file C4Client.h.

58 { return iID == C4ClientIDHost; }

C4ClientIDHost

const int32_t C4ClientIDHost

Definition: C4Client.h:25

References C4ClientIDHost, and iID.

Referenced by C4Network2::DrawStatus(), C4Network2::HostConnect(), C4Client::isHost(), and C4Network2IOConnection::isHost().

Here is the caller graph for this function:

◆ isLobbyReady()

bool C4ClientCore::isLobbyReady ( ) const

inline

Definition at line 61 of file C4Client.h.

61 { return fLobbyReady; }

References fLobbyReady.

Referenced by getDiffLevel(), and C4Client::isLobbyReady().

Here is the caller graph for this function:

◆ isObserver()

bool C4ClientCore::isObserver ( ) const

inline

Definition at line 60 of file C4Client.h.

60 { return fObserver; }

References fObserver.

Referenced by C4Network2::DrawStatus(), getDiffLevel(), C4Client::isObserver(), and C4Network2Client::isObserver().

Here is the caller graph for this function:

◆ isRegistered()

bool C4ClientCore::isRegistered ( ) const

inline

Definition at line 73 of file C4Client.h.

73 { return CUID.getLength()>0; }

StdStrBuf::getLength

size_t getLength() const

Definition: StdBuf.h:445

References CUID, and StdStrBuf::getLength().

Referenced by C4Client::isRegistered().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pack() [1/2]

C4NetIOPacket C4PacketBase::pack ( const C4NetIO::addr_t & addr = C4NetIO::addr_t() ) const

inherited

Definition at line 150 of file C4Packet2.cpp.

 {
     return C4NetIOPacket(DecompileToBuf<StdCompilerBinWrite>(*this), addr);
 }

Referenced by MkC4NetIOPacket().

Here is the caller graph for this function:

◆ pack() [2/2]

C4NetIOPacket C4PacketBase::pack	(	uint8_t	cStatus,
		const C4NetIO::addr_t &	addr = `C4NetIO::addr_t()`
	)		const

inherited

Definition at line 155 of file C4Packet2.cpp.

 {
     return C4NetIOPacket(DecompileToBuf<StdCompilerBinWrite>(mkInsertAdapt(mkDecompileAdapt(*this), cStatus)), addr);
 }

References mkDecompileAdapt(), and mkInsertAdapt().

Here is the call graph for this function:

◆ SetActivated()

void C4ClientCore::SetActivated ( bool fnActivated )

inline

Definition at line 64 of file C4Client.h.

64 { fActivated = fnActivated; fObserver = false; }

References fActivated, and fObserver.

Referenced by C4Network2::Join(), and C4Client::SetActivated().

Here is the caller graph for this function:

◆ SetID()

void C4ClientCore::SetID ( int32_t inID )

inline

Definition at line 62 of file C4Client.h.

62 { iID = inID; }

References iID.

Referenced by C4Network2::InitNetIO(), C4Network2::Join(), and C4Client::SetID().

Here is the caller graph for this function:

◆ SetLobbyReady()

void C4ClientCore::SetLobbyReady ( bool fnLobbyReady )

inline

Definition at line 66 of file C4Client.h.

66 { fLobbyReady = fnLobbyReady; }

References fLobbyReady.

Referenced by C4Client::SetLobbyReady().

Here is the caller graph for this function:

◆ SetLocal()

void C4ClientCore::SetLocal	(	int32_t	iID,
		bool	fnActivated,
		bool	fnObserver
	)

Definition at line 38 of file C4Client.cpp.

 {
     // status
     iID = inID;
     fActivated = fnActivated;
     fObserver = fnObserver;
     // misc
     CUID.CopyValidated(Config.GetRegistrationData("Cuid"));
     Revision.CopyValidated(Application.GetRevision());
     if (Config.Network.Nick.getLength())
     {
         Name.CopyValidated(Config.Network.Nick);
         Nick.Copy(Name);
     }
     else
     {
         const char* position = std::strchr(Config.General.Participants, ';');
         if (!position)
             position = Config.General.Participants + std::strlen(Config.General.Participants);
         if (Config.General.Participants + 4 <= position && std::strncmp(position - 4, ".ocp", 4) == 0)
             Name.CopyValidated(std::string(Config.General.Participants, position - Config.General.Participants - 4).c_str());
         else
             Name.Copy("empty");
         Nick.Copy(Name);
     }
 }

References Application, Config, StdStrBuf::Copy(), ValidatedStdCopyStrBufBase::CopyValidated(), CUID, fActivated, fObserver, C4Config::General, StdStrBuf::getLength(), C4Config::GetRegistrationData(), C4Application::GetRevision(), iID, Name, C4Config::Network, C4ConfigNetwork::Nick, Nick, C4ConfigGeneral::Participants, and Revision.

Referenced by C4ClientList::AddLocal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetName()

void C4ClientCore::SetName ( const char * sznName )

inline

Definition at line 63 of file C4Client.h.

63 { Name.CopyValidated(sznName); }

References ValidatedStdCopyStrBufBase::CopyValidated(), and Name.

Referenced by C4Network2::Join().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetObserver()

void C4ClientCore::SetObserver ( bool fnObserver )

inline

Definition at line 65 of file C4Client.h.

65 { fActivated &= !(fObserver = fnObserver); }

References fActivated, and fObserver.

Referenced by C4Network2::Join(), and C4Client::SetObserver().

Here is the caller graph for this function:

◆ SetUnknown()

void C4ClientCore::SetUnknown ( int32_t iID )

Definition at line 65 of file C4Client.cpp.

 {
     // save id
     iID = inID;
     // fill everything else with default values
     Name.Ref("unknown"); CUID.Ref("unknown"); Nick.Ref("unknown");
     Revision.Ref("unknown");
     fActivated = fObserver = false;
 }

References CUID, fActivated, fObserver, iID, Name, Nick, StdStrBuf::Ref(), and Revision.

Here is the call graph for this function:

◆ unpack()

void C4PacketBase::unpack	(	const C4NetIOPacket &	Pkt,
		char *	pStatus = `nullptr`
	)

inherited

Definition at line 160 of file C4Packet2.cpp.

 {
     if (pStatus) *pStatus = Pkt.getStatus();
     CompileFromBuf<StdCompilerBinRead>(*this, pStatus ? Pkt.getPBuf() : Pkt.getRef());
 }

References C4NetIOPacket::getPBuf(), C4NetIOPacket::getRef(), and C4NetIOPacket::getStatus().

Referenced by C4IDPacket::C4IDPacket(), and C4Network2IO::HandlePacket().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ CUID

ValidatedStdCopyStrBuf<C4InVal::VAL_NameAllowEmpty> C4ClientCore::CUID

protected

Definition at line 45 of file C4Client.h.

Referenced by C4ClientCore(), CompileFunc(), getCUID(), getDiffLevel(), isRegistered(), SetLocal(), and SetUnknown().

◆ fActivated

bool C4ClientCore::fActivated {false}

protected

Definition at line 52 of file C4Client.h.

Referenced by CompileFunc(), getDiffLevel(), isActivated(), SetActivated(), SetLocal(), SetObserver(), and SetUnknown().

◆ fLobbyReady

bool C4ClientCore::fLobbyReady {false}

protected

Definition at line 52 of file C4Client.h.

Referenced by CompileFunc(), getDiffLevel(), isLobbyReady(), and SetLobbyReady().

◆ fObserver

bool C4ClientCore::fObserver {false}

protected

Definition at line 52 of file C4Client.h.

Referenced by CompileFunc(), getDiffLevel(), isObserver(), SetActivated(), SetLocal(), SetObserver(), and SetUnknown().

◆ iID

int32_t C4ClientCore::iID {-1}

protected

Definition at line 43 of file C4Client.h.

Referenced by CompileFunc(), getDiffLevel(), getID(), isHost(), SetID(), SetLocal(), and SetUnknown().

◆ iVersion

int C4ClientCore::iVersion[4]

protected

Definition at line 49 of file C4Client.h.

◆ Name

ValidatedStdCopyStrBuf<C4InVal::VAL_NameNoEmpty> C4ClientCore::Name

protected

Definition at line 44 of file C4Client.h.

Referenced by C4ClientCore(), CompileFunc(), getDiffLevel(), getName(), SetLocal(), SetName(), and SetUnknown().

◆ Nick

ValidatedStdCopyStrBuf<C4InVal::VAL_NameNoEmpty> C4ClientCore::Nick

protected

Definition at line 44 of file C4Client.h.

Referenced by C4ClientCore(), CompileFunc(), getDiffLevel(), getNick(), SetLocal(), and SetUnknown().

◆ Revision

ValidatedStdCopyStrBuf<C4InVal::VAL_NameAllowEmpty> C4ClientCore::Revision

protected

Definition at line 46 of file C4Client.h.

Referenced by CompileFunc(), getRevision(), SetLocal(), and SetUnknown().

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ C4ClientCore()

◆ ~C4ClientCore()

Member Function Documentation

◆ CompileFunc()

◆ getCUID()

◆ getDiffLevel()

◆ getID()

◆ getName()

◆ getNick()

◆ getRevision()

◆ isActivated()

◆ isHost()

◆ isLobbyReady()

◆ isObserver()

◆ isRegistered()

◆ pack() [1/2]

◆ pack() [2/2]

◆ SetActivated()

◆ SetID()

◆ SetLobbyReady()

◆ SetLocal()

◆ SetName()

◆ SetObserver()

◆ SetUnknown()

◆ unpack()

Member Data Documentation

◆ CUID

◆ fActivated

◆ fLobbyReady

◆ fObserver

◆ iID

◆ iVersion

◆ Name

◆ Nick

◆ Revision