inet::tcp::TCPMsgBasedSendQueue Class Reference

Send queue that manages messages. More...

#include <TCPMsgBasedSendQueue.h>

Inheritance diagram for inet::tcp::TCPMsgBasedSendQueue:

Classes
struct	Payload

Public Member Functions
	TCPMsgBasedSendQueue ()
	Ctor. More...
virtual	~TCPMsgBasedSendQueue ()
	Virtual dtor. More...
virtual void	init (uint32 startSeq) override
	Initialize the object. More...
virtual std::string	info () const override
	Returns a string with the region stored. More...
virtual void	enqueueAppData (cPacket *msg) override
	Called on SEND app command, it inserts in the queue the data the user wants to send. More...
virtual uint32	getBufferStartSeq () override
	Returns the sequence number of the first byte stored in the buffer. More...
virtual uint32	getBufferEndSeq () override
	Returns the sequence number of the last byte stored in the buffer plus one. More...
virtual TCPSegment *	createSegmentWithBytes (uint32 fromSeq, ulong numBytes) override
	Called when the TCP wants to send or retransmit data, it constructs a TCP segment which contains the data from the requested sequence number range. More...
virtual void	discardUpTo (uint32 seqNum) override
	Tells the queue that bytes up to (but NOT including) seqNum have been transmitted and ACKed, so they can be removed from the queue. More...
Public Member Functions inherited from inet::tcp::TCPSendQueue
	TCPSendQueue ()
	Ctor. More...
virtual	~TCPSendQueue ()
	Virtual dtor. More...
virtual void	setConnection (TCPConnection *_conn)
	Set the connection that owns this queue. More...
ulong	getBytesAvailable (uint32 fromSeq)
	Utility function: returns how many bytes are available in the queue, from (and including) the given sequence number. More...

Protected Types
typedef std::list< Payload >	PayloadQueue

Protected Attributes
PayloadQueue	payloadQueue
uint32	begin
uint32	end
Protected Attributes inherited from inet::tcp::TCPSendQueue
TCPConnection *	conn

Detailed Description

Send queue that manages messages.

See also

TCPMsgBasedRcvQueue

Member Typedef Documentation

typedef std::list<Payload> inet::tcp::TCPMsgBasedSendQueue::PayloadQueue

protected

Constructor & Destructor Documentation

inet::tcp::TCPMsgBasedSendQueue::TCPMsgBasedSendQueue

(

)

Ctor.

                                           : TCPSendQueue()
{
    begin = end = 0;
}

inet::tcp::TCPMsgBasedSendQueue::~TCPMsgBasedSendQueue ( )

virtual

Virtual dtor.

{
    for (auto & elem : payloadQueue)
        delete elem.msg;
}

Member Function Documentation

TCPSegment * inet::tcp::TCPMsgBasedSendQueue::createSegmentWithBytes ( uint32  fromSeq, ulong  maxNumBytes  )

overridevirtual

Called when the TCP wants to send or retransmit data, it constructs a TCP segment which contains the data from the requested sequence number range.

The actually returned segment may contain less than maxNumBytes bytes if the subclass wants to reproduce the original segment boundaries when retransmitting.

Implements inet::tcp::TCPSendQueue.

{
    //tcpEV << "sendQ: " << info() << " createSeg(seq=" << fromSeq << " len=" << numBytes << ")\n";
    ASSERT(seqLE(begin, fromSeq) && seqLE(fromSeq + numBytes, end));

    TCPSegment *tcpseg = new TCPSegment(nullptr);

    tcpseg->setSequenceNo(fromSeq);
    tcpseg->setPayloadLength(numBytes);

    // add payload messages whose endSequenceNo is between fromSeq and fromSeq + numBytes
    auto i = payloadQueue.begin();

    while (i != payloadQueue.end() && seqLE(i->endSequenceNo, fromSeq))
        ++i;

    uint32 toSeq = fromSeq + numBytes;
    const char *payloadName = nullptr;

    while (i != payloadQueue.end() && seqLE(i->endSequenceNo, toSeq)) {
        if (!payloadName)
            payloadName = i->msg->getName();

        tcpseg->addPayloadMessage(i->msg->dup(), i->endSequenceNo);
        ++i;
    }

    // give segment a name
    char msgname[80];
    if (!payloadName)
        sprintf(msgname, "tcpseg(l=%lu,%dmsg)", numBytes, tcpseg->getPayloadArraySize());
    else
        sprintf(msgname, "%.10s(l=%lu,%dmsg)", payloadName, numBytes, tcpseg->getPayloadArraySize());
    tcpseg->setName(msgname);

    return tcpseg;
}

void inet::tcp::TCPMsgBasedSendQueue::discardUpTo ( uint32  seqNum )

overridevirtual

Tells the queue that bytes up to (but NOT including) seqNum have been transmitted and ACKed, so they can be removed from the queue.

Implements inet::tcp::TCPSendQueue.

{
    //tcpEV << "sendQ: " << info() << " discardUpTo(seq=" << seqNum << ")\n";

    ASSERT(seqLE(begin, seqNum) && seqLE(seqNum, end));

    begin = seqNum;

    // remove payload messages whose endSequenceNo is below seqNum
    while (!payloadQueue.empty() && seqLE(payloadQueue.front().endSequenceNo, seqNum)) {
        delete payloadQueue.front().msg;
        payloadQueue.pop_front();
    }
}

void inet::tcp::TCPMsgBasedSendQueue::enqueueAppData ( cPacket *  msg )

overridevirtual

Called on SEND app command, it inserts in the queue the data the user wants to send.

Implementations of this abstract class will decide what this means: copying actual bytes, just increasing the "last byte queued" variable, or storing cMessage object(s). The msg object should not be referenced after this point (sendQueue may delete it.)

Implements inet::tcp::TCPSendQueue.

{
    //tcpEV << "sendQ: " << info() << " enqueueAppData(bytes=" << msg->getByteLength() << ")\n";
    end += msg->getByteLength();
    if (seqLess(end, begin))
        throw cRuntimeError("Send queue is full");

    Payload payload;
    payload.endSequenceNo = end;
    payload.msg = msg;
    payloadQueue.push_back(payload);
}

uint32 inet::tcp::TCPMsgBasedSendQueue::getBufferEndSeq ( )

overridevirtual

Returns the sequence number of the last byte stored in the buffer plus one.

(The first byte of the next send operation would get this sequence number.)

Implements inet::tcp::TCPSendQueue.

{
    return end;
}

uint32 inet::tcp::TCPMsgBasedSendQueue::getBufferStartSeq ( )

overridevirtual

Returns the sequence number of the first byte stored in the buffer.

Implements inet::tcp::TCPSendQueue.

{
    return begin;
}

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

overridevirtual

Returns a string with the region stored.

{
    std::stringstream out;
    out << "[" << begin << ".." << end << "), " << payloadQueue.size() << " packets";
    return out.str();
}

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

overridevirtual

Initialize the object.

The startSeq parameter tells what sequence number the first byte of app data should get. This is usually ISS + 1 because SYN consumes one byte in the sequence number space.

init() may be called more than once; every call flushes the existing contents of the queue.

Implements inet::tcp::TCPSendQueue.

{
    begin = startSeq;
    end = startSeq;
}

Member Data Documentation

uint32 inet::tcp::TCPMsgBasedSendQueue::begin

protected

Referenced by createSegmentWithBytes(), discardUpTo(), enqueueAppData(), getBufferStartSeq(), info(), init(), and TCPMsgBasedSendQueue().

uint32 inet::tcp::TCPMsgBasedSendQueue::end

protected

Referenced by createSegmentWithBytes(), discardUpTo(), enqueueAppData(), getBufferEndSeq(), info(), init(), and TCPMsgBasedSendQueue().

PayloadQueue inet::tcp::TCPMsgBasedSendQueue::payloadQueue

protected

Referenced by createSegmentWithBytes(), discardUpTo(), enqueueAppData(), info(), and ~TCPMsgBasedSendQueue().

---

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

• TCPMsgBasedSendQueue.h
• TCPMsgBasedSendQueue.cc