inet::RawPacket Class Reference

Message that carries raw bytes. More...

#include <RawPacket.h>

Inheritance diagram for inet::RawPacket:

Public Member Functions
	RawPacket (const char *name=nullptr, int kind=0)
	Constructor. More...
	RawPacket (const RawPacket &other)
	Copy constructor. More...
RawPacket &	operator= (const RawPacket &other)
	operator = More...
virtual RawPacket *	dup () const override
	Creates and returns an exact copy of this object. More...
virtual void	setDataFromBuffer (const void *ptr, unsigned int length)
	Set data from buffer. More...
virtual void	addDataFromBuffer (const void *ptr, unsigned int length)
	Add data from buffer to the end of existing content. More...
virtual unsigned int	copyDataToBuffer (void *ptr, unsigned int length) const
	Copy data content to buffer. More...
virtual void	removePrefix (unsigned int length)
	Truncate data content. More...
Public Member Functions inherited from inet::RawPacket_Base
virtual	~RawPacket_Base ()
virtual void	parsimPack (omnetpp::cCommBuffer *b) const override
virtual void	parsimUnpack (omnetpp::cCommBuffer *b) override
virtual ByteArray &	getByteArray ()
virtual const ByteArray &	getByteArray () const
virtual void	setByteArray (const ByteArray &byteArray)

Additional Inherited Members
Protected Member Functions inherited from inet::RawPacket_Base
bool	operator== (const RawPacket_Base &)
	RawPacket_Base (const char *name=nullptr, short kind=0)
	RawPacket_Base (const RawPacket_Base &other)
RawPacket_Base &	operator= (const RawPacket_Base &other)
Protected Attributes inherited from inet::RawPacket_Base
ByteArray	byteArray

Detailed Description

Message that carries raw bytes.

Used with emulation-related features.

Constructor & Destructor Documentation

inet::RawPacket::RawPacket ( const char *  name = nullptr, int  kind = 0  )

inline

Constructor.

: RawPacket_Base(name, kind) {}

inet::RawPacket::RawPacket ( const RawPacket &  other )

inline

Copy constructor.

: RawPacket_Base(other) {}

Member Function Documentation

void inet::RawPacket::addDataFromBuffer ( const void *  ptr, unsigned int  length  )

virtual

Add data from buffer to the end of existing content.

Parameters

ptr	pointer to input buffer
length	length of data

{
    byteArray.addDataFromBuffer(ptr, length);
}

unsigned int inet::RawPacket::copyDataToBuffer ( void *  ptr, unsigned int  length  ) const

virtual

Copy data content to buffer.

Parameters

ptr	pointer to output buffer
length	length of buffer, maximum of copied bytes

Returns

: length of copied data

Referenced by inet::serializer::ByteArraySerializer::serialize().

{
    return byteArray.copyDataToBuffer(ptr, length);
}

virtual RawPacket* inet::RawPacket::dup ( ) const

inlineoverridevirtual

Creates and returns an exact copy of this object.

Reimplemented from inet::RawPacket_Base.

{ return new RawPacket(*this); }

RawPacket& inet::RawPacket::operator= ( const RawPacket &  other )

inline

operator =

{ RawPacket_Base::operator=(other); return *this; }

void inet::RawPacket::removePrefix ( unsigned int  length )

virtual

Truncate data content.

Parameters

length

The number of bytes from the beginning of the content be removed Generate assert when not have enough bytes for truncation

{
    byteArray.truncateData(length, 0);
}

void inet::RawPacket::setDataFromBuffer ( const void *  ptr, unsigned int  length  )

virtual

Set data from buffer.

Parameters

ptr	pointer to buffer
length	length of data

Referenced by inet::serializer::ByteArraySerializer::deserialize().

{
    byteArray.setDataFromBuffer(ptr, (unsigned int)length);
}

---

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

• RawPacket.h
• RawPacket.cc