A Discrete-Event Network Simulator
API
ns3::Ipv6OptionRouterAlert Class Reference

IPv6 Option Router Alert. More...

#include "ipv6-option.h"

+ Inheritance diagram for ns3::Ipv6OptionRouterAlert:
+ Collaboration diagram for ns3::Ipv6OptionRouterAlert:

Public Member Functions

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

Static Public Member Functions

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

Static Public Attributes

static const uint8_t OPT_NUMBER = 43
 Router alert option number. More...
 

Additional Inherited Members

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

Detailed Description

IPv6 Option Router Alert.

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

Constructor & Destructor Documentation

◆ Ipv6OptionRouterAlert()

ns3::Ipv6OptionRouterAlert::Ipv6OptionRouterAlert ( )

Constructor.

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

References NS_LOG_FUNCTION.

◆ ~Ipv6OptionRouterAlert()

ns3::Ipv6OptionRouterAlert::~Ipv6OptionRouterAlert ( )
override

Destructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetOptionNumber()

uint8_t ns3::Ipv6OptionRouterAlert::GetOptionNumber ( ) const
overridevirtual

Get the option number.

Returns
option number

Implements ns3::Ipv6Option.

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

References NS_LOG_FUNCTION, and OPT_NUMBER.

◆ GetTypeId()

TypeId ns3::Ipv6OptionRouterAlert::GetTypeId ( void  )
static

Get the type identificator.

Returns
type identificator

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Process()

uint8_t ns3::Ipv6OptionRouterAlert::Process ( Ptr< Packet packet,
uint8_t  offset,
const Ipv6Header ipv6Header,
bool &  isDropped 
)
overridevirtual

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

Implements ns3::Ipv6Option.

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

References ns3::Packet::Copy(), ns3::Ipv6OptionRouterAlertHeader::GetSerializedSize(), NS_LOG_FUNCTION, ns3::Packet::RemoveAtStart(), and ns3::Packet::RemoveHeader().

+ Here is the call graph for this function:

Member Data Documentation

◆ OPT_NUMBER

const uint8_t ns3::Ipv6OptionRouterAlert::OPT_NUMBER = 43
static

Router alert option number.

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

Referenced by GetOptionNumber().


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