Receive queue that manages "objects". More...

#include <TcpLwipMsgBasedQueues.h>

Inheritance diagram for inet::tcp::TcpLwipMsgBasedReceiveQueue:

Classes
struct	PayloadItem

Public Member Functions
	TcpLwipMsgBasedReceiveQueue ()
	Ctor. More...

virtual	~TcpLwipMsgBasedReceiveQueue ()
	Virtual dtor. More...

virtual void	setConnection (TcpLwipConnection *connP) override
	Set the connection. More...

virtual void	notifyAboutIncomingSegmentProcessing (TCPSegment tcpsegP, uint32 seqNo, const void bufferP, size_t bufferLengthP) override
	called back from lwip::tcp_input() 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() successful. More...

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 Types
typedef std::list< PayloadItem >	PayloadList

Protected Attributes
PayloadList	payloadListM

bool	isValidSeqNoM

uint32	lastExtractedSeqNoM

long int	bytesInQueueM

Protected Attributes inherited from inet::tcp::TcpLwipReceiveQueue
TcpLwipConnection *	connM

Detailed Description

Receive queue that manages "objects".

Member Typedef Documentation

typedef std::list<PayloadItem> inet::tcp::TcpLwipMsgBasedReceiveQueue::PayloadList

protected

Constructor & Destructor Documentation

inet::tcp::TcpLwipMsgBasedReceiveQueue::TcpLwipMsgBasedReceiveQueue ( )

Ctor.

     :
     bytesInQueueM(0)
 {
 }

inet::tcp::TcpLwipMsgBasedReceiveQueue::~TcpLwipMsgBasedReceiveQueue ( )

virtual

Virtual dtor.

 {
     while (!payloadListM.empty()) {
         delete payloadListM.front().packet;
         payloadListM.pop_front();
     }
 }

Member Function Documentation

void inet::tcp::TcpLwipMsgBasedReceiveQueue::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() successful.

Implements inet::tcp::TcpLwipReceiveQueue.

 {
     bytesInQueueM += dataLengthP;
 }

cPacket * inet::tcp::TcpLwipMsgBasedReceiveQueue::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() successful

Implements inet::tcp::TcpLwipReceiveQueue.

 {
     ASSERT(connM);
 
     cPacket *dataMsg = nullptr;
 
     if (!isValidSeqNoM) {
         isValidSeqNoM = true;
         lastExtractedSeqNoM = connM->pcbM->rcv_nxt - bytesInQueueM;
 
         if (connM->pcbM->state >= LwipTcpLayer::CLOSE_WAIT)
             lastExtractedSeqNoM--; // received FIN
     }
 
     uint32 firstSeqNo = lastExtractedSeqNoM;
     uint32 lastSeqNo = firstSeqNo + bytesInQueueM;
 
     // remove old messages
     while ((!payloadListM.empty()) && seqLE(payloadListM.front().seqNo, firstSeqNo)) {
         EV_DEBUG << "Remove old payload MSG: seqno=" << payloadListM.front().seqNo
                  << ", len=" << payloadListM.front().packet->getByteLength() << endl;
         delete payloadListM.front().packet;
         payloadListM.erase(payloadListM.begin());
     }
 
     // pass up payload messages, in sequence number order
     if (!payloadListM.empty()) {
         uint32 endSeqNo = payloadListM.front().seqNo;
 
         if (seqLE(endSeqNo, lastSeqNo)) {
             dataMsg = payloadListM.front().packet;
             uint32 dataLength = dataMsg->getByteLength();
 
             ASSERT(endSeqNo - dataLength == firstSeqNo);
 
             payloadListM.erase(payloadListM.begin());
             lastExtractedSeqNoM += dataLength;
             bytesInQueueM -= dataLength;
 
             dataMsg->setKind(TCP_I_DATA);
         }
     }
 
     return dataMsg;
 }

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

overridevirtual

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

Implements inet::tcp::TcpLwipReceiveQueue.

 {
     return bytesInQueueM;
 }

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

overridevirtual

Returns the number of blocks currently buffered in queue.

Implements inet::tcp::TcpLwipReceiveQueue.

 {
     return payloadListM.size();
 }

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

overridevirtual

Shows current queue status.

Implements inet::tcp::TcpLwipReceiveQueue.

 {
     // TODO
 }

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

overridevirtual

called back from lwip::tcp_input()

Implements inet::tcp::TcpLwipReceiveQueue.

 {
     ASSERT(tcpsegP);
     ASSERT(bufferP);
     ASSERT(seqLE(tcpsegP->getSequenceNo(), seqNoP));
     uint32 lastSeqNo = seqNoP + bufferLengthP;
     ASSERT(seqGE(tcpsegP->getSequenceNo() + tcpsegP->getPayloadLength(), lastSeqNo));
 
     cPacket *msg;
     uint32 endSeqNo;
 
     auto i = payloadListM.begin();
     while ((msg = tcpsegP->removeFirstPayloadMessage(endSeqNo)) != nullptr) {
         if (seqLess(seqNoP, endSeqNo) && seqLE(endSeqNo, lastSeqNo)
             && (!isValidSeqNoM || seqLess(lastExtractedSeqNoM, endSeqNo)))
         {
             while (i != payloadListM.end() && seqLess(i->seqNo, endSeqNo))
                 ++i;
 
             // insert, avoiding duplicates
             if (i != payloadListM.end() && i->seqNo == endSeqNo) {
                 ASSERT(msg->getByteLength() == i->packet->getByteLength());
                 delete msg;
             }
             else {
                 i = payloadListM.insert(i, PayloadItem(endSeqNo, msg));
                 ASSERT(seqLE(payloadListM.front().seqNo, payloadListM.back().seqNo));
             }
         }
         else {
             delete msg;
         }
     }
 }

void inet::tcp::TcpLwipMsgBasedReceiveQueue::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::TcpLwipMsgBasedReceiveQueue::setConnection ( TcpLwipConnection * connP )

overridevirtual

Set the connection.

Reimplemented from inet::tcp::TcpLwipReceiveQueue.

 {
     ASSERT(connP);
 
     bytesInQueueM = 0;
     TcpLwipReceiveQueue::setConnection(connP);
     isValidSeqNoM = false;
     lastExtractedSeqNoM = 0;
 
     while (!payloadListM.empty()) {
         delete payloadListM.front().packet;
         payloadListM.pop_front();
     }
 }