inet::tcp::TCPVirtualDataRcvQueue Class Reference

Receive queue that manages "virtual bytes", that is, byte counts only. More...

#include <TCPVirtualDataRcvQueue.h>

Inheritance diagram for inet::tcp::TCPVirtualDataRcvQueue:

Classes
class	Region

Public Member Functions
	TCPVirtualDataRcvQueue ()
	Ctor. More...
virtual	~TCPVirtualDataRcvQueue ()
	Virtual dtor. More...
virtual void	init (uint32 startSeq) override
	Method inherited from TCPReceiveQueue. More...
virtual std::string	info () const override
	Method inherited from TCPReceiveQueue. More...
virtual uint32	insertBytesFromSegment (TCPSegment *tcpseg) override
	Method inherited from TCPReceiveQueue. More...
virtual cPacket *	extractBytesUpTo (uint32 seq) override
	Method inherited from TCPReceiveQueue. 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< Region * >	RegionList

Protected Member Functions
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...

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

Detailed Description

Receive queue that manages "virtual bytes", that is, byte counts only.

See also

TCPVirtualDataSendQueue

Member Typedef Documentation

typedef std::list<Region *> inet::tcp::TCPVirtualDataRcvQueue::RegionList

protected

Constructor & Destructor Documentation

inet::tcp::TCPVirtualDataRcvQueue::TCPVirtualDataRcvQueue

(

)

Ctor.

                                               :
    TCPReceiveQueue(),
    rcv_nxt(-1)
{
}

inet::tcp::TCPVirtualDataRcvQueue::~TCPVirtualDataRcvQueue ( )

virtual

Virtual dtor.

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

Member Function Documentation

TCPVirtualDataRcvQueue::Region * inet::tcp::TCPVirtualDataRcvQueue::createRegionFromSegment ( TCPSegment *  tcpseg )

protectedvirtual

Create a new Region from tcpseg.

Called from insertBytesFromSegment()

Reimplemented in inet::tcp::TCPByteStreamRcvQueue.

Referenced by insertBytesFromSegment().

{
    Region *region = new Region(tcpseg->getSequenceNo(), tcpseg->getSequenceNo() + tcpseg->getPayloadLength());
    return region;
}

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

overridevirtual

Method inherited from TCPReceiveQueue.

Implements inet::tcp::TCPReceiveQueue.

Reimplemented in inet::tcp::TCPByteStreamRcvQueue, and inet::tcp::TCPMsgBasedRcvQueue.

{
    cPacket *msg = nullptr;
    Region *reg = extractTo(seq);

    if (reg) {
        msg = new cPacket("data");
        reg->copyTo(msg);
        delete reg;
    }
    return msg;
}

TCPVirtualDataRcvQueue::Region * inet::tcp::TCPVirtualDataRcvQueue::extractTo ( uint32  toSeq )

protected

Referenced by inet::tcp::TCPMsgBasedRcvQueue::extractBytesUpTo(), inet::tcp::TCPByteStreamRcvQueue::extractBytesUpTo(), and extractBytesUpTo().

{
    ASSERT(seqLE(seq, rcv_nxt));

    if (regionList.empty())
        return nullptr;

    Region *reg = regionList.front();
    uint32 beg = reg->getBegin();

    if (seqLE(seq, beg))
        return nullptr;

    if (seqGE(seq, reg->getEnd())) {
        regionList.pop_front();
        return reg;
    }

    return reg->split(seq);
}

uint32 inet::tcp::TCPVirtualDataRcvQueue::getAmountOfBufferedBytes ( )

overridevirtual

Method inherited from TCPReceiveQueue.

Implements inet::tcp::TCPReceiveQueue.

Referenced by getAmountOfFreeBytes().

{
    uint32 bytes = 0;

    for (auto & elem : regionList)
        bytes += (elem)->getLength();

    return bytes;
}

uint32 inet::tcp::TCPVirtualDataRcvQueue::getAmountOfFreeBytes ( uint32  maxRcvBuffer )

overridevirtual

Method inherited from TCPReceiveQueue.

Implements inet::tcp::TCPReceiveQueue.

{
    uint32 usedRcvBuffer = getAmountOfBufferedBytes();
    uint32 freeRcvBuffer = maxRcvBuffer - usedRcvBuffer;
    return (maxRcvBuffer > usedRcvBuffer) ? freeRcvBuffer : 0;
}

uint32 inet::tcp::TCPVirtualDataRcvQueue::getFirstSeqNo ( )

overridevirtual

Returns the minimum of first byte seq.no.

in queue and rcv_nxt

Implements inet::tcp::TCPReceiveQueue.

{
    if (regionList.empty())
        return rcv_nxt;
    return seqMin(regionList.front()->getBegin(), rcv_nxt);
}

uint32 inet::tcp::TCPVirtualDataRcvQueue::getLE ( uint32  fromSeqNum )

overridevirtual

Method inherited from TCPReceiveQueue.

Implements inet::tcp::TCPReceiveQueue.

{
    auto i = regionList.begin();

    while (i != regionList.end()) {
        if (seqLE((*i)->getBegin(), fromSeqNum) && seqLess(fromSeqNum, (*i)->getEnd())) {
//            tcpEV << "Enqueued region: [" << i->begin << ".." << i->end << ")\n";
            return (*i)->getBegin();
        }

        i++;
    }

    return fromSeqNum;
}

uint32 inet::tcp::TCPVirtualDataRcvQueue::getQueueLength ( )

overridevirtual

Method inherited from TCPReceiveQueue.

Implements inet::tcp::TCPReceiveQueue.

{
    return regionList.size();
}

void inet::tcp::TCPVirtualDataRcvQueue::getQueueStatus ( )

overridevirtual

Method inherited from TCPReceiveQueue.

Implements inet::tcp::TCPReceiveQueue.

{
    EV_DEBUG << "receiveQLength=" << regionList.size() << " " << info() << "\n";
}

uint32 inet::tcp::TCPVirtualDataRcvQueue::getRE ( uint32  toSeqNum )

overridevirtual

Method inherited from TCPReceiveQueue.

Implements inet::tcp::TCPReceiveQueue.

{
    auto i = regionList.begin();

    while (i != regionList.end()) {
        if (seqLess((*i)->getBegin(), toSeqNum) && seqLE(toSeqNum, (*i)->getEnd())) {
//            tcpEV << "Enqueued region: [" << i->begin << ".." << i->end << ")\n";
            return (*i)->getEnd();
        }

        i++;
    }

    return toSeqNum;
}

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

overridevirtual

Method inherited from TCPReceiveQueue.

Reimplemented in inet::tcp::TCPByteStreamRcvQueue, and inet::tcp::TCPMsgBasedRcvQueue.

Referenced by getQueueStatus(), and insertBytesFromSegment().

{
    std::string res;
    char buf[32];
    sprintf(buf, "rcv_nxt=%u", rcv_nxt);
    res = buf;

    for (const auto & elem : regionList) {
        sprintf(buf, " [%u..%u)", (elem)->getBegin(), (elem)->getEnd());
        res += buf;
    }
    return res;
}

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

overridevirtual

Method inherited from TCPReceiveQueue.

Implements inet::tcp::TCPReceiveQueue.

Reimplemented in inet::tcp::TCPMsgBasedRcvQueue.

Referenced by inet::tcp::TCPMsgBasedRcvQueue::init().

{
    rcv_nxt = startSeq;

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

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

overridevirtual

Method inherited from TCPReceiveQueue.

Implements inet::tcp::TCPReceiveQueue.

Reimplemented in inet::tcp::TCPMsgBasedRcvQueue.

Referenced by inet::tcp::TCPMsgBasedRcvQueue::insertBytesFromSegment().

{
    Region *region = createRegionFromSegment(tcpseg);

#ifndef NDEBUG
    if (!regionList.empty()) {
        uint32 ob = regionList.front()->getBegin();
        uint32 oe = regionList.back()->getEnd();
        uint32 nb = region->getBegin();
        uint32 ne = region->getEnd();
        uint32 minb = seqMin(ob, nb);
        uint32 maxe = seqMax(oe, ne);
        if (seqGE(minb, oe) || seqGE(minb, ne) || seqGE(ob, maxe) || seqGE(nb, maxe))
            throw cRuntimeError("The new segment is [%u, %u) out of the acceptable range at the queue %s",
                    region->getBegin(), region->getEnd(), info().c_str());
    }
#endif // ifndef NDEBUG

    merge(region);

    if (seqGE(rcv_nxt, regionList.front()->getBegin()))
        rcv_nxt = regionList.front()->getEnd();

    return rcv_nxt;
}

void inet::tcp::TCPVirtualDataRcvQueue::merge ( TCPVirtualDataRcvQueue::Region *  region )

protected

Merge segment byte range into regionList, the parameter region must created by 'new' operator.

Referenced by insertBytesFromSegment().

{
    // Here we have to update our existing regions with the octet range
    // tcpseg represents. We either have to insert tcpseg as a separate region
    // somewhere, or (if it overlaps with an existing region) extend
    // existing regions; we also may have to merge existing regions if
    // they become overlapping (or touching) after adding tcpseg.

    RegionList::reverse_iterator i = regionList.rbegin();
    Region::CompareStatus cmp;

    while (i != regionList.rend() && Region::BEFORE != (cmp = (*i)->compare(*seg))) {
        if (cmp != Region::AFTER) {
            if (seg->merge(*i)) {
                delete *i;
                i = (RegionList::reverse_iterator)(regionList.erase((++i).base()));
                continue;
            }
            else
                throw cRuntimeError("Model error: merge of region [%u,%u) with [%u,%u) unsuccessful", (*i)->getBegin(), (*i)->getEnd(), seg->getBegin(), seg->getEnd());
        }
        ++i;
    }

    regionList.insert(i.base(), seg);
}

Member Data Documentation

uint32 inet::tcp::TCPVirtualDataRcvQueue::rcv_nxt = 0

protected

Referenced by extractTo(), getFirstSeqNo(), inet::tcp::TCPMsgBasedRcvQueue::info(), inet::tcp::TCPByteStreamRcvQueue::info(), info(), init(), inet::tcp::TCPMsgBasedRcvQueue::insertBytesFromSegment(), and insertBytesFromSegment().

RegionList inet::tcp::TCPVirtualDataRcvQueue::regionList

protected

Referenced by extractTo(), getAmountOfBufferedBytes(), getFirstSeqNo(), getLE(), getQueueLength(), getQueueStatus(), getRE(), inet::tcp::TCPMsgBasedRcvQueue::info(), inet::tcp::TCPByteStreamRcvQueue::info(), info(), init(), insertBytesFromSegment(), merge(), and ~TCPVirtualDataRcvQueue().

---

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

• TCPVirtualDataRcvQueue.h
• TCPVirtualDataRcvQueue.cc