inet::tcp::TcpLwipByteStreamReceiveQueue Class Reference

Receive queue that manages "data stream", that is, actual bytes. More...

#include <TcpLwipByteStreamQueues.h>

Inheritance diagram for inet::tcp::TcpLwipByteStreamReceiveQueue:

Public Member Functions
	TcpLwipByteStreamReceiveQueue ()
	Ctor. More...
virtual	~TcpLwipByteStreamReceiveQueue ()
	Virtual dtor. More...
virtual void	setConnection (TcpLwipConnection *connP) override
	Add a connection queue. More...
virtual void	notifyAboutIncomingSegmentProcessing (TCPSegment *tcpsegP, uint32 seqNo, const void *bufferP, size_t bufferLengthP) override
	Called when a TCP segment arrives, it should extract the payload from the segment and store it in the receive queue. More...
virtual void	enqueueTcpLayerData (void *dataP, unsigned int dataLengthP) override
	The method called when data received from LWIP The method should set status of the data in queue to received called after socket->read_data() successfull. More...
virtual unsigned long	getExtractableBytesUpTo () const
virtual cPacket *	extractBytesUpTo () override
	Should create a packet to be passed up to the app, up to (but NOT including) the given sequence no (usually rcv_nxt). More...
virtual uint32	getAmountOfBufferedBytes () const override
	Returns the number of bytes (out-of-order-segments) currently buffered in queue. More...
virtual uint32	getQueueLength () const override
	Returns the number of blocks currently buffered in queue. More...
virtual void	getQueueStatus () const override
	Shows current queue status. More...
virtual void	notifyAboutSending (const TCPSegment *tcpsegP) override
	notify the queue about output messages More...
Public Member Functions inherited from inet::tcp::TcpLwipReceiveQueue
	TcpLwipReceiveQueue ()
	Ctor. More...
virtual	~TcpLwipReceiveQueue ()
	Virtual dtor. More...

Protected Attributes
ByteArrayBuffer	byteArrayBufferM
	store bytes More...
Protected Attributes inherited from inet::tcp::TcpLwipReceiveQueue
TcpLwipConnection *	connM

Detailed Description

Receive queue that manages "data stream", that is, actual bytes.

Constructor & Destructor Documentation

inet::tcp::TcpLwipByteStreamReceiveQueue::TcpLwipByteStreamReceiveQueue

(

)

Ctor.

{
}

inet::tcp::TcpLwipByteStreamReceiveQueue::~TcpLwipByteStreamReceiveQueue ( )

virtual

Virtual dtor.

{
    // nothing to do here
}

Member Function Documentation

void inet::tcp::TcpLwipByteStreamReceiveQueue::enqueueTcpLayerData ( void *  dataP, unsigned int  dataLengthP  )

overridevirtual

The method called when data received from LWIP The method should set status of the data in queue to received called after socket->read_data() successfull.

Implements inet::tcp::TcpLwipReceiveQueue.

{
    byteArrayBufferM.push(dataP, dataLengthP);
}

cPacket * inet::tcp::TcpLwipByteStreamReceiveQueue::extractBytesUpTo ( )

overridevirtual

Should create a packet to be passed up to the app, up to (but NOT including) the given sequence no (usually rcv_nxt).

It should return nullptr if there's no more data to be passed up – this method is called several times until it returns nullptr.

called after socket->read_data() successfull

Implements inet::tcp::TcpLwipReceiveQueue.

{
    ASSERT(connM);

    RawPacket *dataMsg = nullptr;
    uint64 bytesInQueue = byteArrayBufferM.getLength();

    if (bytesInQueue) {
        dataMsg = new RawPacket("DATA");
        dataMsg->setKind(TCP_I_DATA);
        unsigned int extractBytes = bytesInQueue;
        char *data = new char[extractBytes];
        unsigned int extractedBytes = byteArrayBufferM.popBytesToBuffer(data, extractBytes);
        dataMsg->setByteLength(extractedBytes);
        dataMsg->getByteArray().assignBuffer(data, extractedBytes);
    }

    return dataMsg;
}

uint32 inet::tcp::TcpLwipByteStreamReceiveQueue::getAmountOfBufferedBytes ( ) const

overridevirtual

Returns the number of bytes (out-of-order-segments) currently buffered in queue.

Implements inet::tcp::TcpLwipReceiveQueue.

{
    return byteArrayBufferM.getLength();
}

unsigned long inet::tcp::TcpLwipByteStreamReceiveQueue::getExtractableBytesUpTo ( ) const

virtual

{
    return byteArrayBufferM.getLength();
}

uint32 inet::tcp::TcpLwipByteStreamReceiveQueue::getQueueLength ( ) const

overridevirtual

Returns the number of blocks currently buffered in queue.

Implements inet::tcp::TcpLwipReceiveQueue.

{
    return byteArrayBufferM.getLength();
}

void inet::tcp::TcpLwipByteStreamReceiveQueue::getQueueStatus ( ) const

overridevirtual

Shows current queue status.

Implements inet::tcp::TcpLwipReceiveQueue.

{
    // TODO
}

void inet::tcp::TcpLwipByteStreamReceiveQueue::notifyAboutIncomingSegmentProcessing ( TCPSegment *  tcpsegP, uint32  seqNo, const void *  bufferP, size_t  bufferLengthP  )

overridevirtual

Called when a TCP segment arrives, it should extract the payload from the segment and store it in the receive queue.

The segment object should not be deleted. //FIXME revise this comment

Implements inet::tcp::TcpLwipReceiveQueue.

{
    ASSERT(tcpsegP);
    ASSERT(bufferP);
}

void inet::tcp::TcpLwipByteStreamReceiveQueue::notifyAboutSending ( const TCPSegment *  tcpsegP )

overridevirtual

notify the queue about output messages

called when connM send out a packet. for read AckNo, if have

Implements inet::tcp::TcpLwipReceiveQueue.

{
    // nothing to do
}

void inet::tcp::TcpLwipByteStreamReceiveQueue::setConnection ( TcpLwipConnection *  connP )

overridevirtual

Add a connection queue.

Reimplemented from inet::tcp::TcpLwipReceiveQueue.

{
    ASSERT(connP);

    byteArrayBufferM.clear();
    TcpLwipReceiveQueue::setConnection(connP);
}

Member Data Documentation

ByteArrayBuffer inet::tcp::TcpLwipByteStreamReceiveQueue::byteArrayBufferM

protected

store bytes

---

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

• TcpLwipByteStreamQueues.h
• TcpLwipByteStreamQueues.cc