inet::sctp::SCTPMessage Class Reference

Represents a SCTP Message. More...

#include <SCTPMessage.h>

Inheritance diagram for inet::sctp::SCTPMessage:

Public Member Functions
	SCTPMessage (const char *name=nullptr, int32 kind=0)
	SCTPMessage (const SCTPMessage &other)
	~SCTPMessage ()
SCTPMessage &	operator= (const SCTPMessage &other)
virtual SCTPMessage *	dup () const override
virtual void	setChunksArraySize (uint32 size) override
	Generated but unused method, should not be called. More...
virtual void	setChunks (uint32 k, const cPacketPtr &chunks_var) override
	Generated but unused method, should not be called. More...
virtual uint32	getChunksArraySize () const override
	Returns the number of chunks in this SCTP packet. More...
virtual cPacketPtr &	getChunks (uint32 k) override
	Returns the kth chunk in this SCTP packet. More...
virtual void	addChunk (cPacket *msg)
	Adds a message object to the SCTP packet. More...
virtual cPacket *	removeChunk ()
	Removes and returns the first message object in this SCTP packet. More...
virtual cPacket *	removeLastChunk ()
virtual cPacket *	peekFirstChunk ()
virtual cPacket *	peekLastChunk ()
virtual void	replaceChunk (cPacket *msg, uint32 k)
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::sctp::SCTPMessage_Base
virtual	~SCTPMessage_Base ()
virtual void	parsimPack (omnetpp::cCommBuffer *b) const override
virtual void	parsimUnpack (omnetpp::cCommBuffer *b) override
virtual uint16_t	getSrcPort () const
virtual void	setSrcPort (uint16_t srcPort)
virtual uint16_t	getDestPort () const
virtual void	setDestPort (uint16_t destPort)
virtual uint32_t	getTag () const
virtual void	setTag (uint32_t tag)
virtual bool	getChecksumOk () const
virtual void	setChecksumOk (bool checksumOk)
virtual void	setChunksArraySize (unsigned int size)=0
virtual cPacketPtr &	getChunks (unsigned int k)=0
virtual const cPacketPtr &	getChunks (unsigned int k) const
virtual void	setChunks (unsigned int k, const cPacketPtr &chunks)=0
Public Member Functions inherited from inet::ITransportPacket
virtual	~ITransportPacket ()

Protected Attributes
std::vector< cPacket * >	chunkList
Protected Attributes inherited from inet::sctp::SCTPMessage_Base
uint16_t	srcPort
uint16_t	destPort
uint32_t	tag
bool	checksumOk

Private Member Functions
void	copy (const SCTPMessage &other)
void	clean ()

Additional Inherited Members
Protected Member Functions inherited from inet::sctp::SCTPMessage_Base
bool	operator== (const SCTPMessage_Base &)
	SCTPMessage_Base (const char *name=nullptr, short kind=0)
	SCTPMessage_Base (const SCTPMessage_Base &other)
SCTPMessage_Base &	operator= (const SCTPMessage_Base &other)

Detailed Description

Represents a SCTP Message.

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

Constructor & Destructor Documentation

inet::sctp::SCTPMessage::SCTPMessage ( const char *  name = nullptr, int32  kind = 0  )

inline

: SCTPMessage_Base(name, kind) {}

inet::sctp::SCTPMessage::SCTPMessage ( const SCTPMessage &  other )

inline

: SCTPMessage_Base(other) { copy(other); }

inet::sctp::SCTPMessage::~SCTPMessage

(

)

{
    clean();
}

Member Function Documentation

void inet::sctp::SCTPMessage::addChunk ( cPacket *  msg )

virtual

Adds a message object to the SCTP packet.

The packet length will be adjusted

Referenced by inet::sctp::SCTPAssociation::addAuthChunkIfNecessary(), PacketDrill::buildSCTPPacket(), inet::PacketDrillApp::closeAllSockets(), inet::serializer::SCTPSerializer::parse(), inet::sctp::SCTPAssociation::processAddInAndOutResetRequestArrived(), inet::sctp::SCTPAssociation::processAsconfArrived(), inet::sctp::SCTPAssociation::processPacketDropArrived(), inet::sctp::SCTPAssociation::retransmitAsconf(), inet::sctp::SCTPAssociation::retransmitCookieEcho(), inet::sctp::SCTPAssociation::retransmitInit(), inet::sctp::SCTPAssociation::retransmitReset(), inet::sctp::SCTPAssociation::retransmitShutdown(), inet::sctp::SCTPAssociation::retransmitShutdownAck(), inet::sctp::SCTPAssociation::sendAbort(), inet::sctp::SCTP::sendAbortFromMain(), inet::sctp::SCTPAssociation::sendAddInAndOutStreamsRequest(), inet::sctp::SCTPAssociation::sendAddOutgoingStreamsRequest(), inet::sctp::SCTPAssociation::sendAsconf(), inet::sctp::SCTPAssociation::sendAsconfAck(), inet::sctp::SCTPNatHook::sendBackError(), inet::sctp::SCTPAssociation::sendBundledOutgoingResetAndResponse(), inet::sctp::SCTPAssociation::sendCookieAck(), inet::sctp::SCTPAssociation::sendCookieEcho(), inet::sctp::SCTPAssociation::sendDoubleStreamResetResponse(), inet::sctp::SCTPAssociation::sendHeartbeat(), inet::sctp::SCTPAssociation::sendHeartbeatAck(), inet::sctp::SCTPAssociation::sendHMacError(), inet::sctp::SCTPAssociation::sendInit(), inet::sctp::SCTPAssociation::sendInitAck(), inet::sctp::SCTPAssociation::sendInvalidStreamError(), inet::sctp::SCTPAssociation::sendOnPath(), inet::sctp::SCTPAssociation::sendOutgoingRequestAndResponse(), inet::sctp::SCTPAssociation::sendOutgoingResetRequest(), inet::sctp::SCTPAssociation::sendPacketDrop(), inet::sctp::SCTPAssociation::sendSack(), inet::sctp::SCTPAssociation::sendShutdown(), inet::sctp::SCTPAssociation::sendShutdownAck(), inet::sctp::SCTPAssociation::sendShutdownComplete(), inet::sctp::SCTP::sendShutdownCompleteFromMain(), inet::sctp::SCTPAssociation::sendStreamResetRequest(), and inet::sctp::SCTPAssociation::sendStreamResetResponse().

{
    char str[256];
    take(msg);
    if (this->chunkList.size() < 9) {
        snprintf(str, sizeof(str), "%s %s", this->getName(), msg->getName());
        this->setName(str);
    }
    this->setByteLength(this->getByteLength() + ADD_PADDING(msg->getByteLength()));
    chunkList.push_back(msg);
}

void inet::sctp::SCTPMessage::clean ( )

private

Referenced by operator=(), inet::sctp::SCTPErrorChunk::operator=(), inet::sctp::SCTPErrorChunk::~SCTPErrorChunk(), ~SCTPMessage(), and inet::sctp::SCTPStreamResetChunk::~SCTPStreamResetChunk().

{
    SCTPChunk *chunk;
    if (this->getChunksArraySize() > 0)
        for (uint32 i = 0; i < this->getChunksArraySize(); i++) {
            chunk = (SCTPChunk *)this->getChunks(i);
            dropAndDelete(chunk);
        }
}

void inet::sctp::SCTPMessage::copy ( const SCTPMessage &  other )

private

Referenced by operator=(), and inet::sctp::SCTPErrorChunk::operator=().

{
    setTag(other.getTag());
    setSrcPort(other.getSrcPort());
    setDestPort(other.getDestPort());
    setChecksumOk(other.getChecksumOk());
    for (const auto & elem : other.chunkList) {
        cPacket *chunk = (elem)->dup();
        take(chunk);
        chunkList.push_back(chunk);
    }
    ASSERT(getByteLength() == other.getByteLength());
}

virtual SCTPMessage* inet::sctp::SCTPMessage::dup ( ) const

inlineoverridevirtual

Reimplemented from inet::sctp::SCTPMessage_Base.

Referenced by copy(), inet::sctp::SCTPErrorChunk::copy(), inet::sctp::SCTPStreamResetChunk::copy(), inet::sctp::SCTPStreamResetChunk::operator=(), inet::sctp::SCTPAsconfChunk::operator=(), inet::sctp::SCTPAsconfAckChunk::operator=(), inet::sctp::SCTPAssociation::process_RCV_Message(), and inet::sctp::SCTPAssociation::sendPacketDrop().

{ return new SCTPMessage(*this); }

cPacketPtr & inet::sctp::SCTPMessage::getChunks ( uint32  k )

overridevirtual

Returns the kth chunk in this SCTP packet.

Referenced by clean(), inet::sctp::SCTP::handleMessage(), inet::sctp::SCTPAssociation::process_RCV_Message(), inet::PacketDrillApp::runEvent(), inet::PacketDump::sctpDump(), inet::sctp::SCTP::sendAbortFromMain(), inet::sctp::SCTPAssociation::sendOnPath(), inet::sctp::SCTPAssociation::sendPacketDrop(), and inet::sctp::SCTPAssociation::storePacket().

{
    return chunkList.at(k);
}

uint32 inet::sctp::SCTPMessage::getChunksArraySize ( ) const

overridevirtual

Returns the number of chunks in this SCTP packet.

Implements inet::sctp::SCTPMessage_Base.

Referenced by clean(), inet::PacketDrillApp::compareSctpPacket(), inet::sctp::SCTPNatHook::datagramForwardHook(), inet::sctp::SCTPNatHook::datagramPreRoutingHook(), inet::serializer::SCTPSerializer::deserialize(), inet::sctp::SCTPAssociation::disposeOf(), inet::sctp::SCTP::handleMessage(), inet::sctp::SCTPAssociation::process_RCV_Message(), inet::sctp::SCTPAssociation::processPacketDropArrived(), inet::PacketDrillApp::runEvent(), inet::PacketDump::sctpDump(), inet::sctp::SCTP::sendAbortFromMain(), inet::sctp::SCTPAssociation::sendOnPath(), inet::sctp::SCTPAssociation::sendPacketDrop(), and inet::sctp::SCTPAssociation::storePacket().

{
    return chunkList.size();
}

virtual unsigned int inet::sctp::SCTPMessage::getDestinationPort ( ) const

inlineoverridevirtual

Implements inet::ITransportPacket.

{ return SCTPMessage_Base::getDestPort(); }

virtual unsigned int inet::sctp::SCTPMessage::getSourcePort ( ) const

inlineoverridevirtual

Implements inet::ITransportPacket.

{ return SCTPMessage_Base::getSrcPort(); }

SCTPMessage & inet::sctp::SCTPMessage::operator=

(

const SCTPMessage &

other

)

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

cPacket * inet::sctp::SCTPMessage::peekFirstChunk ( )

virtual

Referenced by inet::sctp::SCTPNatHook::datagramForwardHook(), inet::sctp::SCTPNatHook::datagramPreRoutingHook(), inet::PacketDrillApp::runEvent(), and inet::sctp::SCTPAssociation::sendToIP().

{
    if (chunkList.empty())
        return nullptr;

    cPacket *msg = chunkList.front();
    return msg;
}

cPacket * inet::sctp::SCTPMessage::peekLastChunk ( )

virtual

Referenced by inet::sctp::SCTPNatHook::datagramForwardHook(), and inet::sctp::SCTPNatHook::datagramPreRoutingHook().

{
    if (chunkList.empty())
        return nullptr;

    cPacket *msg = chunkList.back();
    return msg;
}

cPacket * inet::sctp::SCTPMessage::removeChunk ( )

virtual

Removes and returns the first message object in this SCTP packet.

Referenced by inet::PacketDrillApp::compareSctpPacket(), inet::sctp::SCTPNatHook::datagramPreRoutingHook(), inet::sctp::SCTPAssociation::disposeOf(), inet::sctp::SCTPAssociation::process_RCV_Message(), inet::sctp::SCTPAssociation::processPacketDropArrived(), and inet::sctp::SCTPAssociation::sendOnPath().

{
    if (chunkList.empty())
        return nullptr;

    cPacket *msg = chunkList.front();
    chunkList.erase(chunkList.begin());
    drop(msg);
    this->setByteLength(this->getByteLength() - ADD_PADDING(msg->getByteLength()));
    return msg;
}

cPacket * inet::sctp::SCTPMessage::removeLastChunk ( )

virtual

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

{
    if (chunkList.empty())
        return nullptr;

    cPacket *msg = chunkList.back();
    chunkList.pop_back();
    drop(msg);
    this->setByteLength(this->getByteLength() + ADD_PADDING(msg->getByteLength()));
    return msg;
}

void inet::sctp::SCTPMessage::replaceChunk ( cPacket *  msg, uint32  k  )

virtual

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

{
    chunkList[k] = msg;
}

void inet::sctp::SCTPMessage::setChunks ( uint32  k, const cPacketPtr &  chunks_var  )

overridevirtual

Generated but unused method, should not be called.

{
    throw new cException(this, "setChunks() not supported, use addChunk()");
}

void inet::sctp::SCTPMessage::setChunksArraySize ( uint32  size )

overridevirtual

Generated but unused method, should not be called.

{
    throw new cException(this, "setChunkArraySize() not supported, use addChunk()");
}

virtual void inet::sctp::SCTPMessage::setDestinationPort ( unsigned int  port )

inlineoverridevirtual

Implements inet::ITransportPacket.

{ SCTPMessage_Base::setDestPort(port); }

virtual void inet::sctp::SCTPMessage::setSourcePort ( unsigned int  port )

inlineoverridevirtual

Implements inet::ITransportPacket.

{ SCTPMessage_Base::setSrcPort(port); }

Member Data Documentation

std::vector<cPacket *> inet::sctp::SCTPMessage::chunkList

protected

Referenced by addChunk(), copy(), getChunks(), getChunksArraySize(), peekFirstChunk(), peekLastChunk(), removeChunk(), removeLastChunk(), and replaceChunk().

---

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

• SCTPMessage.h
• SCTPMessage.cc