inet::ByteArray Class Reference

Class that carries raw bytes. More...

#include <ByteArray.h>

Inheritance diagram for inet::ByteArray:

Public Member Functions
	ByteArray ()
	Constructor. More...
	ByteArray (const ByteArray &other)
	Copy constructor. More...
ByteArray &	operator= (const ByteArray &other)
	operator = More...
virtual ByteArray *	dup () const override
	Creates and returns an exact copy of this object. More...
virtual void	setDataFromBuffer (const void *ptr, unsigned int length)
	Copy data from buffer. More...
virtual void	copyDataFromBuffer (unsigned int destOffset, const void *ptr, unsigned int length)
	Copy data from buffer. More...
virtual void	setDataFromByteArray (const ByteArray &other, unsigned int srcOffset, unsigned int length)
	Copy data from other ByteArray. More...
virtual void	copyDataFromByteArray (unsigned int destOffset, const ByteArray &other, unsigned int srcOffset, unsigned int length)
	Copy data from other ByteArray. 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, unsigned int srcOffs=0) const
	Copy data content to buffer. More...
virtual void	assignBuffer (void *ptr, unsigned int length)
	Set buffer pointer and buffer length. More...
virtual void	truncateData (unsigned int truncleft, unsigned int truncright)
	Truncate data content. More...
virtual void	expandData (unsigned int addLeft, unsigned int addRight)
	Expand data content. More...
virtual char *	getDataPtr ()
Public Member Functions inherited from inet::ByteArray_Base
virtual	~ByteArray_Base ()
virtual void	parsimPack (omnetpp::cCommBuffer *b) const override
virtual void	parsimUnpack (omnetpp::cCommBuffer *b) override
virtual void	setDataArraySize (unsigned int size)
virtual unsigned int	getDataArraySize () const
virtual char	getData (unsigned int k) const
virtual void	setData (unsigned int k, char data)

Additional Inherited Members
Protected Member Functions inherited from inet::ByteArray_Base
bool	operator== (const ByteArray_Base &)
	ByteArray_Base ()
	ByteArray_Base (const ByteArray_Base &other)
ByteArray_Base &	operator= (const ByteArray_Base &other)
Protected Attributes inherited from inet::ByteArray_Base
char *	data
unsigned int	data_arraysize

Detailed Description

Class that carries raw bytes.

Constructor & Destructor Documentation

inet::ByteArray::ByteArray ( )

inline

Constructor.

: ByteArray_Base() {}

inet::ByteArray::ByteArray ( const ByteArray &  other )

inline

Copy constructor.

: ByteArray_Base(other) {}

Member Function Documentation

void inet::ByteArray::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

Referenced by inet::RawPacket::addDataFromBuffer().

{
    if (0 == length)
        return;

    unsigned int nlength = data_arraysize + length;
    char *ndata = new char[nlength];
    if (data_arraysize)
        memcpy(ndata, data, data_arraysize);
    memcpy(ndata + data_arraysize, ptr, length);
    delete[] data;
    data = ndata;
    data_arraysize = nlength;
}

void inet::ByteArray::assignBuffer ( void *  ptr, unsigned int  length  )

virtual

Set buffer pointer and buffer length.

Parameters

ptr	pointer to new buffer, must created by buffer = new char[length1]; where length1>=length
length	length of buffer

Referenced by inet::TCPSessionApp::createDataPacket(), inet::tcp::TCPByteStreamSendQueue::createSegmentWithBytes(), inet::tcp::TCP_NSC_ByteStreamReceiveQueue::extractBytesUpTo(), inet::tcp::TcpLwipByteStreamReceiveQueue::extractBytesUpTo(), and inet::tcp::TCPByteStreamRcvQueue::Region::merge().

{
    delete[] data;
    data = (char *)ptr;
    data_arraysize = length;
}

void inet::ByteArray::copyDataFromBuffer ( unsigned int  destOffset, const void *  ptr, unsigned int  length  )

virtual

Copy data from buffer.

Parameters

destOffset	first byte from buffer will be written to here
ptr	pointer to buffer
length	length of data

Referenced by inet::IPv4FragBuf::addFragment(), and copyDataFromByteArray().

{
    unsigned int nlength = destOffset + length;
    if (data_arraysize < nlength) {
        char *ndata = new char[nlength];
        if (data_arraysize)
            memcpy(ndata, data, data_arraysize);
        delete[] data;
        data = ndata;
    }
    memcpy(data + destOffset, ptr, length);
}

void inet::ByteArray::copyDataFromByteArray ( unsigned int  destOffset, const ByteArray &  other, unsigned int  srcOffset, unsigned int  length  )

virtual

Copy data from other ByteArray.

Parameters

destOffset	first byte from other will be written to here
other	reference to other ByteArray
srcOffset	skipped first bytes from other
length	length of data from other

{
    ASSERT(srcOffset + length <= other.data_arraysize);
    copyDataFromBuffer(destOffset, other.data + srcOffset, length);
}

unsigned int inet::ByteArray::copyDataToBuffer ( void *  ptr, unsigned int  length, unsigned int  srcOffs = 0  ) const

virtual

Copy data content to buffer.

Parameters

ptr	pointer to output buffer
length	length of buffer, maximum of copied bytes
srcOffs	number of skipped bytes from source

Returns

: length of copied data

Referenced by inet::RawPacket::copyDataToBuffer(), and inet::tcp::TCPByteStreamRcvQueue::Region::merge().

{
    if (srcOffs >= data_arraysize)
        return 0;

    if (srcOffs + length > data_arraysize)
        length = data_arraysize - srcOffs;
    memcpy(ptr, data + srcOffs, length);
    return length;
}

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

inlineoverridevirtual

Creates and returns an exact copy of this object.

Reimplemented from inet::ByteArray_Base.

{ return new ByteArray(*this); }

void inet::ByteArray::expandData ( unsigned int  addLeft, unsigned int  addRight  )

virtual

Expand data content.

Parameters

addLeft	The number of bytes will be added at beginning of the content
addRight	The number of bytes will be added at end of the content added bytes are unfilled

Referenced by inet::IPv4FragBuf::addFragment().

{
    ASSERT(data_arraysize <= (data_arraysize + addleft + addright));

    if ((addleft || addright)) {
        unsigned int nlength = data_arraysize + (addleft + addright);
        char *ndata = new char[nlength];
        memmove(ndata + addleft, data, data_arraysize);
        delete[] data;
        data = ndata;
        data_arraysize = nlength;
    }
}

virtual char* inet::ByteArray::getDataPtr ( )

inlinevirtual

Referenced by inet::IPv4FragBuf::addFragment().

{ return data; }

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

inline

operator =

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

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

virtual

Copy data from buffer.

Parameters

ptr	pointer to buffer
length	length of data

Referenced by inet::serializer::TCPSerializer::deserialize(), inet::RawPacket::setDataFromBuffer(), and setDataFromByteArray().

{
    if (length != data_arraysize) {
        delete[] data;
        data = length ? new char[length] : nullptr;
        data_arraysize = length;
    }
    if (length)
        memcpy(data, ptr, length);
}

void inet::ByteArray::setDataFromByteArray ( const ByteArray &  other, unsigned int  srcOffset, unsigned int  length  )

virtual

Copy data from other ByteArray.

Parameters

other	reference to other ByteArray
srcOffset	skipped first bytes from other
length	length of data

Referenced by inet::tcp::TCPByteStreamRcvQueue::Region::split().

{
    ASSERT(srcOffs + length <= other.data_arraysize);
    setDataFromBuffer(other.data + srcOffs, length);
}

void inet::ByteArray::truncateData ( unsigned int  truncleft, unsigned int  truncright  )

virtual

Truncate data content.

Parameters

truncleft	The number of bytes from the beginning of the content be remove
truncright	The number of bytes from the end of the content be remove Generate assert when not have enough bytes for truncation

Referenced by inet::RawPacket::removePrefix(), and inet::tcp::TCPByteStreamRcvQueue::Region::split().

{
    ASSERT(data_arraysize >= (truncleft + truncright));

    if ((truncleft || truncright)) {
        unsigned int nlength = data_arraysize - (truncleft + truncright);
        char *ndata = nullptr;
        if (nlength) {
            ndata = new char[nlength];
            memcpy(ndata, data + truncleft, nlength);
        }
        delete[] data;
        data = ndata;
        data_arraysize = nlength;
    }
}

---

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

• ByteArray.h
• ByteArray.cc