Class generated from inet/networklayer/icmpv6/Ipv6NdMessage.msg:159 by opp_msgtool. More...

#include <Ipv6NdMessage_m.h>

Inheritance diagram for inet::Ipv6RouterAdvertisement:

Public Member Functions
	Ipv6RouterAdvertisement ()

	Ipv6RouterAdvertisement (const Ipv6RouterAdvertisement &other)

virtual	~Ipv6RouterAdvertisement ()

Ipv6RouterAdvertisement &	operator= (const Ipv6RouterAdvertisement &other)

virtual Ipv6RouterAdvertisement *	dup () const override

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

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

virtual unsigned short	getCurHopLimit () const

virtual void	setCurHopLimit (unsigned short curHopLimit)

virtual bool	getManagedAddrConfFlag () const

virtual void	setManagedAddrConfFlag (bool managedAddrConfFlag)

virtual bool	getOtherStatefulConfFlag () const

virtual void	setOtherStatefulConfFlag (bool otherStatefulConfFlag)

virtual bool	getHomeAgentFlag () const

virtual void	setHomeAgentFlag (bool homeAgentFlag)

virtual uint8_t	getReserved () const

virtual void	setReserved (uint8_t reserved)

virtual unsigned short	getRouterLifetime () const

virtual void	setRouterLifetime (unsigned short routerLifetime)

virtual unsigned int	getReachableTime () const

virtual void	setReachableTime (unsigned int reachableTime)

virtual unsigned int	getRetransTimer () const

virtual void	setRetransTimer (unsigned int retransTimer)

virtual const Ipv6NdOptions &	getOptions () const

virtual Ipv6NdOptions &	getOptionsForUpdate ()

virtual void	setOptions (const Ipv6NdOptions &options)

Public Member Functions inherited from inet::Ipv6NdMessage
	Ipv6NdMessage ()

	Ipv6NdMessage (const Ipv6NdMessage &other)

virtual	~Ipv6NdMessage ()

Ipv6NdMessage &	operator= (const Ipv6NdMessage &other)

virtual int	getCode () const

virtual void	setCode (int code)

Public Member Functions inherited from inet::Icmpv6Header
	Icmpv6Header ()

	Icmpv6Header (const Icmpv6Header &other)

virtual	~Icmpv6Header ()

Icmpv6Header &	operator= (const Icmpv6Header &other)

virtual Icmpv6Type	getType () const

virtual void	setType (Icmpv6Type type)

virtual int	getChksum () const

virtual void	setChksum (int chksum)

virtual CrcMode	getCrcMode () const

virtual void	setCrcMode (CrcMode crcMode)

Public Member Functions inherited from inet::FieldsChunk
	FieldsChunk ()

	FieldsChunk (const FieldsChunk &other)

virtual	~FieldsChunk ()

virtual void	parsimPack (cCommBuffer *buffer) const override

virtual void	parsimUnpack (cCommBuffer *buffer) override

virtual void	handleChange () override

virtual ChunkType	getChunkType () const override
	Returns the type of this chunk as an enum member. More...

virtual bool	containsSameData (const Chunk &other) const override
	Returns true if the two chunks represent the same binary data. More...

virtual b	getChunkLength () const override
	Returns the length of data represented by this chunk. More...

virtual void	setChunkLength (b chunkLength)

virtual void	addChunkLength (b chunkLength)

virtual std::ostream &	printFieldsToStream (std::ostream &stream, int level, int evFlags=0) const override
	Prints an optinally formatted human readable string representation of the feilds of this chunk to the given stream. More...

Public Member Functions inherited from inet::Chunk
	Chunk ()

	Chunk (const Chunk &other)

virtual const Ptr< Chunk >	dupShared () const
	Returns a mutable copy of this chunk in a shared pointer. More...

virtual void	forEachChild (cVisitor *v) override

virtual bool	isMutable () const

virtual bool	isImmutable () const

virtual void	markImmutable ()

void	markMutableIfExclusivelyOwned ()

virtual bool	isComplete () const

virtual bool	isIncomplete () const

virtual void	markIncomplete ()

virtual bool	isCorrect () const

virtual bool	isIncorrect () const

virtual void	markIncorrect ()

virtual bool	isProperlyRepresented () const

virtual bool	isImproperlyRepresented () const

virtual void	markImproperlyRepresented ()

virtual void	moveIterator (Iterator &iterator, b length) const

virtual void	seekIterator (Iterator &iterator, b position) const

virtual bool	canInsertAtFront (const Ptr< const Chunk > &chunk) const
	Returns true if this chunk is capable of representing the result. More...

virtual bool	canInsertAtBack (const Ptr< const Chunk > &chunk) const
	Returns true if this chunk is capable of representing the result. More...

virtual bool	canInsertAt (const Ptr< const Chunk > &chunk, b offset) const
	Returns true if this chunk is capable of representing the result. More...

void	insertAtFront (const Ptr< const Chunk > &chunk)
	Inserts the provided chunk at the beginning of this chunk. More...

void	insertAtBack (const Ptr< const Chunk > &chunk)
	Inserts the provided chunk at the end of this chunk. More...

void	insertAt (const Ptr< const Chunk > &chunk, b offset)
	Inserts the provided chunk into this chunk. More...

virtual bool	canRemoveAtFront (b length) const
	Returns true if this chunk is capable of representing the result. More...

virtual bool	canRemoveAtBack (b length) const
	Returns true if this chunk is capable of representing the result. More...

virtual bool	canRemoveAt (b offset, b length) const
	Returns true if this chunk is capable of representing the result. More...

void	removeAtFront (b length)
	Removes the requested part from the beginning of this chunk. More...

void	removeAtBack (b length)
	Removes the requested part from the end of this chunk. More...

void	removeAt (b offset, b length)
	Removes the requested part from this chunk. More...

int	getChunkId () const
	Returns the sequentially assigned id. More...

virtual bool	isEmpty () const
	Returns true if this chunk contains no data. More...

const Ptr< Chunk >	simplify () const
	Returns the simplified representation of this chunk eliminating all potential redundancies. More...

const Ptr< Chunk >	peek (const Iterator &iterator, b length=unspecifiedLength, int flags=0) const
	Returns the designated part of the data represented by this chunk in its default representation. More...

template<typename T >
bool	has (const Iterator &iterator, b length=unspecifiedLength) const
	Returns whether if the designated part of the data is available in the requested representation. More...

template<typename T >
const Ptr< T >	peek (const Iterator &iterator, b length=unspecifiedLength, int flags=0) const
	Returns the designated part of the data represented by this chunk in the requested representation. More...

virtual SharingRegionTagSet &	getRegionTags () override
	Returns all region tags. More...

int	getNumTags () const
	Returns the number of chunk tags. More...

const Ptr< const TagBase >	getTag (int index) const
	Returns the chunk tag at the given index. More...

void	clearTags (b offset=b(0), b length=b(-1))
	Clears the set of chunk tags in the given region. More...

void	copyTags (const Chunk &source, b sourceOffset=b(0), b offset=b(0), b length=b(-1))
	Copies the set of chunk tags from the source region to the provided region. More...

template<typename T >
const Ptr< const T >	findTag (b offset=b(0), b length=b(-1)) const
	Returns the chunk tag for the provided type and range, or returns nullptr if no such chunk tag is found. More...

template<typename T >
const Ptr< const T >	getTag (b offset=b(0), b length=b(-1)) const
	Returns the chunk tag for the provided type and range, or throws an exception if no such chunk tag is found. More...

template<typename T >
void	mapAllTags (b offset, b length, std::function< void(b, b, const Ptr< const T > &)> f) const
	Maps all tags in the provided range to to the function. More...

template<typename T >
void	mapAllTagsForUpdate (b offset, b length, std::function< void(b, b, const Ptr< T > &)> f)
	Maps all tags in the provided range to to the function. More...

template<typename T >
std::vector< SharingRegionTagSet::RegionTag< const T > >	getAllTags (b offset=b(0), b length=b(-1)) const
	Returns all chunk tags for the provided type and range in a detached vector of region tags. More...

template<typename T >
std::vector< SharingRegionTagSet::RegionTag< T > >	getAllTagsForUpdate (b offset=b(0), b length=b(-1))
	Returns all chunk tags for the provided type and range in a detached vector of region tags. More...

template<typename T >
const Ptr< T >	addTag (b offset=b(0), b length=b(-1))
	Returns a newly added chunk tag for the provided type and range, or throws an exception if such a chunk tag is already present. More...

template<typename T >
const Ptr< T >	addTagIfAbsent (b offset=b(0), b length=b(-1))
	Returns a newly added chunk tag for the provided type and range if absent, or returns the chunk tag that is already present. More...

template<typename T >
std::vector< SharingRegionTagSet::RegionTag< T > >	addTagsWhereAbsent (b offset=b(0), b length=b(-1))
	Returns the newly added chunk tags for the provided type and range where the tag is absent. More...

template<typename T >
const Ptr< T >	removeTag (b offset, b length)
	Removes the chunk tag for the provided type and range, or throws an exception if no such chunk tag is found. More...

template<typename T >
const Ptr< T >	removeTagIfPresent (b offset, b length)
	Removes the chunk tag for the provided type and range if present, or returns nullptr if no such chunk tag is found. More...

template<typename T >
std::vector< SharingRegionTagSet::RegionTag< T > >	removeTagsWherePresent (b offset, b length)
	Removes and returns all chunk tags for the provided type and range. More...

virtual std::ostream &	printToStream (std::ostream &stream, int level, int evFlags=0) const override
	Prints an optinally formatted human readable string representation of the data present in this chunk to the given stream. More...

virtual std::string	str () const override
	Returns a human readable string representation of the data present in this chunk. More...

Public Member Functions inherited from inet::IPrintableObject
virtual	~IPrintableObject ()

virtual std::string	printToString () const

virtual std::string	printToString (int level, int evFlags=0) const

virtual std::string	getInfoStringRepresentation (int evFlags=0) const

virtual std::string	getDetailStringRepresentation (int evFlags=0) const

virtual std::string	getDebugStringRepresentation (int evFlags=0) const

virtual std::string	getTraceStringRepresentation (int evFlags=0) const

virtual std::string	getCompleteStringRepresentation (int evFlags=0) const

Protected Member Functions
bool	operator== (const Ipv6RouterAdvertisement &)=delete

Protected Member Functions inherited from inet::Ipv6NdMessage
bool	operator== (const Ipv6NdMessage &)=delete

Protected Member Functions inherited from inet::Icmpv6Header
bool	operator== (const Icmpv6Header &)=delete

Protected Member Functions inherited from inet::FieldsChunk
const std::vector< uint8_t > *	getSerializedBytes () const

void	setSerializedBytes (const std::vector< uint8_t > *bytes) const

virtual const Ptr< Chunk >	peekUnchecked (PeekPredicate predicate, PeekConverter converter, const Iterator &iterator, b length, int flags) const override

Protected Member Functions inherited from inet::Chunk
int	getBinDumpNumLines () const

int	getHexDumpNumLines () const

const char *	getBinDumpLine (int index)

const char *	getHexDumpLine (int index)

const SharingRegionTagSet::RegionTag< TagBase > &	_getTag (int index) const

void	checkMutable () const

virtual void	doInsertAtFront (const Ptr< const Chunk > &chunk)

virtual void	doInsertAtBack (const Ptr< const Chunk > &chunk)

virtual void	doInsertAt (const Ptr< const Chunk > &chunk, b offset)

virtual void	doRemoveAtFront (b length)

virtual void	doRemoveAtBack (b length)

virtual void	doRemoveAt (b offset, b length)

template<typename T >
const Ptr< T >	peekConverted (const Iterator &iterator, b length, int flags) const

template<typename T >
const Ptr< T >	checkPeekResult (const Ptr< T > &chunk, int flags) const

Protected Attributes
unsigned short	curHopLimit = 0

bool	managedAddrConfFlag = false

bool	otherStatefulConfFlag = false

bool	homeAgentFlag = false

uint8_t	reserved = 0

unsigned short	routerLifetime = 0

unsigned int	reachableTime = 0

unsigned int	retransTimer = 0

Ipv6NdOptions	options

Protected Attributes inherited from inet::Ipv6NdMessage
int	code = 0

Protected Attributes inherited from inet::Icmpv6Header
Icmpv6Type	type = static_cast<inet::Icmpv6Type>(-1)

int	chksum = 0

CrcMode	crcMode = CRC_MODE_UNDEFINED

Protected Attributes inherited from inet::FieldsChunk
b	chunkLength

const std::vector< uint8_t > *	serializedBytes
	The serialized representation of this chunk or nullptr if not available. More...

Protected Attributes inherited from inet::Chunk
int	id
	The id is automatically assigned sequentially during construction. More...

int	flags
	The boolean chunk flags are merged into a single integer. More...

SharingRegionTagSet	regionTags
	The set of region tags attached to the data represented by this chunk. More...

const typedef Ptr< Chunk >(*	PeekConverter )(const Ptr< Chunk > &chunk, const Chunk::Iterator &iterator, b length, int flags)

Private Member Functions
void	copy (const Ipv6RouterAdvertisement &other)

Additional Inherited Members
Public Types inherited from inet::Chunk
enum	ChunkType { CT_EMPTY, CT_BITCOUNT, CT_BITS, CT_BYTECOUNT, CT_BYTES, CT_SLICE, CT_ENCRYPTED, CT_CPACKET, CT_SEQUENCE, CT_FIELDS }
	This enum is used to avoid std::dynamic_cast and dynamicPtrCast. More...

enum	PeekFlag { PF_ALLOW_NULLPTR = (1 << 0), PF_ALLOW_EMPTY = (1 << 1), PF_ALLOW_INCOMPLETE = (1 << 2), PF_ALLOW_INCORRECT = (1 << 3), PF_ALLOW_IMPROPERLY_REPRESENTED = (1 << 4), PF_ALLOW_SERIALIZATION = (1 << 5), PF_ALLOW_ALL = -1 }
	This enum specifies bitmasks for the flags argument of various peek functions. More...

Public Types inherited from inet::IPrintableObject
enum	PrintLevel { PRINT_LEVEL_TRACE, PRINT_LEVEL_DEBUG, PRINT_LEVEL_DETAIL, PRINT_LEVEL_INFO, PRINT_LEVEL_COMPLETE = INT_MIN }

enum	PrintFlag { PRINT_FLAG_FORMATTED = (1 << 0), PRINT_FLAG_MULTILINE = (1 << 1) }

Static Public Member Functions inherited from inet::Chunk
static void	serialize (MemoryOutputStream &stream, const Ptr< const Chunk > &chunk, b offset=b(0), b length=b(-1))
	Serializes a chunk into the given stream. More...

static const Ptr< Chunk >	deserialize (MemoryInputStream &stream, const std::type_info &typeInfo)
	Deserializes a chunk from the given stream. More...

Static Public Attributes inherited from inet::Chunk
static const b	unspecifiedLength = b(-std::numeric_limits<int64_t>::max())

static bool	enableImplicitChunkSerialization = false
	Peeking some part into a chunk that requires automatic serialization will throw an exception when implicit chunk serialization is disabled. More...

static int	nextId = 0

Protected Types inherited from inet::Chunk
enum	ChunkFlag { CF_IMMUTABLE = (1 << 0), CF_INCOMPLETE = (1 << 1), CF_INCORRECT = (1 << 2), CF_IMPROPERLY_REPRESENTED = (1 << 3) }
	This enum specifies bitmasks for the flags field of Chunk. More...

typedef bool(*	PeekPredicate) (const Ptr< Chunk > &)

Static Protected Member Functions inherited from inet::FieldsChunk
static const Ptr< Chunk >	convertChunk (const std::type_info &typeInfo, const Ptr< Chunk > &chunk, b offset, b length, int flags)

Static Protected Member Functions inherited from inet::Chunk
static const Ptr< Chunk >	convertChunk (const std::type_info &typeInfo, const Ptr< Chunk > &chunk, b offset, b length, int flags)
	Creates a new chunk of the given type that represents the designated part of the provided chunk. More...

Detailed Description

Class generated from inet/networklayer/icmpv6/Ipv6NdMessage.msg:159 by opp_msgtool.

//
// Router Advertisement Message Format
// RFC 2461 Section 4.2
// RFC 3775 Section 7.1, RFC 5175 Section 3. (homeAgentFlag)
//
class Ipv6RouterAdvertisement extends Ipv6NdMessage
{
    chunkLength = B(16);    // without options
    type = ICMPv6_ROUTER_AD;
    //Additional ICMP fields
    unsigned short curHopLimit;

    bool managedAddrConfFlag;    //M-bit
    bool otherStatefulConfFlag;    //O-bit
    bool homeAgentFlag = false;        //H-bit
    uint8_t reserved = 0;

    unsigned short routerLifetime;  // [s] 0 indicates router is not a default router
    unsigned int reachableTime;     // [ms]
    unsigned int retransTimer;      // [ms]
    Ipv6NdOptions options;
}

Constructor & Destructor Documentation

◆ Ipv6RouterAdvertisement() [1/2]

inet::Ipv6RouterAdvertisement::Ipv6RouterAdvertisement ( )

◆ Ipv6RouterAdvertisement() [2/2]

inet::Ipv6RouterAdvertisement::Ipv6RouterAdvertisement ( const Ipv6RouterAdvertisement & other )

◆ ~Ipv6RouterAdvertisement()

virtual inet::Ipv6RouterAdvertisement::~Ipv6RouterAdvertisement ( )

virtual

Member Function Documentation

◆ copy()

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

private

◆ dup()

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

inlineoverridevirtual

Reimplemented from inet::Ipv6NdMessage.

681 {return new Ipv6RouterAdvertisement(*this);}

◆ getCurHopLimit()

virtual unsigned short inet::Ipv6RouterAdvertisement::getCurHopLimit ( ) const

virtual

Referenced by inet::Ipv6NeighbourDiscovery::processRaForRouterUpdates().

◆ getHomeAgentFlag()

virtual bool inet::Ipv6RouterAdvertisement::getHomeAgentFlag ( ) const

virtual

Referenced by inet::Ipv6NeighbourDiscovery::processRaForRouterUpdates(), and inet::Ipv6NeighbourDiscovery::processRaPacket().

◆ getManagedAddrConfFlag()

virtual bool inet::Ipv6RouterAdvertisement::getManagedAddrConfFlag ( ) const

virtual

◆ getOptions()

virtual const Ipv6NdOptions& inet::Ipv6RouterAdvertisement::getOptions ( ) const

virtual

Referenced by inet::Ipv6NeighbourDiscovery::processRaForRouterUpdates(), inet::Ipv6NeighbourDiscovery::processRaPacket(), inet::Ipv6NeighbourDiscovery::processRaPrefixInfo(), and inet::Ipv6NeighbourDiscovery::validateRaPacket().

◆ getOptionsForUpdate()

virtual Ipv6NdOptions& inet::Ipv6RouterAdvertisement::getOptionsForUpdate ( )

inlinevirtual

710 { handleChange();return const_cast<Ipv6NdOptions&>(const_cast<Ipv6RouterAdvertisement*>(this)->getOptions());}

◆ getOtherStatefulConfFlag()

virtual bool inet::Ipv6RouterAdvertisement::getOtherStatefulConfFlag ( ) const

virtual

◆ getReachableTime()

virtual unsigned int inet::Ipv6RouterAdvertisement::getReachableTime ( ) const

virtual

Referenced by inet::Ipv6NeighbourDiscovery::processRaForRouterUpdates().

◆ getReserved()

virtual uint8_t inet::Ipv6RouterAdvertisement::getReserved ( ) const

virtual

◆ getRetransTimer()

virtual unsigned int inet::Ipv6RouterAdvertisement::getRetransTimer ( ) const

virtual

Referenced by inet::Ipv6NeighbourDiscovery::processRaForRouterUpdates().

◆ getRouterLifetime()

virtual unsigned short inet::Ipv6RouterAdvertisement::getRouterLifetime ( ) const

virtual

Referenced by inet::Ipv6NeighbourDiscovery::processRaForRouterUpdates().

◆ operator=()

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

◆ operator==()

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

protecteddelete

◆ parsimPack()

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

overridevirtual

Reimplemented from inet::Ipv6NdMessage.

Referenced by inet::doParsimPacking().

◆ parsimUnpack()

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

overridevirtual

Reimplemented from inet::Ipv6NdMessage.

Referenced by inet::doParsimUnpacking().

◆ setCurHopLimit()

virtual void inet::Ipv6RouterAdvertisement::setCurHopLimit ( unsigned short curHopLimit )

virtual

◆ setHomeAgentFlag()

virtual void inet::Ipv6RouterAdvertisement::setHomeAgentFlag ( bool homeAgentFlag )

virtual

◆ setManagedAddrConfFlag()

virtual void inet::Ipv6RouterAdvertisement::setManagedAddrConfFlag ( bool managedAddrConfFlag )

virtual

◆ setOptions()

virtual void inet::Ipv6RouterAdvertisement::setOptions ( const Ipv6NdOptions & options )

virtual

◆ setOtherStatefulConfFlag()

virtual void inet::Ipv6RouterAdvertisement::setOtherStatefulConfFlag ( bool otherStatefulConfFlag )

virtual

◆ setReachableTime()

virtual void inet::Ipv6RouterAdvertisement::setReachableTime ( unsigned int reachableTime )

virtual

◆ setReserved()

virtual void inet::Ipv6RouterAdvertisement::setReserved ( uint8_t reserved )

virtual

◆ setRetransTimer()

virtual void inet::Ipv6RouterAdvertisement::setRetransTimer ( unsigned int retransTimer )

virtual

◆ setRouterLifetime()

virtual void inet::Ipv6RouterAdvertisement::setRouterLifetime ( unsigned short routerLifetime )

virtual

Member Data Documentation

◆ curHopLimit

unsigned short inet::Ipv6RouterAdvertisement::curHopLimit = 0

protected

◆ homeAgentFlag

bool inet::Ipv6RouterAdvertisement::homeAgentFlag = false

protected

◆ managedAddrConfFlag

bool inet::Ipv6RouterAdvertisement::managedAddrConfFlag = false

protected

◆ options

Ipv6NdOptions inet::Ipv6RouterAdvertisement::options

protected

◆ otherStatefulConfFlag

bool inet::Ipv6RouterAdvertisement::otherStatefulConfFlag = false

protected

◆ reachableTime

unsigned int inet::Ipv6RouterAdvertisement::reachableTime = 0

protected

◆ reserved

uint8_t inet::Ipv6RouterAdvertisement::reserved = 0

protected

◆ retransTimer

unsigned int inet::Ipv6RouterAdvertisement::retransTimer = 0

protected

◆ routerLifetime

unsigned short inet::Ipv6RouterAdvertisement::routerLifetime = 0

protected

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

Ipv6NdMessage_m.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Ipv6RouterAdvertisement() [1/2]

◆ Ipv6RouterAdvertisement() [2/2]

◆ ~Ipv6RouterAdvertisement()

Member Function Documentation

◆ copy()

◆ dup()

◆ getCurHopLimit()

◆ getHomeAgentFlag()

◆ getManagedAddrConfFlag()

◆ getOptions()

◆ getOptionsForUpdate()

◆ getOtherStatefulConfFlag()

◆ getReachableTime()

◆ getReserved()

◆ getRetransTimer()

◆ getRouterLifetime()

◆ operator=()

◆ operator==()

◆ parsimPack()

◆ parsimUnpack()

◆ setCurHopLimit()

◆ setHomeAgentFlag()

◆ setManagedAddrConfFlag()

◆ setOptions()

◆ setOtherStatefulConfFlag()

◆ setReachableTime()

◆ setReserved()

◆ setRetransTimer()

◆ setRouterLifetime()

Member Data Documentation

◆ curHopLimit

◆ homeAgentFlag

◆ managedAddrConfFlag

◆ options

◆ otherStatefulConfFlag

◆ reachableTime

◆ reserved

◆ retransTimer

◆ routerLifetime