Class generated from inet/networklayer/ipv4/IPv4Datagram.msg:174 by nedtool. More...

#include <IPv4Datagram_m.h>

Inheritance diagram for inet::IPv4Datagram_Base:

Public Member Functions
virtual	~IPv4Datagram_Base ()

virtual IPv4Datagram_Base *	dup () const override

virtual void	parsimPack (omnetpp::cCommBuffer *b) const override

virtual void	parsimUnpack (omnetpp::cCommBuffer *b) override

virtual short	getVersion () const

virtual void	setVersion (short version)

virtual short	getHeaderLength () const

virtual void	setHeaderLength (short headerLength)

virtual IPv4Address &	getSrcAddress ()

virtual const IPv4Address &	getSrcAddress () const

virtual void	setSrcAddress (const IPv4Address &srcAddress)

virtual IPv4Address &	getDestAddress ()

virtual const IPv4Address &	getDestAddress () const

virtual void	setDestAddress (const IPv4Address &destAddress)

virtual int	getTransportProtocol () const

virtual void	setTransportProtocol (int transportProtocol)

virtual short	getTimeToLive () const

virtual void	setTimeToLive (short timeToLive)

virtual int	getIdentification () const

virtual void	setIdentification (int identification)

virtual bool	getMoreFragments () const

virtual void	setMoreFragments (bool moreFragments)

virtual bool	getDontFragment () const

virtual void	setDontFragment (bool dontFragment)

virtual int	getFragmentOffset () const

virtual void	setFragmentOffset (int fragmentOffset)

virtual int	getTotalLengthField () const

virtual void	setTotalLengthField (int totalLengthField)

virtual unsigned char	getTypeOfService () const

virtual void	setTypeOfService (unsigned char typeOfService)

virtual int	getDiffServCodePoint () const =0

virtual void	setDiffServCodePoint (int diffServCodePoint)=0

virtual int	getExplicitCongestionNotification () const =0

virtual void	setExplicitCongestionNotification (int explicitCongestionNotification)=0

virtual TLVOptions &	getOptions ()

virtual const TLVOptions &	getOptions () const

virtual void	setOptions (const TLVOptions &options)

Protected Member Functions
bool	operator== (const IPv4Datagram_Base &)

	IPv4Datagram_Base (const char *name=nullptr, short kind=0)

	IPv4Datagram_Base (const IPv4Datagram_Base &other)

IPv4Datagram_Base &	operator= (const IPv4Datagram_Base &other)

Protected Attributes
short	version

short	headerLength

IPv4Address	srcAddress

IPv4Address	destAddress

int	transportProtocol

short	timeToLive

int	identification

bool	moreFragments

bool	dontFragment

int	fragmentOffset

int	totalLengthField

unsigned char	typeOfService

TLVOptions	options

Private Member Functions
void	copy (const IPv4Datagram_Base &other)

Detailed Description

Class generated from inet/networklayer/ipv4/IPv4Datagram.msg:174 by nedtool.

//
// Represents an IPv4 datagram.
//
// Uses the following cPacket fields:
//    - getByteLength() / setByteLength() to represent total datagram length
//    - hasBitError() / setBitError() to represent datagram correctness
//    - getTimestamp() / setTimestamp (simtime) used in timestamp option
//
// Additional length fields defined in this class are in bytes.
//
// Only one of the option fields can exist at a time.
//
packet IPv4Datagram
{
    @customize(true);

    short version = 4;
    short headerLength = IP_HEADER_BYTES;

    IPv4Address srcAddress;
    IPv4Address destAddress;

    int transportProtocol @enum(IPProtocolId) = IP_PROT_NONE;
    short timeToLive;
    int identification;
    bool moreFragments;
    bool dontFragment;
    int fragmentOffset;         // bytes, must be multiple of 8
    int totalLengthField = -1;       // -1 means: getTotalLengthField() uses getByteLength()
    unsigned char typeOfService;  // ToS byte
    abstract int diffServCodePoint;  // maps to bits 0-5 of ToS
    abstract int explicitCongestionNotification;  // maps to bits 6-7 of ToS

    TLVOptions options; // array of option pointers, option pointers owned by datagram
}

IPv4Datagram_Base is only useful if it gets subclassed, and IPv4Datagram is derived from it. The minimum code to be written for IPv4Datagram is the following:

class INET_API IPv4Datagram : public IPv4Datagram_Base
{
  private:
    void copy(const IPv4Datagram& other) { ... }

  public:
    IPv4Datagram(const char *name=nullptr, short kind=0) : IPv4Datagram_Base(name,kind) {}
    IPv4Datagram(const IPv4Datagram& other) : IPv4Datagram_Base(other) {copy(other);}
    IPv4Datagram& operator=(const IPv4Datagram& other) {if (this==&other) return *this; IPv4Datagram_Base::operator=(other); copy(other); return *this;}
    virtual IPv4Datagram *dup() const override {return new IPv4Datagram(*this);}
    // ADD CODE HERE to redefine and implement pure virtual functions from IPv4Datagram_Base
};

The following should go into a .cc (.cpp) file:

Register_Class(IPv4Datagram)

Constructor & Destructor Documentation

inet::IPv4Datagram_Base::IPv4Datagram_Base	(	const char *	name = `nullptr`,
		short	kind = `0`
	)

protected

inet::IPv4Datagram_Base::IPv4Datagram_Base ( const IPv4Datagram_Base & other )

protected

virtual inet::IPv4Datagram_Base::~IPv4Datagram_Base ( )

virtual

Member Function Documentation

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

private

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

inlineoverridevirtual

Reimplemented in inet::IPv4Datagram.

549 {throw omnetpp::cRuntimeError("You forgot to manually add a dup() function to class IPv4Datagram");}

virtual IPv4Address& inet::IPv4Datagram_Base::getDestAddress ( )

virtual

Referenced by inet::IPv4FragBuf::addFragment(), inet::PacketDrillApp::compareDatagram(), inet::sctp::SCTPNatHook::datagramForwardHook(), inet::IPv4::datagramLocalOut(), inet::sctp::SCTPNatHook::datagramPreRoutingHook(), inet::IPv4::decapsulate(), inet::IPv4::determineOutgoingInterfaceForMulticastDatagram(), inet::PacketDump::dumpIPv4(), inet::IPv4::encapsulate(), inet::PIMSM::forwardMulticastData(), inet::IPv4::forwardMulticastPacket(), inet::IPv4::handleIncomingDatagram(), inet::ExtInterface::handleMessage(), inet::SimpleClassifier::lookupLabel(), inet::LDP::lookupLabel(), inet::MultiFieldClassifier::Filter::matches(), inet::PIMSM::multicastPacketForwarded(), inet::IPv4::preroutingFinish(), inet::UDP::processICMPError(), inet::PIMSM::processRegisterPacket(), inet::PIMDM::receiveSignal(), inet::PIMSM::receiveSignal(), inet::IPv4::routeUnicastPacket(), inet::sctp::SCTPNatHook::sendBackError(), inet::IPv4::sendDatagramToOutput(), inet::ICMP::sendErrorMessage(), and inet::serializer::IPv4Serializer::serialize().

virtual const IPv4Address& inet::IPv4Datagram_Base::getDestAddress ( ) const

inlinevirtual

Referenced by getDestAddress().

562 {return const_cast<IPv4Datagram_Base*>(this)->getDestAddress();}

inet::IPv4Datagram_Base::getDestAddress

virtual IPv4Address & getDestAddress()

inet::IPv4Datagram_Base::IPv4Datagram_Base

IPv4Datagram_Base(const char *name=nullptr, short kind=0)

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

pure virtual

Implemented in inet::IPv4Datagram.

virtual bool inet::IPv4Datagram_Base::getDontFragment ( ) const

virtual

Referenced by inet::PacketDrillApp::compareDatagram(), inet::IPv4::fragmentAndSend(), inet::UDP::processICMPError(), and inet::serializer::IPv4Serializer::serialize().

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

pure virtual

Implemented in inet::IPv4Datagram.

virtual int inet::IPv4Datagram_Base::getFragmentOffset ( ) const

virtual

Referenced by inet::IPv4FragBuf::addFragment(), inet::PacketDrillApp::compareDatagram(), inet::PacketDump::dumpIPv4(), inet::IPv4::fragmentAndSend(), inet::InetPacketPrinter::printMessage(), inet::InetPacketPrinter2::printMessage(), inet::UDP::processICMPError(), inet::IPv4::reassembleAndDeliver(), and inet::serializer::IPv4Serializer::serialize().

virtual short inet::IPv4Datagram_Base::getHeaderLength ( ) const

virtual

Referenced by inet::IPv4FragBuf::addFragment(), inet::PacketDrillApp::compareDatagram(), inet::IPv4::fragmentAndSend(), inet::IPv4::handleIncomingDatagram(), inet::ICMP::sendErrorMessage(), inet::serializer::IPv4Serializer::serialize(), inet::serializer::IPv4Serializer::serializeOptions(), and inet::GPSR::setGpsrOptionOnNetworkDatagram().

virtual int inet::IPv4Datagram_Base::getIdentification ( ) const

virtual

Referenced by inet::IPv4FragBuf::addFragment(), inet::PacketDrillApp::compareDatagram(), and inet::serializer::IPv4Serializer::serialize().

virtual bool inet::IPv4Datagram_Base::getMoreFragments ( ) const

virtual

Referenced by inet::IPv4FragBuf::addFragment(), inet::PacketDrillApp::compareDatagram(), inet::PacketDump::dumpIPv4(), inet::InetPacketPrinter::printMessage(), inet::InetPacketPrinter2::printMessage(), and inet::serializer::IPv4Serializer::serialize().

virtual TLVOptions& inet::IPv4Datagram_Base::getOptions ( )

virtual

virtual const TLVOptions& inet::IPv4Datagram_Base::getOptions ( ) const

inlinevirtual

Referenced by getOptions().

585 {return const_cast<IPv4Datagram_Base*>(this)->getOptions();}

inet::IPv4Datagram_Base::IPv4Datagram_Base

IPv4Datagram_Base(const char *name=nullptr, short kind=0)

inet::IPv4Datagram_Base::getOptions

virtual TLVOptions & getOptions()

virtual IPv4Address& inet::IPv4Datagram_Base::getSrcAddress ( )

virtual

Referenced by inet::IPv4FragBuf::addFragment(), inet::PacketDrillApp::compareDatagram(), inet::sctp::SCTPNatHook::datagramForwardHook(), inet::sctp::SCTPNatHook::datagramPreRoutingHook(), inet::IPv4::decapsulate(), inet::IPv4::determineOutgoingInterfaceForMulticastDatagram(), inet::PacketDump::dumpIPv4(), inet::IPv4::forwardMulticastPacket(), inet::IPv4::fragmentAndSend(), inet::IPv4::getShortestPathInterfaceToSource(), inet::ExtInterface::handleMessage(), inet::SimpleClassifier::lookupLabel(), inet::MultiFieldClassifier::Filter::matches(), inet::PIMSM::multicastPacketForwarded(), inet::UDP::processICMPError(), inet::PIMSM::processRegisterPacket(), inet::PIMDM::receiveSignal(), inet::PIMSM::receiveSignal(), inet::sctp::SCTPNatHook::sendBackError(), inet::ICMP::sendErrorMessage(), and inet::serializer::IPv4Serializer::serialize().

virtual const IPv4Address& inet::IPv4Datagram_Base::getSrcAddress ( ) const

inlinevirtual

Referenced by getSrcAddress().

559 {return const_cast<IPv4Datagram_Base*>(this)->getSrcAddress();}

inet::IPv4Datagram_Base::getSrcAddress

virtual IPv4Address & getSrcAddress()

inet::IPv4Datagram_Base::IPv4Datagram_Base

IPv4Datagram_Base(const char *name=nullptr, short kind=0)

virtual short inet::IPv4Datagram_Base::getTimeToLive ( ) const

virtual

Referenced by inet::PacketDrillApp::compareDatagram(), inet::IPv4::decapsulate(), inet::IPv4::forwardMulticastPacket(), inet::IPv4::fragmentAndSend(), inet::IPv4::handleIncomingDatagram(), inet::IPv4::preroutingFinish(), inet::PIMDM::receiveSignal(), and inet::serializer::IPv4Serializer::serialize().

virtual int inet::IPv4Datagram_Base::getTotalLengthField ( ) const

virtual

Reimplemented in inet::IPv4Datagram.

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

virtual

Reimplemented in inet::IPv4Datagram.

Referenced by inet::IPv4Datagram::getTransportProtocol().

virtual unsigned char inet::IPv4Datagram_Base::getTypeOfService ( ) const

virtual

Referenced by inet::PacketDrillApp::compareDatagram(), inet::IPv4::decapsulate(), inet::MultiFieldClassifier::Filter::matches(), and inet::serializer::IPv4Serializer::serialize().

virtual short inet::IPv4Datagram_Base::getVersion ( ) const

virtual

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

IPv4Datagram_Base& inet::IPv4Datagram_Base::operator= ( const IPv4Datagram_Base & other )

protected

Referenced by inet::IPv4Datagram::operator=().

bool inet::IPv4Datagram_Base::operator== ( const IPv4Datagram_Base & )

protected

virtual void inet::IPv4Datagram_Base::parsimPack ( omnetpp::cCommBuffer * b ) const

overridevirtual

virtual void inet::IPv4Datagram_Base::parsimUnpack ( omnetpp::cCommBuffer * b )

overridevirtual

virtual void inet::IPv4Datagram_Base::setDestAddress ( const IPv4Address & destAddress )

virtual

Referenced by inet::PacketDrillApp::closeAllSockets(), inet::sctp::SCTPNatHook::datagramPreRoutingHook(), inet::IPv4::encapsulate(), PacketDrill::makeIPPacket(), inet::sctp::SCTPNatHook::sendBackError(), and inet::PIMSM::sendPIMRegisterNull().

virtual void inet::IPv4Datagram_Base::setDiffServCodePoint ( int diffServCodePoint )

pure virtual

Implemented in inet::IPv4Datagram.

virtual void inet::IPv4Datagram_Base::setDontFragment ( bool dontFragment )

virtual

Referenced by inet::PacketDrillApp::closeAllSockets(), inet::IPv4::encapsulate(), and PacketDrill::makeIPPacket().

virtual void inet::IPv4Datagram_Base::setExplicitCongestionNotification ( int explicitCongestionNotification )

pure virtual

Implemented in inet::IPv4Datagram.

virtual void inet::IPv4Datagram_Base::setFragmentOffset ( int fragmentOffset )

virtual

Referenced by inet::IPv4FragBuf::addFragment(), inet::PacketDrillApp::closeAllSockets(), inet::IPv4::encapsulate(), inet::IPv4::fragmentAndSend(), and PacketDrill::makeIPPacket().

virtual void inet::IPv4Datagram_Base::setHeaderLength ( short headerLength )

virtual

Referenced by inet::PacketDrillApp::closeAllSockets(), PacketDrill::makeIPPacket(), and inet::GPSR::setGpsrOptionOnNetworkDatagram().

virtual void inet::IPv4Datagram_Base::setIdentification ( int identification )

virtual

Referenced by inet::PacketDrillApp::closeAllSockets(), inet::IPv4::encapsulate(), and PacketDrill::makeIPPacket().

virtual void inet::IPv4Datagram_Base::setMoreFragments ( bool moreFragments )

virtual

Referenced by inet::IPv4FragBuf::addFragment(), inet::PacketDrillApp::closeAllSockets(), inet::IPv4::encapsulate(), inet::IPv4::fragmentAndSend(), and PacketDrill::makeIPPacket().

virtual void inet::IPv4Datagram_Base::setOptions ( const TLVOptions & options )

virtual

virtual void inet::IPv4Datagram_Base::setSrcAddress ( const IPv4Address & srcAddress )

virtual

Referenced by inet::PacketDrillApp::closeAllSockets(), inet::sctp::SCTPNatHook::datagramForwardHook(), inet::sctp::SCTPNatHook::datagramPreRoutingHook(), inet::IPv4::encapsulate(), inet::IPv4::fragmentAndSend(), PacketDrill::makeIPPacket(), inet::sctp::SCTPNatHook::sendBackError(), and inet::PIMSM::sendPIMRegisterNull().

virtual void inet::IPv4Datagram_Base::setTimeToLive ( short timeToLive )

virtual

Referenced by inet::PacketDrillApp::closeAllSockets(), inet::IPv4::encapsulate(), inet::IPv4::handleIncomingDatagram(), and PacketDrill::makeIPPacket().

virtual void inet::IPv4Datagram_Base::setTotalLengthField ( int totalLengthField )

virtual

Referenced by inet::GPSR::setGpsrOptionOnNetworkDatagram().

virtual void inet::IPv4Datagram_Base::setTransportProtocol ( int transportProtocol )

virtual

Reimplemented in inet::IPv4Datagram.

Referenced by inet::IPv4Datagram::setTransportProtocol().

virtual void inet::IPv4Datagram_Base::setTypeOfService ( unsigned char typeOfService )

virtual

Referenced by inet::PacketDrillApp::closeAllSockets(), inet::IPv4::encapsulate(), and PacketDrill::makeIPPacket().

virtual void inet::IPv4Datagram_Base::setVersion ( short version )

virtual

Referenced by inet::PacketDrillApp::closeAllSockets(), and PacketDrill::makeIPPacket().

Member Data Documentation

IPv4Address inet::IPv4Datagram_Base::destAddress

protected

bool inet::IPv4Datagram_Base::dontFragment

protected

int inet::IPv4Datagram_Base::fragmentOffset

protected

short inet::IPv4Datagram_Base::headerLength

protected

int inet::IPv4Datagram_Base::identification

protected

bool inet::IPv4Datagram_Base::moreFragments

protected

TLVOptions inet::IPv4Datagram_Base::options

protected

Referenced by inet::IPv4Datagram::addOption(), inet::IPv4Datagram::calculateHeaderByteLength(), and inet::IPv4Datagram::findOptionByType().

IPv4Address inet::IPv4Datagram_Base::srcAddress

protected

short inet::IPv4Datagram_Base::timeToLive

protected

int inet::IPv4Datagram_Base::totalLengthField

protected

Referenced by inet::IPv4Datagram::getTotalLengthField().

int inet::IPv4Datagram_Base::transportProtocol

protected

unsigned char inet::IPv4Datagram_Base::typeOfService

protected

short inet::IPv4Datagram_Base::version

protected

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

IPv4Datagram_m.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation