A Discrete-Event Network Simulator
API
ns3::Ipv6Extension Class Referenceabstract

IPv6 Extension base If you want to implement a new IPv6 extension, all you have to do is implement a subclass of this class and add it to an Ipv6ExtensionDemux. More...

#include "ipv6-extension.h"

+ Inheritance diagram for ns3::Ipv6Extension:
+ Collaboration diagram for ns3::Ipv6Extension:

Public Member Functions

 Ipv6Extension ()
 Constructor. More...
 
virtual ~Ipv6Extension ()
 Destructor. More...
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
virtual uint8_t GetExtensionNumber () const =0
 Get the extension number. More...
 
Ptr< NodeGetNode () const
 Get the node. More...
 
virtual uint8_t Process (Ptr< Packet > &packet, uint8_t offset, Ipv6Header const &ipv6Header, Ipv6Address dst, uint8_t *nextHeader, bool &stopProcessing, bool &isDropped, Ipv6L3Protocol::DropReason &dropReason)=0
 Process method Called from Ipv6L3Protocol::Receive. More...
 
virtual uint8_t ProcessOptions (Ptr< Packet > &packet, uint8_t offset, uint8_t length, Ipv6Header const &ipv6Header, Ipv6Address dst, uint8_t *nextHeader, bool &stopProcessing, bool &isDropped, Ipv6L3Protocol::DropReason &dropReason)
 Process options Called by implementing classes to process the options. More...
 
void SetNode (Ptr< Node > node)
 Set the node. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) 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 erros. 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::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Attributes

Ptr< UniformRandomVariablem_uvar
 Provides uniform random variables. More...
 

Private Attributes

Ptr< Nodem_node
 The node. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

IPv6 Extension base If you want to implement a new IPv6 extension, all you have to do is implement a subclass of this class and add it to an Ipv6ExtensionDemux.


Introspection did not find any typical Config paths.


Attributes

  • ExtensionNumber: The IPv6 extension number.

No TraceSources are defined for this type.
Size of this type is 48 bytes (on a 64-bit architecture).

Definition at line 55 of file ipv6-extension.h.

Constructor & Destructor Documentation

◆ Ipv6Extension()

ns3::Ipv6Extension::Ipv6Extension ( )

Constructor.

Definition at line 62 of file ipv6-extension.cc.

References m_uvar, and NS_LOG_FUNCTION_NOARGS.

◆ ~Ipv6Extension()

ns3::Ipv6Extension::~Ipv6Extension ( )
virtual

Destructor.

Definition at line 69 of file ipv6-extension.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::Ipv6Extension::AssignStreams ( int64_t  stream)

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Definition at line 183 of file ipv6-extension.cc.

References m_uvar, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

Referenced by ns3::InternetStackHelper::AssignStreams().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetExtensionNumber()

virtual uint8_t ns3::Ipv6Extension::GetExtensionNumber ( ) const
pure virtual

Get the extension number.

Returns
extension number

Implemented in ns3::Ipv6ExtensionAH, ns3::Ipv6ExtensionESP, ns3::Ipv6ExtensionRouting, ns3::Ipv6ExtensionFragment, ns3::Ipv6ExtensionDestination, and ns3::Ipv6ExtensionHopByHop.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetNode()

Ptr< Node > ns3::Ipv6Extension::GetNode ( void  ) const

◆ GetTypeId()

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

Get the type identificator.

Returns
type identificator

Definition at line 49 of file ipv6-extension.cc.

References GetExtensionNumber(), ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Process()

virtual uint8_t ns3::Ipv6Extension::Process ( Ptr< Packet > &  packet,
uint8_t  offset,
Ipv6Header const &  ipv6Header,
Ipv6Address  dst,
uint8_t *  nextHeader,
bool &  stopProcessing,
bool &  isDropped,
Ipv6L3Protocol::DropReason dropReason 
)
pure virtual

Process method Called from Ipv6L3Protocol::Receive.

Parameters
packetthe packet
offsetthe offset of the extension to process
ipv6Headerthe IPv6 header of packet received
dstdestination address of the packet received (i.e. us)
nextHeaderthe next header
stopProcessingtrue if the packet must not be further processed
isDroppedtrue if the packet must be dropped
dropReasondropping reason
Returns
the size processed

Implemented in ns3::Ipv6ExtensionAH, ns3::Ipv6ExtensionESP, ns3::Ipv6ExtensionLooseRouting, ns3::Ipv6ExtensionRouting, ns3::Ipv6ExtensionFragment, ns3::Ipv6ExtensionDestination, and ns3::Ipv6ExtensionHopByHop.

◆ ProcessOptions()

uint8_t ns3::Ipv6Extension::ProcessOptions ( Ptr< Packet > &  packet,
uint8_t  offset,
uint8_t  length,
Ipv6Header const &  ipv6Header,
Ipv6Address  dst,
uint8_t *  nextHeader,
bool &  stopProcessing,
bool &  isDropped,
Ipv6L3Protocol::DropReason dropReason 
)
virtual

Process options Called by implementing classes to process the options.

Parameters
packetthe packet
offsetthe offset of the first option to process
lengththe total length of all options (as specified in the extension header)
ipv6Headerthe IPv6 header of packet received
dstdestination address of the packet received (i.e. us)
nextHeaderthe next header
stopProcessingtrue if the packet must not be further processed
isDroppedtrue if the packet must be dropped
dropReasondropping reason
Returns
the size processed

Definition at line 88 of file ipv6-extension.cc.

References ns3::Packet::AddHeader(), ns3::Packet::Copy(), ns3::Packet::CopyData(), data, ns3::Ipv6L3Protocol::DROP_UNKNOWN_OPTION, ns3::Ipv6Header::GetDestinationAddress(), GetNode(), ns3::Object::GetObject(), ns3::Packet::GetSize(), ns3::Ipv6Header::GetSourceAddress(), ns3::Icmpv6Header::ICMPV6_UNKNOWN_OPTION, ns3::Ipv6Address::IsMulticast(), NS_LOG_FUNCTION, NS_LOG_LOGIC(), and ns3::Packet::RemoveAtStart().

Referenced by ns3::Ipv6ExtensionHopByHop::Process(), and ns3::Ipv6ExtensionDestination::Process().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetNode()

void ns3::Ipv6Extension::SetNode ( Ptr< Node node)

Set the node.

Parameters
nodethe node to set

Definition at line 74 of file ipv6-extension.cc.

References m_node, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6L3Protocol::RegisterExtensions().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_node

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

◆ m_uvar

Ptr<UniformRandomVariable> ns3::Ipv6Extension::m_uvar
protected

Provides uniform random variables.

Definition at line 155 of file ipv6-extension.h.

Referenced by AssignStreams(), ns3::Ipv6ExtensionFragment::GetFragments(), and Ipv6Extension().


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