inet::IPv6ControlInfo Class Reference

Control information for sending/receiving packets over IPv6. More...

#include <IPv6ControlInfo.h>

Inheritance diagram for inet::IPv6ControlInfo:

Public Member Functions
	IPv6ControlInfo ()
virtual	~IPv6ControlInfo ()
	IPv6ControlInfo (const IPv6ControlInfo &other)
IPv6ControlInfo &	operator= (const IPv6ControlInfo &other)
virtual IPv6ControlInfo *	dup () const override
virtual void	setOrigDatagram (IPv6Datagram *d)
virtual IPv6Datagram *	getOrigDatagram () const
virtual IPv6Datagram *	removeOrigDatagram ()
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 unsigned int	getExtensionHeaderArraySize () const override
	Returns the number of extension headers in this datagram. More...
virtual void	setExtensionHeaderArraySize (unsigned int size) override
	Generated but unused method, should not be called. More...
virtual IPv6ExtensionHeaderPtr &	getExtensionHeader (unsigned int k) override
	Returns the kth extension header in this datagram. More...
virtual void	setExtensionHeader (unsigned int k, const IPv6ExtensionHeaderPtr &extensionHeader_var) override
	Generated but unused method, should not be called. More...
virtual void	addExtensionHeader (IPv6ExtensionHeader *eh, int atPos=-1)
	Adds an extension header to the datagram, at the given position. More...
IPv6ExtensionHeader *	removeFirstExtensionHeader ()
	Remove the first extension header and return it. More...
virtual short	getTransportProtocol () const override
virtual void	setTransportProtocol (short protocol) override
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	getInterfaceId () const override
virtual void	setInterfaceId (int interfaceId) override
virtual short	getHopLimit () const override
virtual void	setHopLimit (short hopLimit) override
Public Member Functions inherited from inet::IPv6ControlInfo_Base
virtual	~IPv6ControlInfo_Base ()
virtual void	parsimPack (omnetpp::cCommBuffer *b) const override
virtual void	parsimUnpack (omnetpp::cCommBuffer *b) override
virtual short	getProtocol () const
virtual void	setProtocol (short protocol)
virtual IPv6Address &	getDestAddr ()
virtual const IPv6Address &	getDestAddr () const
virtual void	setDestAddr (const IPv6Address &destAddr)
virtual IPv6Address &	getSrcAddr ()
virtual const IPv6Address &	getSrcAddr () const
virtual void	setSrcAddr (const IPv6Address &srcAddr)
virtual unsigned char	getTrafficClass () const
virtual void	setTrafficClass (unsigned char trafficClass)
virtual bool	getMulticastLoop () const
virtual void	setMulticastLoop (bool multicastLoop)
virtual const IPv6ExtensionHeaderPtr &	getExtensionHeader (unsigned int k) const
Public Member Functions inherited from inet::INetworkProtocolControlInfo
virtual	~INetworkProtocolControlInfo ()

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

Protected Attributes
IPv6Datagram *	dgram
ExtensionHeaders	extensionHeaders
Protected Attributes inherited from inet::IPv6ControlInfo_Base
short	protocol
IPv6Address	destAddr
IPv6Address	srcAddr
unsigned char	trafficClass
short	hopLimit
int	interfaceId
bool	multicastLoop

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

Additional Inherited Members
Protected Member Functions inherited from inet::IPv6ControlInfo_Base
bool	operator== (const IPv6ControlInfo_Base &)
	IPv6ControlInfo_Base ()
	IPv6ControlInfo_Base (const IPv6ControlInfo_Base &other)
IPv6ControlInfo_Base &	operator= (const IPv6ControlInfo_Base &other)

Detailed Description

Control information for sending/receiving packets over IPv6.

See the IPv6ControlInfo.msg file for more info.

Member Typedef Documentation

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

protected

Constructor & Destructor Documentation

inet::IPv6ControlInfo::IPv6ControlInfo ( )

inline

: IPv6ControlInfo_Base() { dgram = nullptr; }

inet::IPv6ControlInfo::~IPv6ControlInfo ( )

virtual

{
    clean();
}

inet::IPv6ControlInfo::IPv6ControlInfo ( const IPv6ControlInfo &  other )

inline

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

Member Function Documentation

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

virtual

Adds an extension header to the datagram, at the given position.

The default (atPos==-1) is to add the header at the end.

Referenced by inet::IPv6Tunneling::encapsulateDatagram().

{
#ifdef WITH_IPv6
    ASSERT(eh);
    if (atPos < 0 || (ExtensionHeaders::size_type)atPos >= extensionHeaders.size()) {
        extensionHeaders.push_back(eh);
        return;
    }

    // insert at position atPos, shift up the rest of the array
    extensionHeaders.insert(extensionHeaders.begin() + atPos, eh);
#else // ifdef WITH_IPv6
    throw cRuntimeError(this, "INET was compiled without IPv6 support");
#endif // ifdef WITH_IPv6
}

void inet::IPv6ControlInfo::clean ( )

private

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

{
#ifdef WITH_IPv6
    dropAndDelete(dgram);

    while (!extensionHeaders.empty()) {
        IPv6ExtensionHeader *eh = extensionHeaders.back();
        extensionHeaders.pop_back();
        delete eh;
    }
#endif // ifdef WITH_IPv6
}

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

private

Referenced by operator=().

{
#ifdef WITH_IPv6
    dgram = other.dgram;
    if (dgram) {
        dgram = dgram->dup();
        take(dgram);
    }

    for (const auto & elem : other.extensionHeaders)
        extensionHeaders.push_back((elem)->dup());
#endif // ifdef WITH_IPv6
}

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

inlineoverridevirtual

Reimplemented from inet::IPv6ControlInfo_Base.

Referenced by copy().

{ return new IPv6ControlInfo(*this); }

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

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

{ return L3Address(destAddr); }

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

inlineoverridevirtual

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

Implements inet::IPv6ControlInfo_Base.

{ return getTrafficClass() & 0x3f; }

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

inlineoverridevirtual

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

Implements inet::IPv6ControlInfo_Base.

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

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

overridevirtual

Returns the kth extension header in this datagram.

Implements inet::IPv6ControlInfo_Base.

{
    ASSERT(k < extensionHeaders.size());
    return extensionHeaders[k];
}

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

overridevirtual

Returns the number of extension headers in this datagram.

Implements inet::IPv6ControlInfo_Base.

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

{
    return extensionHeaders.size();
}

virtual short inet::IPv6ControlInfo::getHopLimit ( ) const

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

Referenced by inet::IPv6::encapsulate(), inet::UDP::processUDPPacket(), inet::IPv6NeighbourDiscovery::validateNAPacket(), inet::IPv6NeighbourDiscovery::validateNSPacket(), inet::IPv6NeighbourDiscovery::validateRAPacket(), and inet::IPv6NeighbourDiscovery::validateRSPacket().

{ return IPv6ControlInfo_Base::getHopLimit(); }

virtual int inet::IPv6ControlInfo::getInterfaceId ( ) const

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

Referenced by inet::xMIPv6::createAndSendBAMessage(), inet::IPv6Tunneling::decapsulateDatagram(), inet::IPv6::handleMessageFromHL(), inet::xMIPv6::processBAMessage(), inet::xMIPv6::processBRRMessage(), inet::xMIPv6::processBUMessage(), inet::xMIPv6::processCoTMessage(), inet::ICMPv6::processEchoRequest(), inet::xMIPv6::processHoTMessage(), inet::IPv6NeighbourDiscovery::processNAPacket(), inet::IPv6NeighbourDiscovery::processNSPacket(), inet::IPv6NeighbourDiscovery::processRAForRouterUpdates(), inet::IPv6NeighbourDiscovery::processRAPacket(), inet::IPv6NeighbourDiscovery::processRSPacket(), inet::UDP::processUDPPacket(), inet::xMIPv6::sendMobilityMessageToIPv6Module(), inet::xMIPv6::validateBAck(), and inet::xMIPv6::validateCoTMessage().

{ return IPv6ControlInfo_Base::getInterfaceId(); }

virtual IPv6Datagram* inet::IPv6ControlInfo::getOrigDatagram ( ) const

inlinevirtual

{ return dgram; }

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

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

{ return L3Address(srcAddr); }

virtual short inet::IPv6ControlInfo::getTransportProtocol ( ) const

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

{ return IPv6ControlInfo_Base::getProtocol(); }

IPv6ControlInfo & inet::IPv6ControlInfo::operator=

(

const IPv6ControlInfo &

other

)

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

IPv6ExtensionHeader * inet::IPv6ControlInfo::removeFirstExtensionHeader

(

)

Remove the first extension header and return it.

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

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

#ifdef WITH_IPv6
    auto first = extensionHeaders.begin();
    IPv6ExtensionHeader *ret = *first;
    extensionHeaders.erase(first);
    return ret;
#else // ifdef WITH_IPv6
    throw cRuntimeError(this, "INET was compiled without IPv6 support");
#endif // ifdef WITH_IPv6
}

IPv6Datagram * inet::IPv6ControlInfo::removeOrigDatagram ( )

virtual

Referenced by inet::ICMPv6::sendErrorMessage().

{
#ifdef WITH_IPv6
    if (!dgram)
        throw cRuntimeError(this, "IPv6ControlInfo::removeOrigDatagram(): no datagram attached "
                                  "(already removed, or maybe this IPv6ControlInfo does not come "
                                  "from the IPv6 module?)");

    IPv6Datagram *ret = dgram;
    drop(dgram);
    dgram = nullptr;
    return ret;
#else // ifdef WITH_IPv6
    throw cRuntimeError(this, "INET was compiled without IPv6 support");
#endif // ifdef WITH_IPv6
}

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

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

{ destAddr = address.toIPv6(); }

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

inlineoverridevirtual

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

Implements inet::IPv6ControlInfo_Base.

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

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

inlineoverridevirtual

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

Implements inet::IPv6ControlInfo_Base.

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

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

overridevirtual

Generated but unused method, should not be called.

Implements inet::IPv6ControlInfo_Base.

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

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

overridevirtual

Generated but unused method, should not be called.

Implements inet::IPv6ControlInfo_Base.

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

virtual void inet::IPv6ControlInfo::setHopLimit ( short  hopLimit )

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

Referenced by inet::IPv6::decapsulate(), inet::UDP::sendDown(), inet::xMIPv6::sendMobilityMessageToIPv6Module(), and inet::IPv6NeighbourDiscovery::sendPacketToIPv6Module().

{ IPv6ControlInfo_Base::setHopLimit(hopLimit); }

virtual void inet::IPv6ControlInfo::setInterfaceId ( int  interfaceId )

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

Referenced by inet::IPv6::decapsulate(), inet::IPv6Tunneling::encapsulateDatagram(), inet::UDP::sendDown(), inet::xMIPv6::sendMobilityMessageToIPv6Module(), and inet::IPv6NeighbourDiscovery::sendPacketToIPv6Module().

{ IPv6ControlInfo_Base::setInterfaceId(interfaceId); }

void inet::IPv6ControlInfo::setOrigDatagram ( IPv6Datagram *  d )

virtual

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

{
#ifdef WITH_IPv6
    if (dgram)
        throw cRuntimeError(this, "IPv6ControlInfo::setOrigDatagram(): a datagram is already attached");

    dgram = d;
    take(dgram);
#else // ifdef WITH_IPv6
    throw cRuntimeError("INET was compiled without IPv6 support");
#endif // ifdef WITH_IPv6
}

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

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

{ srcAddr = address.toIPv6(); }

virtual void inet::IPv6ControlInfo::setTransportProtocol ( short  protocol )

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

{ IPv6ControlInfo_Base::setProtocol(protocol); }

Member Data Documentation

IPv6Datagram* inet::IPv6ControlInfo::dgram

protected

Referenced by clean(), copy(), removeOrigDatagram(), and setOrigDatagram().

ExtensionHeaders inet::IPv6ControlInfo::extensionHeaders

protected

Referenced by addExtensionHeader(), clean(), copy(), getExtensionHeader(), getExtensionHeaderArraySize(), and removeFirstExtensionHeader().

---

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

• IPv6ControlInfo.h
• IPv6ControlInfo.cc