inet::IPv4ControlInfo Class Reference

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

#include <IPv4ControlInfo.h>

Inheritance diagram for inet::IPv4ControlInfo:

Public Member Functions
	IPv4ControlInfo ()
virtual	~IPv4ControlInfo ()
	IPv4ControlInfo (const IPv4ControlInfo &other)
IPv4ControlInfo &	operator= (const IPv4ControlInfo &other)
virtual IPv4ControlInfo *	dup () const override
virtual int	getDiffServCodePoint () const override
	Returns bits 0-5 of the Type of Service field, a value in the 0..63 range. More...
virtual void	setDiffServCodePoint (int dscp) override
	Sets bits 0-5 of the Type of Service field; expects a value in the 0..63 range. More...
virtual int	getExplicitCongestionNotification () const override
	Returns bits 6-7 of the Type of Service field, a value in the range 0..3. More...
virtual void	setExplicitCongestionNotification (int ecn) override
	Sets bits 6-7 of the Type of Service; expects a value in the 0..3 range. More...
virtual void	setOrigDatagram (IPv4Datagram *d)
virtual IPv4Datagram *	getOrigDatagram () const
virtual IPv4Datagram *	removeOrigDatagram ()
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::IPv4ControlInfo_Base
virtual	~IPv4ControlInfo_Base ()
virtual void	parsimPack (omnetpp::cCommBuffer *b) const override
virtual void	parsimUnpack (omnetpp::cCommBuffer *b) override
virtual IPv4Address &	getDestAddr ()
virtual const IPv4Address &	getDestAddr () const
virtual void	setDestAddr (const IPv4Address &destAddr)
virtual IPv4Address &	getSrcAddr ()
virtual const IPv4Address &	getSrcAddr () const
virtual void	setSrcAddr (const IPv4Address &srcAddr)
virtual bool	getMulticastLoop () const
virtual void	setMulticastLoop (bool multicastLoop)
virtual short	getProtocol () const
virtual void	setProtocol (short protocol)
virtual unsigned char	getTypeOfService () const
virtual void	setTypeOfService (unsigned char typeOfService)
virtual short	getTimeToLive () const
virtual void	setTimeToLive (short timeToLive)
virtual bool	getDontFragment () const
virtual void	setDontFragment (bool dontFragment)
Public Member Functions inherited from inet::INetworkProtocolControlInfo
virtual	~INetworkProtocolControlInfo ()

Protected Attributes
IPv4Datagram *	dgram
Protected Attributes inherited from inet::IPv4ControlInfo_Base
IPv4Address	destAddr
IPv4Address	srcAddr
int	interfaceId
bool	multicastLoop
short	protocol
unsigned char	typeOfService
short	timeToLive
bool	dontFragment

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

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

Detailed Description

Control information for sending/receiving packets over IPv4.

See the IPv4ControlInfo.msg file for more info.

Constructor & Destructor Documentation

inet::IPv4ControlInfo::IPv4ControlInfo ( )

inline

: IPv4ControlInfo_Base() { dgram = nullptr; }

inet::IPv4ControlInfo::~IPv4ControlInfo ( )

virtual

{
    clean();
}

inet::IPv4ControlInfo::IPv4ControlInfo ( const IPv4ControlInfo &  other )

inline

: IPv4ControlInfo_Base(other) { dgram = nullptr; copy(other); }

Member Function Documentation

void inet::IPv4ControlInfo::clean ( )

private

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

{
#ifdef WITH_IPv4
    dropAndDelete(dgram);
#else // ifdef WITH_IPv4
    if (dgram)
        throw cRuntimeError("INET was compiled without IPv4 support");
#endif // ifdef WITH_IPv4
}

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

private

Referenced by operator=().

{
    dgram = other.dgram;

    if (dgram) {
#ifdef WITH_IPv4
        dgram = dgram->dup();
        take(dgram);
#else // ifdef WITH_IPv4
        throw cRuntimeError(this, "INET was compiled without IPv4 support");
#endif // ifdef WITH_IPv4
    }
}

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

inlineoverridevirtual

Reimplemented from inet::IPv4ControlInfo_Base.

{ return new IPv4ControlInfo(*this); }

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

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

{ return L3Address(destAddr); }

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

inlineoverridevirtual

Returns bits 0-5 of the Type of Service field, a value in the 0..63 range.

Implements inet::IPv4ControlInfo_Base.

{ return getTypeOfService() & 0x3f; }

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

inlineoverridevirtual

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

Implements inet::IPv4ControlInfo_Base.

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

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

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

{ return getTimeToLive(); }

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

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

Referenced by inet::IPv4::handlePacketFromHL(), inet::PIMDM::processAssertPacket(), inet::PIMSM::processAssertPacket(), inet::PIMDM::processGraftPacket(), inet::PIMBase::processHelloPacket(), inet::IGMPv2::processIgmpMessage(), inet::PIMDM::processJoinPrunePacket(), inet::PIMSM::processJoinPrunePacket(), inet::ospf::MessageHandler::processPacket(), inet::PIMSplitter::processPIMPacket(), inet::IGMPv3::processQuery(), inet::IGMPv3::processReport(), inet::PIMDM::processStateRefreshPacket(), inet::UDP::processUDPPacket(), inet::ICMP::sendErrorMessage(), and inet::PIMDM::sendGraftAckPacket().

{ return IPv4ControlInfo_Base::getInterfaceId(); }

virtual IPv4Datagram* inet::IPv4ControlInfo::getOrigDatagram ( ) const

inlinevirtual

{ return dgram; }

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

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

{ return L3Address(srcAddr); }

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

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

{ return IPv4ControlInfo_Base::getProtocol(); }

IPv4ControlInfo & inet::IPv4ControlInfo::operator=

(

const IPv4ControlInfo &

other

)

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

IPv4Datagram * inet::IPv4ControlInfo::removeOrigDatagram ( )

virtual

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

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

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

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

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

{ destAddr = address.toIPv4(); }

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

inlineoverridevirtual

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

Implements inet::IPv4ControlInfo_Base.

{ setTypeOfService((getTypeOfService() & 0xc0) | (dscp & 0x3f)); }

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

inlineoverridevirtual

Sets bits 6-7 of the Type of Service; expects a value in the 0..3 range.

Implements inet::IPv4ControlInfo_Base.

{ setTypeOfService((getTypeOfService() & 0x3f) | ((ecn & 0x3) << 6)); }

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

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

{ setTimeToLive(hopLimit); }

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

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

Referenced by inet::IPv4::decapsulate(), inet::PIMSM::forwardMulticastData(), inet::ICMP::processEchoRequest(), inet::UDP::sendDown(), inet::PIMBase::sendHelloPacket(), inet::ospf::MessageHandler::sendPacket(), inet::PIMDM::sendToIP(), and inet::PIMSM::sendToIP().

{ IPv4ControlInfo_Base::setInterfaceId(interfaceId); }

void inet::IPv4ControlInfo::setOrigDatagram ( IPv4Datagram *  d )

virtual

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

{
#ifdef WITH_IPv4
    if (dgram)
        throw cRuntimeError(this, "IPv4ControlInfo::setOrigDatagram(): a datagram is already attached");
    dgram = d;
    take(dgram);
#else // ifdef WITH_IPv4
    throw cRuntimeError(this, "INET was compiled without IPv4 support");
#endif // ifdef WITH_IPv4
}

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

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

{ srcAddr = address.toIPv4(); }

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

inlineoverridevirtual

Implements inet::INetworkProtocolControlInfo.

{ IPv4ControlInfo_Base::setProtocol(protocol); }

Member Data Documentation

IPv4Datagram* inet::IPv4ControlInfo::dgram

protected

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

---

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

• IPv4ControlInfo.h
• IPv4ControlInfo.cc