inet::IPv6Datagram Class Reference

Represents an IPv6 datagram. More...

#include <IPv6Datagram.h>

Inheritance diagram for inet::IPv6Datagram:

Public Member Functions
	IPv6Datagram (const char *name=nullptr, int kind=0)
	IPv6Datagram (const IPv6Datagram &other)
IPv6Datagram &	operator= (const IPv6Datagram &other)
	~IPv6Datagram ()
virtual IPv6Datagram *	dup () const override
virtual int	getDiffServCodePoint () const override
	Returns bits 0-5 of the Traffic Class field, a value in the 0..63 range. More...
virtual void	setDiffServCodePoint (int dscp) override
	Sets bits 0-5 of the Traffic Class field; expects a value in the 0..63 range. More...
virtual int	getExplicitCongestionNotification () const override
	Returns bits 6-7 of the Traffic Class field, a value in the range 0..3. More...
virtual void	setExplicitCongestionNotification (int ecn) override
	Sets bits 6-7 of the Traffic Class field; expects a value in the 0..3 range. More...
virtual void	setExtensionHeaderArraySize (unsigned int size) override
	Generated but unused method, should not be called. More...
virtual void	setExtensionHeader (unsigned int k, const IPv6ExtensionHeaderPtr &extensionHeader_var) override
	Generated but unused method, should not be called. More...
virtual unsigned int	getExtensionHeaderArraySize () const override
	Returns the number of extension headers in this datagram. More...
virtual IPv6ExtensionHeaderPtr &	getExtensionHeader (unsigned int k) override
	Returns the kth extension header in this datagram. More...
virtual const IPv6ExtensionHeaderPtr &	getExtensionHeader (unsigned int k) const override
virtual IPv6ExtensionHeader *	findExtensionHeaderByType (IPProtocolId extensionType, int index=0) const
	Returns the extension header of the specified type, or nullptr. More...
virtual void	addExtensionHeader (IPv6ExtensionHeader *eh, int atPos=-1)
	Adds an extension header to the datagram. More...
virtual int	calculateHeaderByteLength () const
	Calculates the length of the IPv6 header plus the extension headers. More...
virtual int	calculateUnfragmentableHeaderByteLength () const
	Calculates the length of the unfragmentable part of IPv6 header plus the extension headers. More...
virtual int	calculateFragmentLength () const
	Calculates the length of the payload and extension headers after the Fragment Header. More...
virtual IPv6ExtensionHeader *	removeFirstExtensionHeader ()
	Removes and returns the first extension header of this datagram. More...
virtual IPv6ExtensionHeader *	removeExtensionHeader (IPProtocolId extensionType)
	Removes and returns the first extension header with the given type. More...
virtual L3Address	getSourceAddress () const override
virtual void	setSourceAddress (const L3Address &address) override
virtual L3Address	getDestinationAddress () const override
virtual void	setDestinationAddress (const L3Address &address) override
virtual int	getTransportProtocol () const override
virtual void	setTransportProtocol (int protocol) override
Public Member Functions inherited from inet::IPv6Datagram_Base
virtual	~IPv6Datagram_Base ()
virtual void	parsimPack (omnetpp::cCommBuffer *b) const override
virtual void	parsimUnpack (omnetpp::cCommBuffer *b) override
virtual IPv6Address &	getSrcAddress ()
virtual const IPv6Address &	getSrcAddress () const
virtual void	setSrcAddress (const IPv6Address &srcAddress)
virtual IPv6Address &	getDestAddress ()
virtual const IPv6Address &	getDestAddress () const
virtual void	setDestAddress (const IPv6Address &destAddress)
virtual unsigned char	getTrafficClass () const
virtual void	setTrafficClass (unsigned char trafficClass)
virtual unsigned int	getFlowLabel () const
virtual void	setFlowLabel (unsigned int flowLabel)
virtual short	getHopLimit () const
virtual void	setHopLimit (short hopLimit)
Public Member Functions inherited from inet::INetworkDatagram
virtual	~INetworkDatagram ()

Protected Types
typedef std::vector< IPv6ExtensionHeader * >	ExtensionHeaders

Protected Attributes
ExtensionHeaders	extensionHeaders
Protected Attributes inherited from inet::IPv6Datagram_Base
IPv6Address	srcAddress
IPv6Address	destAddress
unsigned char	trafficClass
unsigned int	flowLabel
short	hopLimit
int	transportProtocol

Private Member Functions
void	copy (const IPv6Datagram &other)
void	clean ()
int	getExtensionHeaderOrder (IPv6ExtensionHeader *eh)

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

Detailed Description

Represents an IPv6 datagram.

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

Member Typedef Documentation

typedef std::vector<IPv6ExtensionHeader *> inet::IPv6Datagram::ExtensionHeaders

protected

Constructor & Destructor Documentation

inet::IPv6Datagram::IPv6Datagram ( const char *  name = nullptr, int  kind = 0  )

inline

: IPv6Datagram_Base(name, kind) {}

inet::IPv6Datagram::IPv6Datagram ( const IPv6Datagram &  other )

inline

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

inet::IPv6Datagram::~IPv6Datagram

(

)

{
    clean();
}

Member Function Documentation

void inet::IPv6Datagram::addExtensionHeader ( IPv6ExtensionHeader *  eh, int  atPos = -1  )

virtual

Adds an extension header to the datagram.

The atPos parameter should not be used, the extension headers are stored in the order specified in RFC 2460 4.1.

Referenced by copy(), inet::IPv6::encapsulate(), inet::IPv6::fragmentAndSend(), and inet::GPSR::setGpsrOptionOnNetworkDatagram().

{
    if (atPos != -1)
        throw cRuntimeError(this, "addExtensionHeader() does not support atPos parameter.");
    ASSERT((eh->getByteLength() >= 1) && (eh->getByteLength() % 8 == 0));
    int thisOrder = getExtensionHeaderOrder(eh);
    unsigned int i;
    for (i = 0; i < extensionHeaders.size(); i++) {
        int thatOrder = getExtensionHeaderOrder(extensionHeaders[i]);
        if (thisOrder != -1 && thatOrder > thisOrder)
            break;
        else if (thisOrder == thatOrder) {
            if (thisOrder == 1)
                thisOrder = 6;
            else if (thisOrder != -1)
                throw cRuntimeError(this, "addExtensionHeader() duplicate extension header: %d",
                        eh->getExtensionType());
        }
    }

    // insert at position atPos, shift up the rest of the array
    extensionHeaders.insert(extensionHeaders.begin() + i, eh);
}

int inet::IPv6Datagram::calculateFragmentLength ( ) const

virtual

Calculates the length of the payload and extension headers after the Fragment Header.

Note: it is assumed that headers are ordered as described in RFC 2460 4.1.

Referenced by inet::IPv6FragBuf::addFragment().

{
    int len = getByteLength() - IPv6_HEADER_BYTES;
    unsigned int i;
    for (i = 0; i < extensionHeaders.size(); i++) {
        len -= extensionHeaders[i]->getByteLength();
        if (extensionHeaders[i]->getExtensionType() == IP_PROT_IPv6EXT_FRAGMENT)
            break;
    }
    ASSERT2(i < extensionHeaders.size(), "IPv6Datagram::calculateFragmentLength() called on non-fragment datagram");
    return len;
}

int inet::IPv6Datagram::calculateHeaderByteLength ( ) const

virtual

Calculates the length of the IPv6 header plus the extension headers.

Referenced by inet::IPv6::encapsulate(), and inet::GPSR::setGpsrOptionOnNetworkDatagram().

{
    int len = 40;
    for (auto & elem : extensionHeaders)
        len += elem->getByteLength();
    return len;
}

int inet::IPv6Datagram::calculateUnfragmentableHeaderByteLength ( ) const

virtual

Calculates the length of the unfragmentable part of IPv6 header plus the extension headers.

Note: it is assumed that headers are ordered as described in RFC 2460 4.1.

Referenced by inet::IPv6FragBuf::addFragment(), and inet::IPv6::fragmentAndSend().

{
    int lastUnfragmentableExtensionIndex = -1;
    for (int i = ((int)extensionHeaders.size()) - 1; i >= 0; i--) {
        int type = extensionHeaders[i]->getExtensionType();
        if (type == IP_PROT_IPv6EXT_ROUTING || type == IP_PROT_IPv6EXT_HOP) {
            lastUnfragmentableExtensionIndex = i;
            break;
        }
    }

    int len = 40;
    for (int i = 0; i <= lastUnfragmentableExtensionIndex; i++)
        len += extensionHeaders[i]->getByteLength();
    return len;
}

void inet::IPv6Datagram::clean ( )

private

Referenced by operator=(), and ~IPv6Datagram().

{
    IPv6ExtensionHeaderPtr eh;

    while (!extensionHeaders.empty()) {
        eh = extensionHeaders.back();
        extensionHeaders.pop_back();    // remove pointer element from container
        delete eh;    // delete the header
    }
}

void inet::IPv6Datagram::copy ( const IPv6Datagram &  other )

private

Referenced by operator=().

{
    for (const auto & elem : other.extensionHeaders)
        addExtensionHeader((elem)->dup());
}

virtual IPv6Datagram* inet::IPv6Datagram::dup ( ) const

inlineoverridevirtual

Reimplemented from inet::IPv6Datagram_Base.

Referenced by copy(), inet::IPv6ControlInfo::copy(), inet::IPv6::fragmentAndSend(), and inet::IPv6::routeMulticastPacket().

{ return new IPv6Datagram(*this); }

IPv6ExtensionHeader * inet::IPv6Datagram::findExtensionHeaderByType ( IPProtocolId  extensionType, int  index = 0  ) const

virtual

Returns the extension header of the specified type, or nullptr.

If index is 0, then the first, if 1 then the second extension is returned. (The datagram might contain two Destination Options extension.)

Referenced by inet::GPSR::findGpsrOptionInNetworkDatagram(), inet::IPv6::localDeliver(), inet::UDP::processICMPError(), and inet::GPSR::setGpsrOptionOnNetworkDatagram().

{
    for (const auto & elem : extensionHeaders)
        if ((elem)->getExtensionType() == extensionType) {
            if (index == 0)
                return elem;
            else
                index--;
        }
    return nullptr;
}

virtual L3Address inet::IPv6Datagram::getDestinationAddress ( ) const

inlineoverridevirtual

Implements inet::INetworkDatagram.

{ return L3Address(getDestAddress()); }

virtual int inet::IPv6Datagram::getDiffServCodePoint ( ) const

inlineoverridevirtual

Returns bits 0-5 of the Traffic Class field, a value in the 0..63 range.

Implements inet::IPv6Datagram_Base.

Referenced by inet::BehaviorAggregateClassifier::getDscpFromPacket().

{ return getTrafficClass() & 0x3f; }

virtual int inet::IPv6Datagram::getExplicitCongestionNotification ( ) const

inlineoverridevirtual

Returns bits 6-7 of the Traffic Class field, a value in the range 0..3.

Implements inet::IPv6Datagram_Base.

{ return (getTrafficClass() >> 6) & 0x03; }

IPv6ExtensionHeaderPtr & inet::IPv6Datagram::getExtensionHeader ( unsigned int  k )

overridevirtual

Returns the kth extension header in this datagram.

Implements inet::IPv6Datagram_Base.

Referenced by inet::serializer::IPv6Serializer::serialize().

{
    static IPv6ExtensionHeaderPtr null;
    if (k >= extensionHeaders.size())
        return null = nullptr;
    return extensionHeaders[k];
}

virtual const IPv6ExtensionHeaderPtr& inet::IPv6Datagram::getExtensionHeader ( unsigned int  k ) const

inlineoverridevirtual

Reimplemented from inet::IPv6Datagram_Base.

Referenced by getExtensionHeader().

{return const_cast<IPv6Datagram*>(this)->getExtensionHeader(k);}

unsigned int inet::IPv6Datagram::getExtensionHeaderArraySize ( ) const

overridevirtual

Returns the number of extension headers in this datagram.

Implements inet::IPv6Datagram_Base.

Referenced by inet::IPv6::processExtensionHeaders(), inet::IPv6::routePacket(), and inet::serializer::IPv6Serializer::serialize().

{
    return extensionHeaders.size();
}

int inet::IPv6Datagram::getExtensionHeaderOrder ( IPv6ExtensionHeader *  eh )

private

Referenced by addExtensionHeader().

{
    switch (eh->getExtensionType()) {
        case IP_PROT_IPv6EXT_HOP:
            return 0;

        case IP_PROT_IPv6EXT_DEST:
            return 1;

        case IP_PROT_IPv6EXT_ROUTING:
            return 2;

        case IP_PROT_IPv6EXT_FRAGMENT:
            return 3;

        case IP_PROT_IPv6EXT_AUTH:
            return 4;

        case IP_PROT_IPv6EXT_ESP:
            return 5;

        // second IP_PROT_IPv6EXT_DEST has order 6
        case IP_PROT_IPv6EXT_MOB:
            return 7;

        default:
            return -1;
    }
}

virtual L3Address inet::IPv6Datagram::getSourceAddress ( ) const

inlineoverridevirtual

Implements inet::INetworkDatagram.

{ return L3Address(getSrcAddress()); }

virtual int inet::IPv6Datagram::getTransportProtocol ( ) const

inlineoverridevirtual

Implements inet::INetworkDatagram.

Referenced by inet::IPv6::decapsulate(), inet::IPv6Tunneling::decapsulateDatagram(), inet::IPv6Tunneling::encapsulateDatagram(), inet::IPv6::handleReceivedICMP(), inet::IPv6::localDeliver(), inet::MultiFieldClassifier::Filter::matches(), inet::IPv6::routePacket(), inet::serializer::IPv6Serializer::serialize(), and inet::ICMPv6::validateDatagramPromptingError().

{ return IPv6Datagram_Base::getTransportProtocol(); }

IPv6Datagram & inet::IPv6Datagram::operator=

(

const IPv6Datagram &

other

)

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

IPv6ExtensionHeader * inet::IPv6Datagram::removeExtensionHeader ( IPProtocolId  extensionType )

virtual

Removes and returns the first extension header with the given type.

Referenced by inet::IPv6FragBuf::addFragment().

{
    for (unsigned int i = 0; i < extensionHeaders.size(); i++) {
        if (extensionHeaders[i]->getExtensionType() == extensionType) {
            IPv6ExtensionHeader *eh = extensionHeaders[i];
            extensionHeaders.erase(extensionHeaders.begin() + i);
            return eh;
        }
    }
    return nullptr;
}

IPv6ExtensionHeader * inet::IPv6Datagram::removeFirstExtensionHeader ( )

virtual

Removes and returns the first extension header of this datagram.

Referenced by inet::IPv6::processExtensionHeaders().

{
    if (extensionHeaders.empty())
        return nullptr;
    IPv6ExtensionHeader *eh = extensionHeaders.front();
    extensionHeaders.erase(extensionHeaders.begin());
    return eh;
}

virtual void inet::IPv6Datagram::setDestinationAddress ( const L3Address &  address )

inlineoverridevirtual

Implements inet::INetworkDatagram.

{ setDestAddress(address.toIPv6()); }

virtual void inet::IPv6Datagram::setDiffServCodePoint ( int  dscp )

inlineoverridevirtual

Sets bits 0-5 of the Traffic Class field; expects a value in the 0..63 range.

Implements inet::IPv6Datagram_Base.

Referenced by inet::DSCPMarker::markPacket().

{ setTrafficClass((getTrafficClass() & 0xc0) | (dscp & 0x3f)); }

virtual void inet::IPv6Datagram::setExplicitCongestionNotification ( int  ecn )

inlineoverridevirtual

Sets bits 6-7 of the Traffic Class field; expects a value in the 0..3 range.

Implements inet::IPv6Datagram_Base.

{ setTrafficClass((getTrafficClass() & 0x3f) | ((ecn & 0x3) << 6)); }

void inet::IPv6Datagram::setExtensionHeader ( unsigned int  k, const IPv6ExtensionHeaderPtr &  extensionHeader_var  )

overridevirtual

Generated but unused method, should not be called.

Implements inet::IPv6Datagram_Base.

{
    throw cRuntimeError(this, "setExtensionHeader() not supported, use addExtensionHeader()");
}

void inet::IPv6Datagram::setExtensionHeaderArraySize ( unsigned int  size )

overridevirtual

Generated but unused method, should not be called.

Implements inet::IPv6Datagram_Base.

{
    throw cRuntimeError(this, "setExtensionHeaderArraySize() not supported, use addExtensionHeader()");
}

virtual void inet::IPv6Datagram::setSourceAddress ( const L3Address &  address )

inlineoverridevirtual

Implements inet::INetworkDatagram.

{ setSrcAddress(address.toIPv6()); }

virtual void inet::IPv6Datagram::setTransportProtocol ( int  protocol )

inlineoverridevirtual

Implements inet::INetworkDatagram.

Referenced by inet::IPv6::encapsulate().

{ IPv6Datagram_Base::setTransportProtocol(protocol); }

Member Data Documentation

ExtensionHeaders inet::IPv6Datagram::extensionHeaders

protected

Referenced by addExtensionHeader(), calculateFragmentLength(), calculateHeaderByteLength(), calculateUnfragmentableHeaderByteLength(), clean(), copy(), findExtensionHeaderByType(), getExtensionHeader(), getExtensionHeaderArraySize(), removeExtensionHeader(), and removeFirstExtensionHeader().

---

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

• IPv6Datagram.h
• IPv6Datagram.cc