ns3::Ipv6Option Class Reference

IPv6 Option base. More...

#include <introspected-doxygen.h>

Inheritance diagram for ns3::Ipv6Option:

Public Member Functions
virtual	~Ipv6Option ()
	Destructor.
virtual uint8_t	GetOptionNumber () const =0
	Get the option number. More...
virtual uint8_t	Process (Ptr< Packet > packet, uint8_t offset, Ipv6Header const &ipv6Header, bool &isDropped)=0
	Process method. More...
void	SetNode (Ptr< Node > node)
	Set the node. More...
Public Member Functions inherited from ns3::Object
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
AggregateIterator	GetAggregateIterator (void) const
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Initialize (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type identificator. More...
Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Private Attributes
Ptr< Node >	m_node
	The node.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoDispose (void)
virtual void	DoInitialize (void)
virtual void	NotifyNewAggregate (void)
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)

Detailed Description

IPv6 Option base.

Doxygen introspection did not find any typical Config paths.

Attributes

• OptionNumber: The IPv6 option number.
  • Set with class: ns3::UintegerValue
  • Underlying type: uint8_t 0:255
  • Flags: read

No TraceSources are defined for this type.

If you want to implement a new IPv6 option, all you have to do is implement a subclass of this class and add it to an Ipv6OptionDemux.

Definition at line 45 of file ipv6-option.h.

Member Function Documentation

virtual uint8_t ns3::Ipv6Option::GetOptionNumber ( ) const

pure virtual

Get the option number.

Returns

option number

Implemented in ns3::Ipv6OptionRouterAlert, ns3::Ipv6OptionJumbogram, ns3::Ipv6OptionPadn, and ns3::Ipv6OptionPad1.

Referenced by GetTypeId().

TypeId ns3::Ipv6Option::GetTypeId ( void  )

static

Get the type identificator.

Returns

type identificator

Definition at line 34 of file ipv6-option.cc.

References GetOptionNumber(), and ns3::TypeId::SetParent().

virtual uint8_t ns3::Ipv6Option::Process ( Ptr< Packet >  packet, uint8_t  offset, Ipv6Header const &  ipv6Header, bool &  isDropped  )

pure virtual

Process method.

Called from Ipv6L3Protocol::Receive.

Parameters

packet	the packet
offset	the offset of the extension to process
ipv6Header	the IPv6 header of packet received
isDropped	if the packet must be dropped

Returns

the processed size

Implemented in ns3::Ipv6OptionRouterAlert, ns3::Ipv6OptionJumbogram, ns3::Ipv6OptionPadn, and ns3::Ipv6OptionPad1.

void ns3::Ipv6Option::SetNode

(

Ptr< Node >

node

)

Set the node.

Parameters

node	the node to set

Definition at line 51 of file ipv6-option.cc.

References m_node, and NS_LOG_FUNCTION.

---

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

• src/internet/model/ipv6-option.h
• src/internet/model/ipv6-option.cc