C4PacketList Class Reference

#include <C4PacketBase.h>

Inheritance diagram for C4PacketList:

Collaboration diagram for C4PacketList:

Public Member Functions
	C4PacketList ()
	C4PacketList (const C4PacketList &List2)
	~C4PacketList () override
C4IDPacket *	firstPkt () const
C4IDPacket *	nextPkt (C4IDPacket *pPkt) const
int32_t	getPktCnt () const
void	Add (C4IDPacket *pPkt)
void	AddHead (C4IDPacket *pPkt)
void	Add (C4PacketType eType, C4PacketBase *pPkt)
void	AddHead (C4PacketType eType, C4PacketBase *pPkt)
void	Take (C4PacketList &List)
void	Append (const C4PacketList &List)
void	Clear ()
void	Remove (C4IDPacket *pPkt)
void	Delete (C4IDPacket *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
C4IDPacket *	pFirst {nullptr}
C4IDPacket *	pLast {nullptr}

Detailed Description

Definition at line 271 of file C4PacketBase.h.

Constructor & Destructor Documentation

C4PacketList() [1/2]

C4PacketList::C4PacketList ( )

default

C4PacketList() [2/2]

C4PacketList::C4PacketList

(

const C4PacketList &

List2

)

Definition at line 263 of file C4Packet2.cpp.

        : C4PacketBase(List2),
        pFirst(nullptr), pLast(nullptr)
{
    Append(List2);
}

References Append().

Here is the call graph for this function:

~C4PacketList()

C4PacketList::~C4PacketList ( )

override

Definition at line 270 of file C4Packet2.cpp.

{
    Clear();
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

Add() [1/2]

void C4PacketList::Add

(

C4IDPacket *

pPkt

)

Definition at line 283 of file C4Packet2.cpp.

{
    assert(!pPkt->pNext);
    (pLast ? pLast->pNext : pFirst) = pPkt;
    pLast = pPkt;
}

References pFirst, pLast, and C4IDPacket::pNext.

Referenced by C4Control::Add(), Add(), Append(), CompileFunc(), and C4Playback::ExecuteControl().

Here is the caller graph for this function:

Add() [2/2]

void C4PacketList::Add	(	C4PacketType	eType,
		C4PacketBase *	pPkt
	)

Definition at line 298 of file C4Packet2.cpp.

{
    Add(new C4IDPacket(eType, pPkt));
}

References Add().

Here is the call graph for this function:

AddHead() [1/2]

void C4PacketList::AddHead

(

C4IDPacket *

pPkt

)

Definition at line 290 of file C4Packet2.cpp.

{
    assert(!pPkt->pNext);
    pPkt->pNext = pFirst;
    pFirst = pPkt;
    if (!pLast) pLast = pPkt;
}

References pFirst, pLast, and C4IDPacket::pNext.

Referenced by C4Control::AddHead(), and AddHead().

Here is the caller graph for this function:

AddHead() [2/2]

void C4PacketList::AddHead	(	C4PacketType	eType,
		C4PacketBase *	pPkt
	)

Definition at line 303 of file C4Packet2.cpp.

{
    AddHead(new C4IDPacket(eType, pPkt));
}

References AddHead().

Here is the call graph for this function:

Append()

void C4PacketList::Append

(

const C4PacketList &

List

)

Definition at line 315 of file C4Packet2.cpp.

{
    for (C4IDPacket *pPkt = List.firstPkt(); pPkt; pPkt = List.nextPkt(pPkt))
        Add(new C4IDPacket(*pPkt));
}

References Add(), firstPkt(), and nextPkt().

Referenced by C4Control::Append(), C4PacketList(), and C4Control::Copy().

Here is the call graph for this function:

Here is the caller graph for this function:

Clear()

void C4PacketList::Clear

(

)

Definition at line 321 of file C4Packet2.cpp.

{
    while (pFirst)
        Delete(pFirst);
}

References Delete(), and pFirst.

Referenced by C4Control::Clear(), C4Playback::ExecuteControl(), and ~C4PacketList().

Here is the call graph for this function:

Here is the caller graph for this function:

CompileFunc()

void C4PacketList::CompileFunc ( StdCompiler *  pComp )

overridevirtual

Implements C4PacketBase.

Definition at line 354 of file C4Packet2.cpp.

{
    // unpack packets
    if (pComp->isDeserializer())
    {
        // Read until no further sections available
        while (pComp->Name("IDPacket"))
        {
            // Read the packet
            C4IDPacket *pPkt = new C4IDPacket();
            try
            {
                pComp->Value(*pPkt);
                pComp->NameEnd();
            }
            catch (...)
            {
                delete pPkt;
                throw;
            }
            // Terminator?
            if (!pPkt->getPkt()) { delete pPkt; break; }
            // Add to list
            Add(pPkt);
        }
        pComp->NameEnd();
    }
    else
    {
        // Write all packets
        for (C4IDPacket *pPkt = pFirst; pPkt; pPkt = pPkt->pNext)
            pComp->Value(mkNamingAdapt(*pPkt, "IDPacket"));
        // Terminate, if no naming is available
        if (!pComp->hasNaming())
        {
            C4IDPacket Pkt;
            pComp->Value(mkNamingAdapt(Pkt, "IDPacket"));
        }
    }
}

References Add(), C4IDPacket::getPkt(), StdCompiler::hasNaming(), StdCompiler::isDeserializer(), mkNamingAdapt(), StdCompiler::Name(), StdCompiler::NameEnd(), pFirst, C4IDPacket::pNext, and StdCompiler::Value().

Here is the call graph for this function:

Delete()

void C4PacketList::Delete

(

C4IDPacket *

pPkt

)

Definition at line 348 of file C4Packet2.cpp.

{
    Remove(pPkt);
    delete pPkt;
}

References Remove().

Referenced by C4Playback::Check(), C4Playback::Clear(), Clear(), and C4Control::Delete().

Here is the call graph for this function:

Here is the caller graph for this function:

firstPkt()

C4IDPacket* C4PacketList::firstPkt ( ) const

inline

Definition at line 282 of file C4PacketBase.h.

{ return pFirst; }

References pFirst.

Referenced by Append(), C4Playback::Check(), C4Playback::Clear(), C4Playback::ExecuteControl(), and C4Control::firstPkt().

Here is the caller graph for this function:

getPktCnt()

int32_t C4PacketList::getPktCnt

(

)

const

Definition at line 275 of file C4Packet2.cpp.

{
    int32_t iCnt = 0;
    for (C4IDPacket *pPkt = pFirst; pPkt; pPkt = pPkt->pNext)
        iCnt++;
    return iCnt;
}

References iCnt, pFirst, and C4IDPacket::pNext.

nextPkt()

C4IDPacket* C4PacketList::nextPkt ( C4IDPacket *  pPkt ) const

inline

Definition at line 283 of file C4PacketBase.h.

{ return pPkt->pNext; }

References C4IDPacket::pNext.

Referenced by Append(), and C4Control::nextPkt().

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:

Remove()

void C4PacketList::Remove

(

C4IDPacket *

pPkt

)

Definition at line 327 of file C4Packet2.cpp.

{
    if (pPkt == pFirst)
    {
        pFirst = pPkt->pNext;
        if (pPkt == pLast)
            pLast = nullptr;
    }
    else
    {
        C4IDPacket *pPrev;
        for (pPrev = pFirst; pPrev && pPrev->pNext != pPkt; pPrev = pPrev->pNext) {}
        if (pPrev)
        {
            pPrev->pNext = pPkt->pNext;
            if (pPkt == pLast)
                pLast = pPrev;
        }
    }
}

References pFirst, pLast, and C4IDPacket::pNext.

Referenced by Delete(), and C4Control::Remove().

Here is the caller graph for this function:

Take()

void C4PacketList::Take

(

C4PacketList &

List

)

Definition at line 308 of file C4Packet2.cpp.

{
    pFirst = List.pFirst;
    pLast = List.pLast;
    List.pFirst = List.pLast = nullptr;
}

References pFirst, and pLast.

Referenced by C4Control::Take().

Here is the caller 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

pFirst

C4IDPacket* C4PacketList::pFirst {nullptr}

protected

Definition at line 279 of file C4PacketBase.h.

Referenced by Add(), AddHead(), Clear(), CompileFunc(), firstPkt(), getPktCnt(), Remove(), and Take().

pLast

C4IDPacket * C4PacketList::pLast {nullptr}

protected

Definition at line 279 of file C4PacketBase.h.

Referenced by Add(), AddHead(), Remove(), and Take().

---

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

• C4PacketBase.h
• C4Packet2.cpp