inet::tcp::TCPMsgBasedRcvQueue Class Reference

#include <TCPMsgBasedRcvQueue.h>

Inheritance diagram for inet::tcp::TCPMsgBasedRcvQueue:

Classes
struct	PayloadItem

Public Member Functions
	TCPMsgBasedRcvQueue ()
	Ctor. More...
virtual	~TCPMsgBasedRcvQueue ()
	Virtual dtor. More...
virtual void	init (uint32 startSeq) override
	Set initial receive sequence number. More...
virtual std::string	info () const override
	Returns a string with region stored. More...
virtual uint32	insertBytesFromSegment (TCPSegment *tcpseg) override
	Called when a TCP segment arrives. More...
virtual cPacket *	extractBytesUpTo (uint32 seq) override
	Method inherited from TCPReceiveQueue. More...
Public Member Functions inherited from inet::tcp::TCPVirtualDataRcvQueue
	TCPVirtualDataRcvQueue ()
	Ctor. More...
virtual	~TCPVirtualDataRcvQueue ()
	Virtual dtor. More...
virtual uint32	getAmountOfBufferedBytes () override
	Method inherited from TCPReceiveQueue. More...
virtual uint32	getAmountOfFreeBytes (uint32 maxRcvBuffer) override
	Method inherited from TCPReceiveQueue. More...
virtual uint32	getQueueLength () override
	Method inherited from TCPReceiveQueue. More...
virtual void	getQueueStatus () override
	Method inherited from TCPReceiveQueue. More...
virtual uint32	getLE (uint32 fromSeqNum) override
	Method inherited from TCPReceiveQueue. More...
virtual uint32	getRE (uint32 toSeqNum) override
	Method inherited from TCPReceiveQueue. More...
virtual uint32	getFirstSeqNo () override
	Returns the minimum of first byte seq.no. More...
Public Member Functions inherited from inet::tcp::TCPReceiveQueue
	TCPReceiveQueue ()
	Ctor. More...
virtual	~TCPReceiveQueue ()
	Virtual dtor. More...
virtual void	setConnection (TCPConnection *_conn)
	Set the connection that owns this queue. More...

Protected Types
typedef std::list< PayloadItem >	PayloadList
Protected Types inherited from inet::tcp::TCPVirtualDataRcvQueue
typedef std::list< Region * >	RegionList

Protected Attributes
PayloadList	payloadList
Protected Attributes inherited from inet::tcp::TCPVirtualDataRcvQueue
uint32	rcv_nxt = 0
RegionList	regionList
Protected Attributes inherited from inet::tcp::TCPReceiveQueue
TCPConnection *	conn

Additional Inherited Members
Protected Member Functions inherited from inet::tcp::TCPVirtualDataRcvQueue
void	merge (TCPVirtualDataRcvQueue::Region *region)
	Merge segment byte range into regionList, the parameter region must created by 'new' operator. More...
TCPVirtualDataRcvQueue::Region *	extractTo (uint32 toSeq)
virtual TCPVirtualDataRcvQueue::Region *	createRegionFromSegment (TCPSegment *tcpseg)
	Create a new Region from tcpseg. More...

Detailed Description

See also

TCPMsgBasedSendQueue

Member Typedef Documentation

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

protected

Constructor & Destructor Documentation

inet::tcp::TCPMsgBasedRcvQueue::TCPMsgBasedRcvQueue

(

)

Ctor.

                                         : TCPVirtualDataRcvQueue()
{
}

inet::tcp::TCPMsgBasedRcvQueue::~TCPMsgBasedRcvQueue ( )

virtual

Virtual dtor.

{
    while (!payloadList.empty()) {
        EV_DEBUG << "SendQueue Destructor: Drop msg from " << this->getFullPath()
                 << " Queue: offset=" << payloadList.front().seqNo
                 << ", length=" << payloadList.front().packet->getByteLength() << endl;
        delete payloadList.front().packet;
        payloadList.pop_front();
    }
}

Member Function Documentation

cPacket * inet::tcp::TCPMsgBasedRcvQueue::extractBytesUpTo ( uint32  seq )

overridevirtual

Method inherited from TCPReceiveQueue.

Reimplemented from inet::tcp::TCPVirtualDataRcvQueue.

{
    cPacket *msg = nullptr;
    if (!payloadList.empty() && seqLess(payloadList.begin()->seqNo, seq))
        seq = payloadList.begin()->seqNo;

    Region *reg = extractTo(seq);
    if (reg) {
        if (!payloadList.empty() && payloadList.begin()->seqNo == reg->getEnd()) {
            msg = payloadList.begin()->packet;
            payloadList.erase(payloadList.begin());
        }
        delete reg;
    }
    return msg;
}

std::string inet::tcp::TCPMsgBasedRcvQueue::info ( ) const

overridevirtual

Returns a string with region stored.

Reimplemented from inet::tcp::TCPVirtualDataRcvQueue.

{
    std::stringstream os;

    os << "rcv_nxt=" << rcv_nxt;

    for (const auto & elem : regionList) {
        os << " [" << (elem)->getBegin() << ".." << (elem)->getEnd() << ")";
    }

    os << " " << payloadList.size() << " msgs";

    return os.str();
}

void inet::tcp::TCPMsgBasedRcvQueue::init ( uint32  startSeq )

overridevirtual

Set initial receive sequence number.

Reimplemented from inet::tcp::TCPVirtualDataRcvQueue.

{
    TCPVirtualDataRcvQueue::init(startSeq);
}

uint32 inet::tcp::TCPMsgBasedRcvQueue::insertBytesFromSegment ( TCPSegment *  tcpseg )

overridevirtual

Called when a TCP segment arrives.

Returns sequence number for ACK.

Reimplemented from inet::tcp::TCPVirtualDataRcvQueue.

{
    TCPVirtualDataRcvQueue::insertBytesFromSegment(tcpseg);

    cPacket *msg;
    uint32 endSeqNo;
    auto i = payloadList.begin();
    while (nullptr != (msg = tcpseg->removeFirstPayloadMessage(endSeqNo))) {
        while (i != payloadList.end() && seqLess(i->seqNo, endSeqNo))
            ++i;

        // insert, avoiding duplicates
        if (i != payloadList.end() && i->seqNo == endSeqNo)
            delete msg;
        else {
            i = payloadList.insert(i, PayloadItem(endSeqNo, msg));
            ASSERT(seqLE(payloadList.front().seqNo, payloadList.back().seqNo));
        }
    }

    return rcv_nxt;
}

Member Data Documentation

PayloadList inet::tcp::TCPMsgBasedRcvQueue::payloadList

protected

Referenced by extractBytesUpTo(), info(), insertBytesFromSegment(), and ~TCPMsgBasedRcvQueue().

---

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

• TCPMsgBasedRcvQueue.h
• TCPMsgBasedRcvQueue.cc