inet::ByteArrayBuffer Class Reference

Buffer that carries BytesArrays. More...

#include <ByteArrayBuffer.h>

Inheritance diagram for inet::ByteArrayBuffer:

Public Member Functions
	ByteArrayBuffer ()
	Ctor. More...
	ByteArrayBuffer (const ByteArrayBuffer &other)
	Copy ctor. More...
ByteArrayBuffer &	operator= (const ByteArrayBuffer &other)
virtual ByteArrayBuffer *	dup () const override
virtual void	clear ()
	Clear buffer. More...
virtual void	push (const ByteArray &byteArrayP)
	Push data to end of buffer. More...
virtual void	push (const void *bufferP, unsigned int bufferLengthP)
	Push data to end of buffer. More...
virtual uint64	getLength () const
	Returns length of stored data. More...
virtual unsigned int	getBytesToBuffer (void *bufferP, unsigned int bufferLengthP, unsigned int srcOffsP=0) const
	Copy bytes to an external buffer. More...
virtual unsigned int	popBytesToBuffer (void *bufferP, unsigned int bufferLengthP)
	Move bytes to an external buffer. More...
virtual unsigned int	drop (unsigned int lengthP)
	Drop bytes from buffer. More...

Protected Types
typedef std::list< ByteArray >	DataList

Protected Attributes
uint64	dataLengthM
DataList	dataListM

Private Member Functions
void	copy (const ByteArrayBuffer &other)

Detailed Description

Buffer that carries BytesArrays.

Member Typedef Documentation

typedef std::list<ByteArray> inet::ByteArrayBuffer::DataList

protected

Constructor & Destructor Documentation

inet::ByteArrayBuffer::ByteArrayBuffer

(

)

Ctor.

    :
    dataLengthM(0)
{
}

inet::ByteArrayBuffer::ByteArrayBuffer

(

const ByteArrayBuffer &

other

)

Copy ctor.

    : cObject(other)
{
    copy(other);
}

Member Function Documentation

void inet::ByteArrayBuffer::clear ( )

virtual

Clear buffer.

Referenced by inet::tcp::TCPByteStreamSendQueue::init(), inet::tcp::TcpLwipByteStreamSendQueue::setConnection(), inet::tcp::TCP_NSC_ByteStreamSendQueue::setConnection(), inet::tcp::TCP_NSC_ByteStreamReceiveQueue::setConnection(), and inet::tcp::TcpLwipByteStreamReceiveQueue::setConnection().

{
    dataLengthM = 0;

    while (dataListM.begin() != dataListM.end()) {
        dataListM.pop_front();
    }
}

void inet::ByteArrayBuffer::copy ( const ByteArrayBuffer &  other )

inlineprivate

Referenced by ByteArrayBuffer(), and operator=().

{ dataLengthM = other.dataLengthM; dataListM = other.dataListM; }

unsigned int inet::ByteArrayBuffer::drop ( unsigned int  lengthP )

virtual

Drop bytes from buffer.

Parameters

lengthP

count of droppable bytes

Returns

count of dropped bytes

Referenced by inet::tcp::TCP_NSC_ByteStreamSendQueue::dequeueTcpLayerMsg(), inet::tcp::TcpLwipByteStreamSendQueue::dequeueTcpLayerMsg(), inet::tcp::TCPByteStreamSendQueue::discardUpTo(), and popBytesToBuffer().

{
    ASSERT(lengthP <= dataLengthM);

    unsigned int length = lengthP;

    while (length > 0) {
        unsigned int sliceLength = dataListM.front().getDataArraySize();

        if (sliceLength <= length) {
            dataListM.pop_front();
            dataLengthM -= sliceLength;
            length -= sliceLength;
        }
        else {
            dataListM.front().truncateData(length, 0);
            dataLengthM -= length;
            length = 0;
        }
    }
    ASSERT(0 == length);
    return lengthP;
}

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

inlineoverridevirtual

{ return new ByteArrayBuffer(*this); }

unsigned int inet::ByteArrayBuffer::getBytesToBuffer ( void *  bufferP, unsigned int  bufferLengthP, unsigned int  srcOffsP = 0  ) const

virtual

Copy bytes to an external buffer.

Parameters

bufferP	pointer to output buffer
bufferLengthP	length of output buffer
srcOffsP	source offset

Returns

count of copied bytes

Referenced by inet::tcp::TCPByteStreamSendQueue::createSegmentWithBytes(), inet::tcp::TcpLwipByteStreamSendQueue::getBytesForTcpLayer(), inet::tcp::TCP_NSC_ByteStreamSendQueue::getBytesForTcpLayer(), and popBytesToBuffer().

{
    unsigned int copiedBytes = 0;
    DataList::const_iterator i;

    for (i = this->dataListM.begin(); (copiedBytes < bufferLengthP) && (i != dataListM.end()); ++i) {
        unsigned int cbytes = i->copyDataToBuffer((char *)bufferP + copiedBytes,
                    bufferLengthP - copiedBytes, srcOffsP);
        if (cbytes) {
            copiedBytes += cbytes;
            srcOffsP = 0;
        }
        else {
            srcOffsP -= i->getDataArraySize();
        }
    }
    return copiedBytes;
}

virtual uint64 inet::ByteArrayBuffer::getLength ( ) const

inlinevirtual

Returns length of stored data.

Referenced by inet::tcp::TCP_NSC_ByteStreamReceiveQueue::extractBytesUpTo(), inet::tcp::TcpLwipByteStreamReceiveQueue::extractBytesUpTo(), inet::tcp::TCP_NSC_ByteStreamReceiveQueue::getAmountOfBufferedBytes(), inet::tcp::TcpLwipByteStreamReceiveQueue::getAmountOfBufferedBytes(), inet::tcp::TCP_NSC_ByteStreamSendQueue::getBytesAvailable(), inet::tcp::TcpLwipByteStreamSendQueue::getBytesAvailable(), inet::tcp::TcpLwipByteStreamReceiveQueue::getExtractableBytesUpTo(), inet::tcp::TCP_NSC_ByteStreamReceiveQueue::getQueueLength(), inet::tcp::TcpLwipByteStreamReceiveQueue::getQueueLength(), and inet::tcp::TCPByteStreamSendQueue::info().

{ return dataLengthM; }

ByteArrayBuffer & inet::ByteArrayBuffer::operator=

(

const ByteArrayBuffer &

other

)

{
    if (this == &other)
        return *this;
    cObject::operator=(other);
    copy(other);
    return *this;
}

unsigned int inet::ByteArrayBuffer::popBytesToBuffer ( void *  bufferP, unsigned int  bufferLengthP  )

virtual

Move bytes to an external buffer.

Parameters

bufferP	pointer to output buffer
bufferLengthP	length of output buffer

Returns

count of moved bytes

Referenced by inet::tcp::TCP_NSC_ByteStreamReceiveQueue::extractBytesUpTo(), and inet::tcp::TcpLwipByteStreamReceiveQueue::extractBytesUpTo().

{
    return drop(getBytesToBuffer(bufferP, bufferLengthP));
}

void inet::ByteArrayBuffer::push ( const ByteArray &  byteArrayP )

virtual

Push data to end of buffer.

Referenced by inet::tcp::TCP_NSC_ByteStreamSendQueue::enqueueAppData(), inet::tcp::TcpLwipByteStreamSendQueue::enqueueAppData(), inet::tcp::TCPByteStreamSendQueue::enqueueAppData(), inet::tcp::TCP_NSC_ByteStreamReceiveQueue::enqueueNscData(), and inet::tcp::TcpLwipByteStreamReceiveQueue::enqueueTcpLayerData().

{
    dataListM.push_back(byteArrayP);
    dataLengthM += byteArrayP.getDataArraySize();
}

void inet::ByteArrayBuffer::push ( const void *  bufferP, unsigned int  bufferLengthP  )

virtual

Push data to end of buffer.

{
    ByteArray byteArray;
    dataListM.push_back(byteArray);
    dataListM.back().setDataFromBuffer(bufferP, bufferLengthP);
    dataLengthM += bufferLengthP;
}

Member Data Documentation

uint64 inet::ByteArrayBuffer::dataLengthM

protected

Referenced by clear(), copy(), drop(), and push().

DataList inet::ByteArrayBuffer::dataListM

protected

Referenced by clear(), copy(), drop(), getBytesToBuffer(), and push().

---

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

• ByteArrayBuffer.h
• ByteArrayBuffer.cc