C4IDPacket Class Reference

#include <C4PacketBase.h>

Inheritance diagram for C4IDPacket:

Collaboration diagram for C4IDPacket:

Public Member Functions
	C4IDPacket ()
	C4IDPacket (C4PacketType eID, C4PacketBase *pPkt, bool fTakePkt=true)
	C4IDPacket (const C4IDPacket &Packet2)
	~C4IDPacket () override
C4PacketType	getPktType () const
C4PacketBase *	getPkt () const
const char *	getPktName () const
void	Clear ()
void	Default ()
void	Set (C4PacketType eType, C4PacketBase *pPkt)
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
C4PacketType	eID {PID_None}
C4PacketBase *	pPkt {nullptr}
bool	fOwnPkt {true}
C4IDPacket *	pNext {nullptr}

Friends
class	C4PacketList

Detailed Description

Definition at line 241 of file C4PacketBase.h.

Constructor & Destructor Documentation

C4IDPacket() [1/3]

C4IDPacket::C4IDPacket ( )

default

C4IDPacket() [2/3]

C4IDPacket::C4IDPacket	(	C4PacketType	eID,
		C4PacketBase *	pPkt,
		bool	fTakePkt = true
	)

Definition at line 191 of file C4Packet2.cpp.

        : eID(eID), pPkt(pPkt), fOwnPkt(fTakePkt), pNext(nullptr)
{
 
}

C4IDPacket() [3/3]

C4IDPacket::C4IDPacket

(

const C4IDPacket &

Packet2

)

Definition at line 197 of file C4Packet2.cpp.

        : C4PacketBase(Packet2)
{
    // kinda hacky (note this might throw an uncaught exception)
    C4PacketBase::unpack(Packet2.C4PacketBase::pack());
}

References C4PacketBase::unpack().

Here is the call graph for this function:

~C4IDPacket()

C4IDPacket::~C4IDPacket ( )

override

Definition at line 204 of file C4Packet2.cpp.

{
    Clear();
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

Clear()

void C4IDPacket::Clear

(

)

Definition at line 223 of file C4Packet2.cpp.

{
    if (fOwnPkt) delete pPkt;
    pPkt = nullptr;
    eID = PID_None;
}

References eID, fOwnPkt, PID_None, and pPkt.

Referenced by ~C4IDPacket().

Here is the caller graph for this function:

CompileFunc()

void C4IDPacket::CompileFunc ( StdCompiler *  pComp )

overridevirtual

Implements C4PacketBase.

Definition at line 230 of file C4Packet2.cpp.

{
    // Packet ID
    pComp->Value(mkNamingAdapt(mkIntAdaptT<uint8_t>(eID), "ID", PID_None));
    // Compiling or Decompiling?
    if (pComp->isDeserializer())
    {
        if (!pComp->Name(getPktName()))
            { pComp->excCorrupt("C4IDPacket: Data value needed! Packet data missing!"); return; }
        // Delete old packet
        if (fOwnPkt) delete pPkt;
        pPkt = nullptr;
        if (eID == PID_None) return;
        // Search unpacking function
        for (const C4PktHandlingData *pPData = PktHandlingData; pPData->ID != PID_None; pPData++)
            if (pPData->ID == eID && pPData->FnUnpack)
            {
                pPkt = pPData->FnUnpack(pComp);
                break;
            }
        if (!pPkt)
            pComp->excCorrupt("C4IDPacket: could not unpack packet id %02x!", eID);
        pComp->NameEnd();
    }
    else if (eID != PID_None)
        // Just write
        pComp->Value(mkNamingAdapt(*pPkt, getPktName()));
}

References eID, StdCompiler::excCorrupt(), fOwnPkt, getPktName(), C4PktHandlingData::ID, StdCompiler::isDeserializer(), mkNamingAdapt(), StdCompiler::Name(), StdCompiler::NameEnd(), PID_None, PktHandlingData, pPkt, and StdCompiler::Value().

Here is the call graph for this function:

Default()

void C4IDPacket::Default

(

)

Definition at line 218 of file C4Packet2.cpp.

{
    eID = PID_None; pPkt = nullptr;
}

References eID, PID_None, and pPkt.

Referenced by C4Playback::ExecuteControl(), and C4GameControlNetwork::HandlePacket().

Here is the caller graph for this function:

getPkt()

C4PacketBase* C4IDPacket::getPkt ( ) const

inline

Definition at line 260 of file C4PacketBase.h.

{ return pPkt; }

References pPkt.

Referenced by C4Network2IO::CallHandlers(), C4Playback::Check(), C4PacketList::CompileFunc(), C4Network2::EndVote(), C4Network2::Execute(), C4Playback::ExecuteControl(), C4GameControlNetwork::HandlePacket(), and C4Record::Rec().

Here is the caller graph for this function:

getPktName()

const char * C4IDPacket::getPktName

(

)

const

Definition at line 209 of file C4Packet2.cpp.

{
    // Use map
    for (const C4PktHandlingData *pPData = PktHandlingData; pPData->ID != PID_None; pPData++)
        if (pPData->ID == eID && pPData->Name)
            return pPData->Name;
    return "Unknown Packet Type";
}

References eID, C4PktHandlingData::ID, PID_None, and PktHandlingData.

Referenced by CompileFunc().

Here is the caller graph for this function:

getPktType()

C4PacketType C4IDPacket::getPktType ( ) const

inline

Definition at line 259 of file C4PacketBase.h.

{ return eID; }

References eID.

Referenced by C4Network2IO::CallHandlers(), C4Playback::Check(), C4Playback::ExecuteControl(), C4GameControlNetwork::HandlePacket(), and C4Network2IO::HandlePacket().

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:

Set()

void C4IDPacket::Set	(	C4PacketType	eType,
		C4PacketBase *	pPkt
	)

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(), and C4Network2IO::HandlePacket().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

C4PacketList

friend class C4PacketList

friend

Definition at line 243 of file C4PacketBase.h.

Member Data Documentation

eID

C4PacketType C4IDPacket::eID {PID_None}

protected

Definition at line 251 of file C4PacketBase.h.

Referenced by Clear(), CompileFunc(), Default(), getPktName(), and getPktType().

fOwnPkt

bool C4IDPacket::fOwnPkt {true}

protected

Definition at line 253 of file C4PacketBase.h.

Referenced by Clear(), and CompileFunc().

pNext

C4IDPacket* C4IDPacket::pNext {nullptr}

protected

Definition at line 256 of file C4PacketBase.h.

Referenced by C4PacketList::Add(), C4PacketList::AddHead(), C4PacketList::CompileFunc(), C4PacketList::getPktCnt(), C4PacketList::nextPkt(), and C4PacketList::Remove().

pPkt

C4PacketBase* C4IDPacket::pPkt {nullptr}

protected

Definition at line 252 of file C4PacketBase.h.

Referenced by Clear(), CompileFunc(), Default(), and getPkt().

---

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

• C4PacketBase.h
• C4Packet2.cpp