Represents a TCP segment. More...

#include <TCPSegment.h>

Inheritance diagram for inet::tcp::TCPSegment:

Public Member Functions
	TCPSegment (const char *name=nullptr, int kind=0)

	TCPSegment (const TCPSegment &other)

	~TCPSegment ()

TCPSegment &	operator= (const TCPSegment &other)

virtual TCPSegment *	dup () const override

virtual void	parsimPack (cCommBuffer *b) const override

virtual void	parsimUnpack (cCommBuffer *b) override

virtual void	setPayloadArraySize (unsigned int size) override
	Generated but unused method, should not be called. More...

virtual void	setPayload (unsigned int k, const TCPPayloadMessage &payload_var) override
	Generated but unused method, should not be called. More...

virtual unsigned int	getPayloadArraySize () const override
	Returns the number of payload messages in this TCP segment. More...

virtual TCPPayloadMessage &	getPayload (unsigned int k) override
	Returns the kth payload message in this TCP segment. More...

virtual void	addPayloadMessage (cPacket *msg, uint32 endSequenceNo)
	Adds a message object to the TCP segment. More...

virtual cPacket *	removeFirstPayloadMessage (uint32 &outEndSequenceNo)
	Removes and returns the first message object in this TCP segment. More...

virtual uint32_t	getSegLen ()
	Returns RFC 793 specified SEG.LEN: SEG.LEN = the number of octets occupied by the data in the segment (counting SYN and FIN) More...

virtual void	truncateSegment (uint32 firstSeqNo, uint32 endSeqNo)
	Truncate segment. More...

virtual unsigned short	getHeaderOptionArrayLength ()
	Calculate Length of TCP Options Array in bytes. More...

virtual void	setHeaderOptionArraySize (unsigned int size) override
	Generated but unused method, should not be called. More...

virtual unsigned int	getHeaderOptionArraySize () const override
	Returns the number of TCP options in this TCP segment. More...

virtual TCPOptionPtr &	getHeaderOption (unsigned int k) override
	Returns the kth TCP options in this TCP segment. More...

virtual const TCPOptionPtr &	getHeaderOption (unsigned int k) const override

virtual void	setHeaderOption (unsigned int k, const TCPOptionPtr &headerOption) override
	Generated but unused method, should not be called. More...

virtual void	addHeaderOption (TCPOption *headerOption)
	Adds a TCP option to the TCP segment. More...

virtual void	dropHeaderOptions ()
	Drops all TCP options of the TCP segment. More...

virtual unsigned int	getSourcePort () const override

virtual void	setSourcePort (unsigned int port) override

virtual unsigned int	getDestinationPort () const override

virtual void	setDestinationPort (unsigned int port) override

Public Member Functions inherited from inet::tcp::TCPSegment_Base
virtual	~TCPSegment_Base ()

virtual void	parsimPack (omnetpp::cCommBuffer *b) const override

virtual void	parsimUnpack (omnetpp::cCommBuffer *b) override

virtual unsigned short	getSrcPort () const

virtual void	setSrcPort (unsigned short srcPort)

virtual unsigned short	getDestPort () const

virtual void	setDestPort (unsigned short destPort)

virtual unsigned int	getSequenceNo () const

virtual void	setSequenceNo (unsigned int sequenceNo)

virtual unsigned int	getAckNo () const

virtual void	setAckNo (unsigned int ackNo)

virtual unsigned short	getHeaderLength () const

virtual void	setHeaderLength (unsigned short headerLength)

virtual bool	getUrgBit () const

virtual void	setUrgBit (bool urgBit)

virtual bool	getAckBit () const

virtual void	setAckBit (bool ackBit)

virtual bool	getPshBit () const

virtual void	setPshBit (bool pshBit)

virtual bool	getRstBit () const

virtual void	setRstBit (bool rstBit)

virtual bool	getSynBit () const

virtual void	setSynBit (bool synBit)

virtual bool	getFinBit () const

virtual void	setFinBit (bool finBit)

virtual unsigned short	getWindow () const

virtual void	setWindow (unsigned short window)

virtual unsigned short	getUrgentPointer () const

virtual void	setUrgentPointer (unsigned short urgentPointer)

virtual unsigned long	getPayloadLength () const

virtual void	setPayloadLength (unsigned long payloadLength)

virtual const TCPPayloadMessage &	getPayload (unsigned int k) const

virtual ByteArray &	getByteArray ()

virtual const ByteArray &	getByteArray () const

virtual void	setByteArray (const ByteArray &byteArray)

Public Member Functions inherited from inet::ITransportPacket
virtual	~ITransportPacket ()

Protected Types
typedef std::list< TCPPayloadMessage >	PayloadList

typedef std::vector< TCPOption * >	OptionList

Protected Member Functions
virtual void	truncateData (unsigned int truncleft, unsigned int truncright)
	Truncate segment data. More...

Protected Member Functions inherited from inet::tcp::TCPSegment_Base
bool	operator== (const TCPSegment_Base &)

	TCPSegment_Base (const char *name=nullptr, short kind=0)

	TCPSegment_Base (const TCPSegment_Base &other)

TCPSegment_Base &	operator= (const TCPSegment_Base &other)

Protected Attributes
PayloadList	payloadList

OptionList	headerOptionList

Protected Attributes inherited from inet::tcp::TCPSegment_Base
unsigned short	srcPort

unsigned short	destPort

unsigned int	sequenceNo

unsigned int	ackNo

unsigned short	headerLength

bool	urgBit

bool	ackBit

bool	pshBit

bool	rstBit

bool	synBit

bool	finBit

unsigned short	window

unsigned short	urgentPointer

unsigned long	payloadLength

ByteArray	byteArray

Private Member Functions
void	copy (const TCPSegment &other)

void	clean ()

Detailed Description

Represents a TCP segment.

More info in the TCPSegment.msg file (and the documentation generated from it).

Member Typedef Documentation

typedef std::vector<TCPOption *> inet::tcp::TCPSegment::OptionList

protected

typedef std::list<TCPPayloadMessage> inet::tcp::TCPSegment::PayloadList

protected

Constructor & Destructor Documentation

inet::tcp::TCPSegment::TCPSegment	(	const char *	name = `nullptr`,
		int	kind = `0`
	)

inline

73 : TCPSegment_Base(name, kind) {}

inet::tcp::TCPSegment_Base::TCPSegment_Base

TCPSegment_Base(const char *name=nullptr, short kind=0)

inet::tcp::TCPSegment::TCPSegment ( const TCPSegment & other )

inline

74 : TCPSegment_Base(other) { copy(other); }

inet::tcp::TCPSegment::copy

void copy(const TCPSegment &other)

Definition: TCPSegment.cc:108

inet::tcp::TCPSegment_Base::TCPSegment_Base

TCPSegment_Base(const char *name=nullptr, short kind=0)

inet::tcp::TCPSegment::~TCPSegment ( )

 {
     clean();
 }

Member Function Documentation

void inet::tcp::TCPSegment::addHeaderOption ( TCPOption * headerOption )

virtual

Adds a TCP option to the TCP segment.

Referenced by inet::tcp::TCPConnection::addSacks(), PacketDrill::buildTCPPacket(), inet::serializer::TCPSerializer::deserialize(), inet::tcp::TCPConnection::sendSegment(), and inet::tcp::TCPConnection::writeHeaderOptions().

 {
     headerOptionList.push_back(option);
 }

void inet::tcp::TCPSegment::addPayloadMessage	(	cPacket *	msg,
		uint32	endSequenceNo
	)

virtual

Adds a message object to the TCP segment.

The sequence number + 1 of the last byte of the message should be passed as 2nd argument

Referenced by inet::tcp::TCPMsgBasedSendQueue::createSegmentWithBytes(), and inet::tcp::TcpLwipMsgBasedSendQueue::createSegmentWithBytes().

 {
     take(msg);
 
     TCPPayloadMessage payload;
     payload.endSequenceNo = endSequenceNo;
     payload.msg = msg;
     payloadList.push_back(payload);
 }

void inet::tcp::TCPSegment::clean ( )

private

 {
     dropHeaderOptions();
 
     while (!payloadList.empty()) {
         cPacket *msg = payloadList.front().msg;
         payloadList.pop_front();
         dropAndDelete(msg);
     }
 }

void inet::tcp::TCPSegment::copy ( const TCPSegment & other )

private

 {
     for (const auto & elem : other.payloadList)
         addPayloadMessage(elem.msg->dup(), elem.endSequenceNo);
     for (const auto opt: other.headerOptionList)
         addHeaderOption(opt->dup());
 }

void inet::tcp::TCPSegment::dropHeaderOptions ( )

virtual

Drops all TCP options of the TCP segment.

Referenced by inet::tcp::TCPConnection::writeHeaderOptions().

 {
     for (auto opt : headerOptionList)
         delete opt;
     headerOptionList.clear();
 }

virtual TCPSegment* inet::tcp::TCPSegment::dup ( ) const

inlineoverridevirtual

Reimplemented from inet::tcp::TCPSegment_Base.

77 { return new TCPSegment(*this); }

inet::tcp::TCPSegment::TCPSegment

TCPSegment(const char *name=nullptr, int kind=0)

Definition: TCPSegment.h:73

virtual unsigned int inet::tcp::TCPSegment::getDestinationPort ( ) const

inlineoverridevirtual

Implements inet::ITransportPacket.

Referenced by inet::ExampleQoSClassifier::getUserPriority().

151 { return TCPSegment_Base::getDestPort(); }

inet::tcp::TCPSegment_Base::getDestPort

virtual unsigned short getDestPort() const

TCPOptionPtr & inet::tcp::TCPSegment::getHeaderOption ( unsigned int k )

overridevirtual

Returns the kth TCP options in this TCP segment.

Implements inet::tcp::TCPSegment_Base.

Referenced by inet::PacketDrillApp::compareTcpPacket(), inet::tcp::TCPConnection::getTSecr(), inet::tcp::TCPConnection::getTSval(), inet::tcp::TCP_NSC::handleIpInputMessage(), inet::tcp::TCPConnection::printSegmentBrief(), inet::tcp::TCPConnection::readHeaderOptions(), inet::PacketDrillApp::runEvent(), inet::tcp::TCPConnection::sendSegment(), and inet::PacketDump::tcpDump().

 {
     return headerOptionList.at(k);
 }

virtual const TCPOptionPtr& inet::tcp::TCPSegment::getHeaderOption ( unsigned int k ) const

inlineoverridevirtual

Reimplemented from inet::tcp::TCPSegment_Base.

Referenced by getHeaderOption().

137 {return const_cast<TCPSegment*>(this)->getHeaderOption(k);}

inet::tcp::TCPSegment::TCPSegment

TCPSegment(const char *name=nullptr, int kind=0)

Definition: TCPSegment.h:73

inet::tcp::TCPSegment::getHeaderOption

virtual TCPOptionPtr & getHeaderOption(unsigned int k) override

Returns the kth TCP options in this TCP segment.

Definition: TCPSegment.cc:250

inet::physicallayer::k

const double k

Definition: QAM16Modulation.cc:24

unsigned short inet::tcp::TCPSegment::getHeaderOptionArrayLength ( )

virtual

Calculate Length of TCP Options Array in bytes.

Referenced by inet::tcp::TCPConnection::addSacks(), and inet::tcp::TCPConnection::writeHeaderOptions().

 {
     unsigned short usedLength = 0;
 
     for (uint i = 0; i < getHeaderOptionArraySize(); i++)
         usedLength += getHeaderOption(i)->getLength();
 
     return usedLength;
 }

unsigned int inet::tcp::TCPSegment::getHeaderOptionArraySize ( ) const

overridevirtual

Returns the number of TCP options in this TCP segment.

Implements inet::tcp::TCPSegment_Base.

Referenced by inet::tcp::TCPConnection::addSacks(), inet::PacketDrillApp::compareTcpPacket(), inet::tcp::TCPConnection::getTSecr(), inet::tcp::TCPConnection::getTSval(), inet::tcp::TCP_NSC::handleIpInputMessage(), inet::tcp::TCPConnection::printSegmentBrief(), inet::tcp::TCPConnection::readHeaderOptions(), inet::PacketDrillApp::runEvent(), inet::tcp::TCPConnection::sendSegment(), inet::PacketDump::tcpDump(), and inet::tcp::TCPConnection::writeHeaderOptions().

 {
     return headerOptionList.size();
 }

TCPPayloadMessage & inet::tcp::TCPSegment::getPayload ( unsigned int k )

overridevirtual

Returns the kth payload message in this TCP segment.

Implements inet::tcp::TCPSegment_Base.

 {
     auto i = payloadList.begin();
     while (k > 0 && i != payloadList.end())
         (++i, --k);
     if (i == payloadList.end())
         throw cRuntimeError("Model error at getPayload(): index out of range");
     return *i;
 }

unsigned int inet::tcp::TCPSegment::getPayloadArraySize ( ) const

overridevirtual

Returns the number of payload messages in this TCP segment.

Implements inet::tcp::TCPSegment_Base.

Referenced by inet::tcp::TCPMsgBasedSendQueue::createSegmentWithBytes(), and inet::tcp::TcpLwipMsgBasedSendQueue::createSegmentWithBytes().

 {
     return payloadList.size();
 }

uint32_t inet::tcp::TCPSegment::getSegLen ( )

virtual

Returns RFC 793 specified SEG.LEN: SEG.LEN = the number of octets occupied by the data in the segment (counting SYN and FIN)

Referenced by inet::tcp::TCPConnection::segmentArrivalWhileClosed().

 {
     return payloadLength + (finBit ? 1 : 0) + (synBit ? 1 : 0);
 }

virtual unsigned int inet::tcp::TCPSegment::getSourcePort ( ) const

inlineoverridevirtual

Implements inet::ITransportPacket.

Referenced by inet::ExampleQoSClassifier::getUserPriority().

149 { return TCPSegment_Base::getSrcPort(); }

inet::tcp::TCPSegment_Base::getSrcPort

virtual unsigned short getSrcPort() const

TCPSegment & inet::tcp::TCPSegment::operator= ( const TCPSegment & other )

 {
     if (this == &other)
         return *this;
     clean();
     TCPSegment_Base::operator=(other);
     copy(other);
     return *this;
 }

void inet::tcp::TCPSegment::parsimPack ( cCommBuffer * b ) const

overridevirtual

 {
     TCPSegment_Base::parsimPack(b);
     b->pack((int)headerOptionList.size());
     for (const auto opt: headerOptionList) {
         b->packObject(opt);
     }
     b->pack((int)payloadList.size());
     for (PayloadList::const_iterator it = payloadList.begin(); it != payloadList.end(); it++) {
         b->pack(it->endSequenceNo);
         b->packObject(it->msg);
     }
 }

void inet::tcp::TCPSegment::parsimUnpack ( cCommBuffer * b )

overridevirtual

 {
     TCPSegment_Base::parsimUnpack(b);
     int i, n;
     b->unpack(n);
     for (i = 0; i < n; i++) {
         TCPOption *opt = check_and_cast<TCPOption*>(b->unpackObject());
         headerOptionList.push_back(opt);
     }
     b->unpack(n);
     for (i = 0; i < n; i++) {
         TCPPayloadMessage payload;
         b->unpack(payload.endSequenceNo);
         payload.msg = check_and_cast<cPacket*>(b->unpackObject());
         payloadList.push_back(payload);
     }
 }

cPacket * inet::tcp::TCPSegment::removeFirstPayloadMessage ( uint32 & outEndSequenceNo )

virtual

Removes and returns the first message object in this TCP segment.

It also returns the sequence number + 1 of its last octet in outEndSequenceNo.

Referenced by inet::tcp::TCPMsgBasedRcvQueue::insertBytesFromSegment(), and inet::tcp::TcpLwipMsgBasedReceiveQueue::notifyAboutIncomingSegmentProcessing().

 {
     if (payloadList.empty())
         return nullptr;
 
     cPacket *msg = payloadList.front().msg;
     endSequenceNo = payloadList.front().endSequenceNo;
     payloadList.pop_front();
     drop(msg);
     return msg;
 }

virtual void inet::tcp::TCPSegment::setDestinationPort ( unsigned int port )

inlineoverridevirtual

Implements inet::ITransportPacket.

152 { TCPSegment_Base::setDestPort(port); }

inet::tcp::TCPSegment_Base::setDestPort

virtual void setDestPort(unsigned short destPort)

void inet::tcp::TCPSegment::setHeaderOption	(	unsigned int	k,
		const TCPOptionPtr &	headerOption
	)

overridevirtual

Generated but unused method, should not be called.

Implements inet::tcp::TCPSegment_Base.

Referenced by inet::PacketDrillApp::runEvent().

 {
     throw cRuntimeError(this, "setHeaderOption() not supported, use addHeaderOption()");
 }

void inet::tcp::TCPSegment::setHeaderOptionArraySize ( unsigned int size )

overridevirtual

Generated but unused method, should not be called.

Implements inet::tcp::TCPSegment_Base.

 {
     throw cRuntimeError(this, "setHeaderOptionArraySize() not supported, use addHeaderOption()");
 }

void inet::tcp::TCPSegment::setPayload	(	unsigned int	k,
		const TCPPayloadMessage &	payload_var
	)

overridevirtual

Generated but unused method, should not be called.

Implements inet::tcp::TCPSegment_Base.

 {
     throw cRuntimeError(this, "setPayload() not supported, use addPayloadMessage()");
 }

void inet::tcp::TCPSegment::setPayloadArraySize ( unsigned int size )

overridevirtual

Generated but unused method, should not be called.

Implements inet::tcp::TCPSegment_Base.

 {
     throw cRuntimeError(this, "setPayloadArraySize() not supported, use addPayloadMessage()");
 }

virtual void inet::tcp::TCPSegment::setSourcePort ( unsigned int port )

inlineoverridevirtual

Implements inet::ITransportPacket.

150 { TCPSegment_Base::setSrcPort(port); }

inet::tcp::TCPSegment_Base::setSrcPort

virtual void setSrcPort(unsigned short srcPort)

void inet::tcp::TCPSegment::truncateData	(	unsigned int	truncleft,
		unsigned int	truncright
	)

protectedvirtual

Truncate segment data.

Called from truncateSegment().

Parameters

truncleft	number of bytes for truncate from begin of data
truncright	number of bytes for truncate from end of data

 {
     ASSERT(payloadLength >= truncleft + truncright);
 
     if (0 != byteArray.getDataArraySize())
         byteArray.truncateData(truncleft, truncright);
 
     while (!payloadList.empty() && (payloadList.front().endSequenceNo - sequenceNo) <= truncleft) {
         cPacket *msg = payloadList.front().msg;
         payloadList.pop_front();
         dropAndDelete(msg);
     }
 
     sequenceNo += truncleft;
     payloadLength -= truncleft + truncright;
 
     // truncate payload data correctly
     while (!payloadList.empty() && (payloadList.back().endSequenceNo - sequenceNo) > payloadLength) {
         cPacket *msg = payloadList.back().msg;
         payloadList.pop_back();
         dropAndDelete(msg);
     }
 }

void inet::tcp::TCPSegment::truncateSegment	(	uint32	firstSeqNo,
		uint32	endSeqNo
	)

virtual

Truncate segment.

Parameters

firstSeqNo	sequence no of new first byte
endSeqNo	sequence no of new last byte + 1

Referenced by inet::tcp::TCPConnection::processSegment1stThru8th().

 {
     ASSERT(payloadLength > 0);
 
     // must have common part:
 #ifndef NDEBUG
     if (!(seqLess(sequenceNo, endSeqNo) && seqLess(firstSeqNo, sequenceNo + payloadLength))) {
         throw cRuntimeError(this, "truncateSegment(%u,%u) called on [%u, %u) segment\n",
                 firstSeqNo, endSeqNo, sequenceNo, sequenceNo + payloadLength);
     }
 #endif // ifndef NDEBUG
 
     unsigned int truncleft = 0;
     unsigned int truncright = 0;
 
     if (seqLess(sequenceNo, firstSeqNo)) {
         truncleft = firstSeqNo - sequenceNo;
     }
 
     if (seqGreater(sequenceNo + payloadLength, endSeqNo)) {
         truncright = sequenceNo + payloadLength - endSeqNo;
     }
 
     truncateData(truncleft, truncright);
 }

Member Data Documentation

OptionList inet::tcp::TCPSegment::headerOptionList

protected

Referenced by copy().

PayloadList inet::tcp::TCPSegment::payloadList

protected

Referenced by copy().

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation