A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::Ipv6Option Class Referenceabstract

IPv6 Option base. More...

#include "ipv6-option.h"

+ Inheritance diagram for ns3::Ipv6Option:
+ Collaboration diagram for ns3::Ipv6Option:

Public Member Functions

 ~Ipv6Option () override
 Destructor.
 
virtual uint8_t GetOptionNumber () const =0
 Get the option number.
 
virtual uint8_t Process (Ptr< Packet > packet, uint8_t offset, const Ipv6Header &ipv6Header, bool &isDropped)=0
 Process method.
 
void SetNode (Ptr< Node > node)
 Set the node.
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type identificator.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Private Attributes

Ptr< Nodem_node
 The node.
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Detailed Description

IPv6 Option base.

Introspection did not find any typical Config paths.

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.


Attributes

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

No TraceSources are defined for this type.
Group: Internet

Size of this type is 64 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ ~Ipv6Option()

ns3::Ipv6Option::~Ipv6Option ( )
override

Destructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetOptionNumber()

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

Get the option number.

Returns
option number

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

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::Ipv6Option::GetTypeId ( )
static

Get the type identificator.

Returns
type identificator

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

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

+ Here is the call graph for this function:

◆ Process()

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

Process method.

Called from Ipv6L3Protocol::Receive.

Parameters
packetthe packet
offsetthe offset of the extension to process
ipv6Headerthe IPv6 header of packet received
isDroppedif the packet must be dropped
Returns
the processed size

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

◆ SetNode()

void ns3::Ipv6Option::SetNode ( Ptr< Node > node)

Set the node.

Parameters
nodethe node to set

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

References m_node, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_node

Ptr<Node> ns3::Ipv6Option::m_node
private

The node.

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

Referenced by SetNode().


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