inet::sctp::SCTPQueue Class Reference

Abstract base class for SCTP receive queues. More...

#include <SCTPQueue.h>

Inheritance diagram for inet::sctp::SCTPQueue:

Public Types
typedef std::map< uint32, SCTPDataVariables * >	PayloadQueue

Public Member Functions
	SCTPQueue ()
	Constructor. More...
	SCTPQueue (SCTPAssociation *assoc)
	~SCTPQueue ()
	Virtual destructor. More...
bool	checkAndInsertChunk (const uint32 key, SCTPDataVariables *chunk)
SCTPDataVariables *	getAndExtractChunk (const uint32 tsn)
SCTPDataVariables *	extractMessage ()
void	printQueue () const
uint32	getQueueSize () const
SCTPDataVariables *	getFirstChunk () const
cMessage *	getMsg (const uint32 key) const
SCTPDataVariables *	getChunk (const uint32 key) const
SCTPDataVariables *	getChunkFast (const uint32 tsn, bool &firstTime)
void	removeMsg (const uint32 key)
bool	deleteMsg (const uint32 tsn)
int32	getNumBytes () const
SCTPDataVariables *	dequeueChunkBySSN (const uint16 ssn)
uint32	getSizeOfFirstChunk (const L3Address &remoteAddress)
uint16	getFirstSsnInQueue (const uint16 sid)
void	findEarliestOutstandingTSNsForPath (const L3Address &remoteAddress, uint32 &earliestOutstandingTSN, uint32 &rtxEarliestOutstandingTSN) const

Public Attributes
PayloadQueue	payloadQueue

Protected Attributes
SCTPAssociation *	assoc

Private Attributes
PayloadQueue::iterator	GetChunkFastIterator

Detailed Description

Abstract base class for SCTP receive queues.

This class represents data received by SCTP but not yet passed up to the application. The class also accomodates for selective retransmission, i.e. also acts as a segment buffer.

This class goes hand-in-hand with SCTPSendQueue.

This class is polymorphic because depending on where and how you use the SCTP model you might have different ideas about "sending data" on a simulated connection: you might want to transmit real bytes, "dummy" (byte count only), cMessage objects, etc; see discussion at SCTPSendQueue. Different subclasses can be written to accomodate different needs.

See also

SCTPSendQueue

Member Typedef Documentation

typedef std::map<uint32, SCTPDataVariables *> inet::sctp::SCTPQueue::PayloadQueue

Constructor & Destructor Documentation

inet::sctp::SCTPQueue::SCTPQueue

(

)

Constructor.

{
    assoc = nullptr;
}

inet::sctp::SCTPQueue::SCTPQueue

(

SCTPAssociation *

assoc

)

{
    assoc = assoc_;
}

inet::sctp::SCTPQueue::~SCTPQueue

(

)

Virtual destructor.

{
    for (auto & elem : payloadQueue)
    {
        SCTPDataVariables *chunk = elem.second;
        delete chunk->userData;
    }
    if (!payloadQueue.empty()) {
        payloadQueue.clear();
    }
}

Member Function Documentation

bool inet::sctp::SCTPQueue::checkAndInsertChunk	(	const uint32	key,
		SCTPDataVariables *	chunk
	)

Referenced by inet::sctp::SCTPReceiveStream::enqueueNewDataChunk(), inet::sctp::SCTPAssociation::handleChunkReportedAsMissing(), inet::sctp::SCTPAssociation::moveChunkToOtherPath(), inet::sctp::SCTPAssociation::putInDeliveryQ(), inet::sctp::SCTPAssociation::putInTransmissionQ(), and inet::sctp::SCTPAssociation::sendOnPath().

{
    auto found = payloadQueue.find(key);
    if (found != payloadQueue.end()) {
        return false;
    }
    payloadQueue[key] = chunk;
    return true;
}

bool inet::sctp::SCTPQueue::deleteMsg

(

const uint32

tsn

)

Referenced by inet::sctp::SCTPAssociation::makeRoomForTsn().

{
    auto iterator = payloadQueue.find(tsn);
    if (iterator != payloadQueue.end()) {
        SCTPDataVariables *chunk = iterator->second;
        cMessage *msg = check_and_cast<cMessage *>(chunk->userData);
        delete msg;
        payloadQueue.erase(iterator);
        return true;
    }
    return false;
}

SCTPDataVariables * inet::sctp::SCTPQueue::dequeueChunkBySSN

(

const uint16

ssn

)

Referenced by inet::sctp::SCTPReceiveStream::enqueueNewDataChunk(), and inet::sctp::SCTPAssociation::putInDeliveryQ().

{
    for (auto iterator = payloadQueue.begin();
         iterator != payloadQueue.end(); iterator++)
    {
        SCTPDataVariables *chunk = iterator->second;
        if ((iterator->second->ssn == ssn) &&
            (iterator->second->bbit) &&
            (iterator->second->ebit))
        {
            payloadQueue.erase(iterator);
            return chunk;
        }
    }
    return nullptr;
}

SCTPDataVariables * inet::sctp::SCTPQueue::extractMessage

(

)

Referenced by inet::sctp::SCTPAssociation::pushUlp().

{
    if (!payloadQueue.empty()) {
        auto iterator = payloadQueue.begin();
        SCTPDataVariables *chunk = iterator->second;
        payloadQueue.erase(iterator);
        return chunk;
    }
    return nullptr;
}

void inet::sctp::SCTPQueue::findEarliestOutstandingTSNsForPath	(	const L3Address &	remoteAddress,
		uint32 &	earliestOutstandingTSN,
		uint32 &	rtxEarliestOutstandingTSN
	)		const

Referenced by inet::sctp::SCTPAssociation::checkPseudoCumAck().

{
    bool findEarliestOutstandingTSN = true;
    bool findRTXEarliestOutstandingTSN = true;

    for (const auto & elem : payloadQueue)
    {
        const SCTPDataVariables *chunk = elem.second;
        if (chunk->getLastDestination() == remoteAddress) {
            // ====== Find earliest outstanding TSNs ===========================
            if (chunk->hasBeenAcked == false) {
                if ((findEarliestOutstandingTSN) &&
                    (chunk->numberOfRetransmissions == 0))
                {
                    earliestOutstandingTSN = chunk->tsn;
                }
                findEarliestOutstandingTSN = false;
                if ((findRTXEarliestOutstandingTSN) &&
                    (chunk->numberOfRetransmissions > 0))
                {
                    rtxEarliestOutstandingTSN = chunk->tsn;
                }
                findRTXEarliestOutstandingTSN = false;
            }
        }
    }
}

SCTPDataVariables * inet::sctp::SCTPQueue::getAndExtractChunk

(

const uint32

tsn

)

Referenced by inet::sctp::SCTPReceiveStream::enqueueNewDataChunk(), inet::sctp::SCTPAssociation::nonRenegablyAckChunk(), and inet::sctp::SCTPReceiveStream::reassemble().

{
    if (!payloadQueue.empty()) {
        auto iterator = payloadQueue.find(tsn);
        SCTPDataVariables *chunk = iterator->second;
        payloadQueue.erase(iterator);
        return chunk;
    }
    return nullptr;
}

SCTPDataVariables * inet::sctp::SCTPQueue::getChunk

(

const uint32

key

)

const

Referenced by inet::sctp::SCTPAssociation::chunkHasBeenAcked(), inet::sctp::SCTPReceiveStream::enqueueNewDataChunk(), inet::sctp::SCTPAssociation::handleChunkReportedAsMissing(), inet::sctp::SCTPAssociation::makeRoomForTsn(), inet::sctp::SCTPAssociation::nonRenegablyAckChunk(), inet::sctp::SCTPAssociation::processSackArrived(), inet::sctp::SCTPReceiveStream::reassemble(), and inet::sctp::SCTPAssociation::renegablyAckChunk().

{
    PayloadQueue::const_iterator iterator = payloadQueue.find(tsn);
    if (iterator != payloadQueue.end()) {
        SCTPDataVariables *chunk = iterator->second;
        return chunk;
    }
    return nullptr;
}

SCTPDataVariables * inet::sctp::SCTPQueue::getChunkFast	(	const uint32	tsn,
		bool &	firstTime
	)

Referenced by inet::sctp::SCTPAssociation::processSackArrived().

{
    if (!firstTime) {
        if (GetChunkFastIterator != payloadQueue.end()) {
            SCTPDataVariables *chunk = GetChunkFastIterator->second;
            if (chunk->tsn == tsn) {
                GetChunkFastIterator++;
                return chunk;    // Found the right TSN!
            }
        }
        // TSN not found -> needs regular TSN lookup.
    }

    GetChunkFastIterator = payloadQueue.find(tsn);
    if (GetChunkFastIterator != payloadQueue.end()) {
        SCTPDataVariables *chunk = GetChunkFastIterator->second;
        GetChunkFastIterator++;
        firstTime = false;
        return chunk;
    }

    return nullptr;
}

SCTPDataVariables * inet::sctp::SCTPQueue::getFirstChunk

(

)

const

{
    PayloadQueue::const_iterator iterator = payloadQueue.begin();
    SCTPDataVariables *chunk = iterator->second;
    return chunk;
}

uint16 inet::sctp::SCTPQueue::getFirstSsnInQueue

(

const uint16

sid

)

Referenced by inet::sctp::SCTPAssociation::processForwardTsnArrived().

{
    return payloadQueue.begin()->second->ssn;
}

cMessage * inet::sctp::SCTPQueue::getMsg

(

const uint32

key

)

const

{
    PayloadQueue::const_iterator iterator = payloadQueue.find(tsn);
    if (iterator != payloadQueue.end()) {
        SCTPDataVariables *chunk = iterator->second;
        cMessage *msg = check_and_cast<cMessage *>(chunk->userData);
        return msg;
    }
    return nullptr;
}

int32 inet::sctp::SCTPQueue::getNumBytes

(

)

const

{
    int32 qb = 0;
    for (const auto & elem : payloadQueue)
    {
        qb += (elem.second->len / 8);
    }
    return qb;
}

uint32 inet::sctp::SCTPQueue::getQueueSize

(

)

const

Referenced by inet::sctp::SCTPAssociation::calculateRcvBuffer(), inet::sctp::SCTPReceiveStream::enqueueNewDataChunk(), inet::sctp::SCTPAssociation::process_RCV_Message(), inet::sctp::SCTPAssociation::processForwardTsnArrived(), inet::sctp::SCTPAssociation::pushUlp(), inet::sctp::SCTPAssociation::putInDeliveryQ(), inet::sctp::SCTPAssociation::putInTransmissionQ(), and inet::sctp::SCTPAssociation::sendOnPath().

{
    return payloadQueue.size();
}

uint32 inet::sctp::SCTPQueue::getSizeOfFirstChunk

(

const L3Address &

remoteAddress

)

Referenced by inet::sctp::SCTPAssociation::sendOnPath().

{
    for (PayloadQueue::const_iterator iterator = payloadQueue.begin();
         iterator != payloadQueue.end(); ++iterator)
    {
        const SCTPDataVariables *chunk = iterator->second;
        if (chunk->getNextDestination() == remoteAddress) {
            return chunk->booksize;
        }
    }
    return 0;
}

void inet::sctp::SCTPQueue::printQueue

(

)

const

{
    EV_DEBUG << "Queue contents:\n";
    for (const auto & elem : payloadQueue)
    {
        const uint32 key = elem.first;
        const SCTPDataVariables *chunk = elem.second;
        EV_DEBUG << key << ":\t"
                 << "lastDestination=" << chunk->getLastDestination()
                 << " nextDestination=" << chunk->getNextDestination()
                 << " hasBeenAcked=" << chunk->hasBeenAcked
                 << " countsAsOutstanding=" << chunk->countsAsOutstanding
                 << " numberOfRetransmissions=" << chunk->numberOfRetransmissions
                 << endl;
    }
    EV_DEBUG << endl;
}

void inet::sctp::SCTPQueue::removeMsg

(

const uint32

key

)

Referenced by inet::sctp::SCTPAssociation::nonRenegablyAckChunk(), and inet::sctp::SCTPAssociation::renegablyAckChunk().

{
    auto iterator = payloadQueue.find(tsn);
    payloadQueue.erase(iterator);
}

Member Data Documentation

SCTPAssociation* inet::sctp::SCTPQueue::assoc

protected

Referenced by SCTPQueue().

PayloadQueue::iterator inet::sctp::SCTPQueue::GetChunkFastIterator

private

Referenced by getChunkFast().

PayloadQueue inet::sctp::SCTPQueue::payloadQueue

Referenced by inet::sctp::SCTPAssociation::advancePeerTsn(), checkAndInsertChunk(), inet::sctp::SCTPAssociation::chunkReschedulingControl(), inet::sctp::SCTPAssociation::createForwardTsnChunk(), deleteMsg(), inet::sctp::SCTPAssociation::dequeueAckedChunks(), dequeueChunkBySSN(), extractMessage(), findEarliestOutstandingTSNsForPath(), getAndExtractChunk(), getChunk(), getChunkFast(), getFirstChunk(), getFirstSsnInQueue(), getMsg(), getNumBytes(), inet::sctp::SCTPAssociation::getOutboundDataChunk(), getQueueSize(), getSizeOfFirstChunk(), inet::sctp::SCTPAssociation::loadPacket(), inet::sctp::SCTPAssociation::peekAbandonedChunk(), printQueue(), inet::sctp::SCTPAssociation::process_TIMEOUT_RTX(), inet::sctp::SCTPAssociation::processPacketDropArrived(), inet::sctp::SCTPAssociation::processSackArrived(), inet::sctp::SCTPAssociation::pushUlp(), inet::sctp::SCTPAssociation::putInTransmissionQ(), inet::sctp::SCTP::removeAssociation(), removeMsg(), inet::sctp::SCTPAssociation::storePacket(), and ~SCTPQueue().

---

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

• SCTPQueue.h
• SCTPQueue.cc