TCPVirtualDataSendQueue Class Reference

#include <TCPVirtualDataSendQueue.h>

Inheritance diagram for TCPVirtualDataSendQueue:

TCPSendQueue

List of all members.


Detailed Description

Send queue that manages "virtual bytes", that is, byte counts only. It uses the length() field of the messages only, everything else is ignored.

See also:
TCPVirtualDataRcvQueue

Public Member Functions

 TCPVirtualDataSendQueue ()
virtual ~TCPVirtualDataSendQueue ()
virtual void init (uint32 startSeq)
virtual std::string info () const
virtual void enqueueAppData (cPacket *msg)
virtual uint32 getBufferEndSeq ()
virtual TCPSegmentcreateSegmentWithBytes (uint32 fromSeq, ulong numBytes)
virtual void discardUpTo (uint32 seqNum)

Protected Attributes

uint32 begin
uint32 end

Constructor & Destructor Documentation

TCPVirtualDataSendQueue::TCPVirtualDataSendQueue (  ) 

Ctor

00023                                                  : TCPSendQueue()
00024 {
00025     begin = end = 0;
00026 }

TCPVirtualDataSendQueue::~TCPVirtualDataSendQueue (  )  [virtual]

Virtual dtor.

00029 {
00030 }


Member Function Documentation

void TCPVirtualDataSendQueue::init ( uint32  startSeq  )  [virtual]

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 TCPSendQueue.

00033 {
00034     begin = startSeq;
00035     end = startSeq;
00036 }

std::string TCPVirtualDataSendQueue::info (  )  const [virtual]

Returns a string with the region stored.

00039 {
00040     std::stringstream out;
00041     out << "[" << begin << ".." << end << ")";
00042     return out.str();
00043 }

void TCPVirtualDataSendQueue::enqueueAppData ( cPacket *  msg  )  [virtual]

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 TCPSendQueue.

00046 {
00047     //tcpEV << "sendQ: " << info() << " enqueueAppData(bytes=" << msg->getByteLength() << ")\n";
00048     end += msg->getByteLength();
00049     delete msg;
00050 }

uint32 TCPVirtualDataSendQueue::getBufferEndSeq (  )  [virtual]

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 TCPSendQueue.

00053 {
00054     return end;
00055 }

TCPSegment * TCPVirtualDataSendQueue::createSegmentWithBytes ( uint32  fromSeq,
ulong  maxNumBytes 
) [virtual]

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 then maxNumBytes bytes if the subclass wants to reproduce the original segment boundaries when retransmitting.

Implements TCPSendQueue.

00058 {
00059     //tcpEV << "sendQ: " << info() << " createSeg(seq=" << fromSeq << " len=" << numBytes << ")\n";
00060     ASSERT(seqLE(begin,fromSeq) && seqLE(fromSeq+numBytes,end));
00061 
00062     char msgname[32];
00063     sprintf(msgname, "tcpseg(l=%lu)", numBytes);
00064 
00065     TCPSegment *tcpseg = conn->createTCPSegment(msgname);
00066     tcpseg->setSequenceNo(fromSeq);
00067     tcpseg->setPayloadLength(numBytes);
00068     return tcpseg;
00069 }

void TCPVirtualDataSendQueue::discardUpTo ( uint32  seqNum  )  [virtual]

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 TCPSendQueue.

00072 {
00073     //tcpEV << "sendQ: " << info() << " discardUpTo(seq=" << seqNum << ")\n";
00074     ASSERT(seqLE(begin,seqNum) && seqLE(seqNum,end));
00075     begin = seqNum;
00076 }


Member Data Documentation

uint32 TCPVirtualDataSendQueue::begin [protected]

uint32 TCPVirtualDataSendQueue::end [protected]


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

Generated on Fri Mar 20 18:51:22 2009 for INET Framework for OMNeT++/OMNEST by  doxygen 1.5.5