C4NetIOUDP::Packet Class Reference

#include <C4NetIO.h>

Collaboration diagram for C4NetIOUDP::Packet:

Public Types
typedef uint32_t	nr_t

Public Member Functions
	Packet ()
	Packet (C4NetIOPacket &&rnData, nr_t inNr)
	~Packet ()
C4NetIOPacket &	GetData ()
const C4NetIOPacket &	GetData () const
nr_t	GetNr () const
bool	Empty () const
bool	Multicast () const
nr_t	FragmentCnt () const
C4NetIOPacket	GetFragment (nr_t iFNr, bool fBroadcastFlag=false) const
bool	Complete () const
bool	FragmentPresent (nr_t iFNr) const
bool	AddFragment (const C4NetIOPacket &Packet, const C4NetIO::addr_t &addr)

Static Public Attributes
static const size_t	MaxSize = 512
static const size_t	MaxDataSize = MaxSize - sizeof(DataPacketHdr)

Protected Member Functions
::size_t	FragmentSize (nr_t iFNr) const

Protected Attributes
nr_t	iNr
C4NetIOPacket	Data
bool *	pFragmentGot {nullptr}
Packet *	Next
Packet *	Prev

Friends
class	PacketList

Detailed Description

Definition at line 664 of file C4NetIO.h.

Member Typedef Documentation

nr_t

typedef uint32_t C4NetIOUDP::Packet::nr_t

Definition at line 674 of file C4NetIO.h.

Constructor & Destructor Documentation

Packet() [1/2]

C4NetIOUDP::Packet::Packet

(

)

Definition at line 2922 of file C4NetIO.cpp.

        : iNr(~0),
        Data()
{
 
}

Packet() [2/2]

C4NetIOUDP::Packet::Packet	(	C4NetIOPacket &&	rnData,
		nr_t	inNr
	)

Definition at line 2929 of file C4NetIO.cpp.

        : iNr(inNr),
        Data(rnData),
        pFragmentGot(nullptr)
{
 
}

~Packet()

C4NetIOUDP::Packet::~Packet

(

)

Definition at line 2937 of file C4NetIO.cpp.

{
    delete [] pFragmentGot; pFragmentGot = nullptr;
}

Member Function Documentation

AddFragment()

bool C4NetIOUDP::Packet::AddFragment	(	const C4NetIOPacket &	Packet,
		const C4NetIO::addr_t &	addr
	)

Definition at line 2985 of file C4NetIO.cpp.

{
    // ensure the packet is big enough
    if (Packet.getSize() < sizeof(DataPacketHdr)) return false;
    size_t iPacketDataSize = Packet.getSize() - sizeof(DataPacketHdr);
    // get header
    const DataPacketHdr *pHdr = getBufPtr<DataPacketHdr>(Packet);
    // first fragment got?
    bool fFirstFragment = Empty();
    if (fFirstFragment)
    {
        // init
        iNr = pHdr->FNr;
        Data.New(pHdr->Size); Data.SetAddr(addr);
        // fragmented? create fragment list
        if (FragmentCnt() > 1)
            memset(pFragmentGot = new bool [FragmentCnt()], false, FragmentCnt());
        // check header
        if (pHdr->Nr < iNr || pHdr->Nr >= iNr + FragmentCnt()) { Data.Clear(); return false; }
    }
    else
    {
        // check header
        if (pHdr->FNr != iNr) return false;
        if (pHdr->Size != Data.getSize()) return false;
        if (pHdr->Nr < iNr || pHdr->Nr >= iNr + FragmentCnt()) return false;
    }
    // check packet size
    nr_t iFNr = pHdr->Nr - iNr;
    if (iPacketDataSize != FragmentSize(iFNr)) return false;
    // already got this fragment? (needs check for first packet as FragmentPresent always assumes true if pFragmentGot is nullptr)
    StdBuf PacketData = Packet.getPart(sizeof(DataPacketHdr), iPacketDataSize);
    if (!fFirstFragment && FragmentPresent(iFNr))
    {
        // compare
        if (Data.Compare(PacketData, iFNr * MaxDataSize))
            return false;
    }
    else
    {
        // otherwise: copy data
        Data.Write(PacketData, iFNr * MaxDataSize);
        // set flag (if fragmented)
        if (pFragmentGot)
            pFragmentGot[iFNr] = true;
        // shouldn't happen
        else
            assert(Complete());
    }
    // ok
    return true;
}

References C4NetIOUDP::DataPacketHdr::FNr, C4NetIOUDP::PacketHdr::Nr, and C4NetIOUDP::DataPacketHdr::Size.

Referenced by C4NetIOUDP::Peer::OnRecv().

Here is the caller graph for this function:

Complete()

bool C4NetIOUDP::Packet::Complete

(

)

const

Definition at line 2971 of file C4NetIO.cpp.

{
    if (Empty()) return false;
    for (unsigned int i = 0; i < FragmentCnt(); i++)
        if (!FragmentPresent(i))
            return false;
    return true;
}

Empty()

bool C4NetIOUDP::Packet::Empty ( ) const

inline

Definition at line 692 of file C4NetIO.h.

{ return Data.isNull(); }

References Data, and StdBuf::isNull().

Here is the call graph for this function:

FragmentCnt()

C4NetIOUDP::Packet::nr_t C4NetIOUDP::Packet::FragmentCnt

(

)

const

Definition at line 2947 of file C4NetIO.cpp.

{
    return Data.getSize() ? (Data.getSize() - 1) / MaxDataSize + 1 : 1;
}

Referenced by C4NetIOUDP::PacketList::AddPacket(), C4NetIOUDP::Broadcast(), C4NetIOUDP::BroadcastDirect(), C4NetIOUDP::Peer::CheckCompleteIPackets(), C4NetIOUDP::Peer::Send(), and C4NetIOUDP::Peer::SendDirect().

Here is the caller graph for this function:

FragmentPresent()

bool C4NetIOUDP::Packet::FragmentPresent

(

nr_t

iFNr

)

const

Definition at line 2980 of file C4NetIO.cpp.

{
    return !Empty() && iFNr < FragmentCnt() && (!pFragmentGot || pFragmentGot[iFNr]);
}

Referenced by C4NetIOUDP::PacketList::FragmentPresent().

Here is the caller graph for this function:

FragmentSize()

size_t C4NetIOUDP::Packet::FragmentSize ( nr_t  iFNr ) const

protected

Definition at line 3038 of file C4NetIO.cpp.

{
    assert(iFNr < FragmentCnt());
    return std::min(MaxDataSize, Data.getSize() - iFNr * MaxDataSize);
}

GetData() [1/2]

C4NetIOPacket& C4NetIOUDP::Packet::GetData ( )

inline

Definition at line 689 of file C4NetIO.h.

{ return Data; }

References Data.

Referenced by C4NetIOUDP::Peer::CheckCompleteIPackets(), and C4NetIOUDP::Peer::Send().

Here is the caller graph for this function:

GetData() [2/2]

const C4NetIOPacket& C4NetIOUDP::Packet::GetData ( ) const

inline

Definition at line 690 of file C4NetIO.h.

{ return Data; }

References Data.

GetFragment()

C4NetIOPacket C4NetIOUDP::Packet::GetFragment	(	nr_t	iFNr,
		bool	fBroadcastFlag = false
	)		const

Definition at line 2952 of file C4NetIO.cpp.

{
    assert(iFNr < FragmentCnt());
    // create buffer
    uint16_t iFragmentSize = FragmentSize(iFNr);
    StdBuf Packet; Packet.New(sizeof(DataPacketHdr) + iFragmentSize);
    // set up header
    DataPacketHdr *pnHdr = getMBufPtr<DataPacketHdr>(Packet);
    pnHdr->StatusByte = IPID_Data | (fBroadcastFlag ? 0x80 : 0x00);
    pnHdr->Nr = iNr + iFNr;
    pnHdr->FNr = iNr;
    pnHdr->Size = Data.getSize();
    // copy data
    Packet.Write(Data.getPart(iFNr * MaxDataSize, iFragmentSize),
                 sizeof(DataPacketHdr));
    // return
    return C4NetIOPacket(Packet, Data.getAddr());
}

References C4NetIOUDP::DataPacketHdr::FNr, C4NetIOUDP::IPID_Data, C4NetIOUDP::PacketHdr::Nr, C4NetIOUDP::Packet, C4NetIOUDP::DataPacketHdr::Size, and C4NetIOUDP::PacketHdr::StatusByte.

Referenced by C4NetIOUDP::BroadcastDirect(), and C4NetIOUDP::Peer::SendDirect().

Here is the caller graph for this function:

GetNr()

nr_t C4NetIOUDP::Packet::GetNr ( ) const

inline

Definition at line 691 of file C4NetIO.h.

{ return iNr; }

References iNr.

Referenced by C4NetIOUDP::PacketList::AddPacket(), C4NetIOUDP::BroadcastDirect(), C4NetIOUDP::Peer::CheckCompleteIPackets(), C4NetIOUDP::PacketList::FragmentPresent(), and C4NetIOUDP::Peer::SendDirect().

Here is the caller graph for this function:

Multicast()

bool C4NetIOUDP::Packet::Multicast ( ) const

inline

Definition at line 693 of file C4NetIO.h.

{ return !!(Data.getStatus() & 0x80); }

References Data, and C4NetIOPacket::getStatus().

Here is the call graph for this function:

Friends And Related Function Documentation

PacketList

friend class PacketList

friend

Definition at line 666 of file C4NetIO.h.

Member Data Documentation

Data

C4NetIOPacket C4NetIOUDP::Packet::Data

protected

Definition at line 684 of file C4NetIO.h.

Referenced by Empty(), GetData(), and Multicast().

iNr

nr_t C4NetIOUDP::Packet::iNr

protected

Definition at line 683 of file C4NetIO.h.

Referenced by GetNr().

MaxDataSize

const size_t C4NetIOUDP::Packet::MaxDataSize = MaxSize - sizeof(DataPacketHdr)

static

Definition at line 671 of file C4NetIO.h.

MaxSize

const size_t C4NetIOUDP::Packet::MaxSize = 512

static

Definition at line 670 of file C4NetIO.h.

Next

Packet* C4NetIOUDP::Packet::Next

protected

Definition at line 704 of file C4NetIO.h.

Referenced by C4NetIOUDP::PacketList::AddPacket(), and C4NetIOUDP::PacketList::DeletePacket().

pFragmentGot

bool* C4NetIOUDP::Packet::pFragmentGot {nullptr}

protected

Definition at line 685 of file C4NetIO.h.

Prev

Packet * C4NetIOUDP::Packet::Prev

protected

Definition at line 704 of file C4NetIO.h.

Referenced by C4NetIOUDP::PacketList::AddPacket(), C4NetIOUDP::PacketList::DeletePacket(), C4NetIOUDP::PacketList::GetPacket(), and C4NetIOUDP::PacketList::GetPacketFrgm().

---

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

• C4NetIO.h
• C4NetIO.cpp