inet::sctp::SCTPGapList Class Reference

#include <SCTPGapList.h>

Public Types
enum	GapType { GT_Any = 0, GT_Revokable = 1, GT_NonRevokable = 2 }

Public Member Functions
	SCTPGapList ()
	~SCTPGapList ()
void	setInitialCumAckTSN (const uint32 cumAckTSN)
uint32	getCumAckTSN () const
uint32	getHighestTSNReceived () const
uint32	getNumGaps (const GapType type) const
bool	tsnInGapList (const uint32 tsn) const
bool	tsnIsRevokable (const uint32 tsn) const
bool	tsnIsNonRevokable (const uint32 tsn) const
uint32	getGapStart (const GapType type, const uint32 index) const
uint32	getGapStop (const GapType type, const uint32 index) const
void	check () const
void	print (std::ostream &os) const
void	forwardCumAckTSN (const uint32 cumAckTSN)
bool	tryToAdvanceCumAckTSN ()
void	removeFromGapList (const uint32 removedTSN)
bool	updateGapList (const uint32 receivedTSN, bool &newChunkReceived, bool tsnIsRevokable=true)
void	resetGaps (const uint32 newCumAck)

Private Attributes
uint32	CumAckTSN
SCTPSimpleGapList	RevokableGapList
SCTPSimpleGapList	NonRevokableGapList
SCTPSimpleGapList	CombinedGapList

Member Enumeration Documentation

enum inet::sctp::SCTPGapList::GapType

Enumerator
GT_Any
GT_Revokable
GT_NonRevokable

                 {
        GT_Any = 0,
        GT_Revokable = 1,
        GT_NonRevokable = 2
    };

Constructor & Destructor Documentation

inet::sctp::SCTPGapList::SCTPGapList

(

)

{
    CumAckTSN = 0;
}

inet::sctp::SCTPGapList::~SCTPGapList

(

)

{
}

Member Function Documentation

void inet::sctp::SCTPGapList::check

(

)

const

{
    CombinedGapList.check(CumAckTSN);
    RevokableGapList.check(CumAckTSN);
    NonRevokableGapList.check(CumAckTSN);
}

void inet::sctp::SCTPGapList::forwardCumAckTSN

(

const uint32

cumAckTSN

)

Referenced by inet::sctp::SCTPAssociation::processResetResponseArrived(), and inet::sctp::SCTPAssociation::sendInitAck().

{
    CumAckTSN = cumAckTSN;
    CombinedGapList.forwardCumAckTSN(CumAckTSN);
    RevokableGapList.forwardCumAckTSN(CumAckTSN);
    NonRevokableGapList.forwardCumAckTSN(CumAckTSN);
}

uint32 inet::sctp::SCTPGapList::getCumAckTSN ( ) const

inline

Referenced by inet::sctp::SCTPAssociation::createForwardTsnChunk(), inet::sctp::SCTPAssociation::createSack(), inet::sctp::SCTPAssociation::makeRoomForTsn(), inet::sctp::SCTPAssociation::processDataArrived(), inet::sctp::SCTPAssociation::processForwardTsnArrived(), inet::sctp::SCTPAssociation::processStreamResetArrived(), and inet::sctp::SCTPAssociation::sendShutdown().

    {
        return CumAckTSN;
    }

uint32 inet::sctp::SCTPGapList::getGapStart ( const GapType  type, const uint32  index  ) const

inline

Referenced by inet::sctp::SCTPAssociation::createForwardTsnChunk(), and inet::sctp::SCTPAssociation::processSackArrived().

    {
        if (type == GT_Revokable) {
            return RevokableGapList.getGapStart(index);
        }
        else if (type == GT_NonRevokable) {
            return NonRevokableGapList.getGapStart(index);
        }
        else {
            return CombinedGapList.getGapStart(index);
        }
    }

uint32 inet::sctp::SCTPGapList::getGapStop ( const GapType  type, const uint32  index  ) const

inline

Referenced by inet::sctp::SCTPAssociation::createForwardTsnChunk(), and inet::sctp::SCTPAssociation::processSackArrived().

    {
        if (type == GT_Revokable) {
            return RevokableGapList.getGapStop(index);
        }
        else if (type == GT_NonRevokable) {
            return NonRevokableGapList.getGapStop(index);
        }
        else {
            return CombinedGapList.getGapStop(index);
        }
    }

uint32 inet::sctp::SCTPGapList::getHighestTSNReceived ( ) const

inline

Referenced by inet::sctp::SCTPAssociation::makeRoomForTsn(), inet::sctp::SCTPAssociation::process_RCV_Message(), inet::sctp::SCTPAssociation::processDataArrived(), inet::sctp::SCTPAssociation::processInAndOutResetRequestArrived(), inet::sctp::SCTPAssociation::processOutgoingResetRequestArrived(), inet::sctp::SCTPAssociation::resetGapLists(), and inet::sctp::SCTPAssociation::sendStreamResetResponse().

    {
        if (CombinedGapList.getNumGaps() > 0) {
            return CombinedGapList.getGapStop(CombinedGapList.getNumGaps() - 1);
        }
        else {
            return CumAckTSN;
        }
    }

uint32 inet::sctp::SCTPGapList::getNumGaps ( const GapType  type ) const

inline

Referenced by inet::sctp::SCTPAssociation::createForwardTsnChunk(), inet::sctp::SCTPAssociation::createSack(), inet::sctp::SCTPAssociation::processSackArrived(), and inet::sctp::SCTPAssociation::timeForSack().

    {
        if (type == GT_Revokable) {
            return RevokableGapList.getNumGaps();
        }
        else if (type == GT_NonRevokable) {
            return NonRevokableGapList.getNumGaps();
        }
        else {
            return CombinedGapList.getNumGaps();
        }
    }

void inet::sctp::SCTPGapList::print

(

std::ostream &

os

)

const

Referenced by inet::sctp::operator<<().

{
    os << "CumAck=" << CumAckTSN;
    os << "   Combined-Gaps=" << CombinedGapList;
    os << "   R-Gaps=" << RevokableGapList;
    os << "   NR-Gaps=" << NonRevokableGapList;
}

void inet::sctp::SCTPGapList::removeFromGapList

(

const uint32

removedTSN

)

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

{
    RevokableGapList.removeFromGapList(removedTSN);
    NonRevokableGapList.removeFromGapList(removedTSN);
    CombinedGapList.removeFromGapList(removedTSN);
}

void inet::sctp::SCTPGapList::resetGaps

(

const uint32

newCumAck

)

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

{
    CumAckTSN = newCumAck;
    RevokableGapList.resetGaps();
    NonRevokableGapList.resetGaps();
    CombinedGapList.resetGaps();
}

void inet::sctp::SCTPGapList::setInitialCumAckTSN ( const uint32  cumAckTSN )

inline

Referenced by inet::sctp::SCTPAssociation::processInitAckArrived(), inet::sctp::SCTPAssociation::processInitArrived(), and inet::sctp::SCTPAssociation::processSackArrived().

    {
        assert(CombinedGapList.getNumGaps() == 0);
        CumAckTSN = cumAckTSN;
    }

bool inet::sctp::SCTPGapList::tryToAdvanceCumAckTSN

(

)

Referenced by inet::sctp::SCTPAssociation::processDataArrived(), and inet::sctp::SCTPAssociation::processForwardTsnArrived().

{
    if (CombinedGapList.tryToAdvanceCumAckTSN(CumAckTSN)) {
        RevokableGapList.forwardCumAckTSN(CumAckTSN);
        NonRevokableGapList.forwardCumAckTSN(CumAckTSN);
        return true;
    }
    return false;
}

bool inet::sctp::SCTPGapList::tsnInGapList ( const uint32  tsn ) const

inline

Referenced by inet::sctp::SCTPAssociation::processForwardTsnArrived(), and inet::sctp::SCTPAssociation::tsnIsDuplicate().

    {
        return CombinedGapList.tsnInGapList(tsn);
    }

bool inet::sctp::SCTPGapList::tsnIsNonRevokable ( const uint32  tsn ) const

inline

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

    {
        return NonRevokableGapList.tsnInGapList(tsn);
    }

bool inet::sctp::SCTPGapList::tsnIsRevokable ( const uint32  tsn ) const

inline

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

    {
        return RevokableGapList.tsnInGapList(tsn);
    }

bool inet::sctp::SCTPGapList::updateGapList	(	const uint32	receivedTSN,
		bool &	newChunkReceived,
		bool	tsnIsRevokable = true
	)

Referenced by inet::sctp::SCTPAssociation::processDataArrived(), inet::sctp::SCTPAssociation::processForwardTsnArrived(), and inet::sctp::SCTPAssociation::processSackArrived().

{
    uint32 oldCumAckTSN = CumAckTSN;
    if (tsnIsRevokable) {
        // Once a TSN become non-revokable, it cannot become revokable again!
        // However, if the list became too long, updateGapList() may be called
        // again when the chunk is received again.
        RevokableGapList.updateGapList(receivedTSN, oldCumAckTSN, newChunkReceived);
    }
    else {
        if (NonRevokableGapList.updateGapList(receivedTSN, oldCumAckTSN, newChunkReceived) == true) {
            // TSN has moved from revokable to non-revokable!
            RevokableGapList.removeFromGapList(receivedTSN);
        }
    }

    // Finally, add TSN to combined list and set CumAckTSN.
    oldCumAckTSN = CumAckTSN;
    const bool newChunk = CombinedGapList.updateGapList(receivedTSN, CumAckTSN, newChunkReceived);
    if (oldCumAckTSN != CumAckTSN) {
        RevokableGapList.forwardCumAckTSN(CumAckTSN);
        NonRevokableGapList.forwardCumAckTSN(CumAckTSN);
    }
    return newChunk;
}

Member Data Documentation

SCTPSimpleGapList inet::sctp::SCTPGapList::CombinedGapList

private

uint32 inet::sctp::SCTPGapList::CumAckTSN

private

SCTPSimpleGapList inet::sctp::SCTPGapList::NonRevokableGapList

private

SCTPSimpleGapList inet::sctp::SCTPGapList::RevokableGapList

private

---

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

• SCTPGapList.h
• SCTPGapList.cc