A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
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.
 
 ~Ipv6Extension () override
 Destructor.
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model.
 
virtual uint8_t GetExtensionNumber () const =0
 Get the extension number.
 
Ptr< NodeGetNode () const
 Get the node.
 
virtual uint8_t Process (Ptr< Packet > &packet, uint8_t offset, const Ipv6Header &ipv6Header, Ipv6Address dst, uint8_t *nextHeader, bool &stopProcessing, bool &isDropped, Ipv6L3Protocol::DropReason &dropReason)=0
 Process method Called from Ipv6L3Protocol::Receive.
 
virtual uint8_t ProcessOptions (Ptr< Packet > &packet, uint8_t offset, uint8_t length, const Ipv6Header &ipv6Header, Ipv6Address dst, uint8_t *nextHeader, bool &stopProcessing, bool &isDropped, Ipv6L3Protocol::DropReason &dropReason)
 Process options Called by implementing classes to process the options.
 
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.
 
- 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) 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.
 
virtual TypeId GetInstanceTypeId () const =0
 Get the most derived TypeId for this Object.
 
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.
 

Protected Attributes

Ptr< UniformRandomVariablem_uvar
 Provides uniform random variables.
 

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 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 56 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.

◆ ~Ipv6Extension()

ns3::Ipv6Extension::~Ipv6Extension ( )
override

Destructor.

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

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 188 of file ipv6-extension.cc.

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

+ Here is the call graph for this function:

◆ GetExtensionNumber()

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

Get the extension number.

Returns
extension number

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

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetNode()

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

Get the node.

Returns
the node

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

References m_node.

Referenced by ns3::Ipv6ExtensionFragment::GetFragments(), ns3::Ipv6ExtensionFragment::HandleFragmentsTimeout(), ns3::Ipv6ExtensionRouting::Process(), ns3::Ipv6ExtensionLooseRouting::Process(), and ProcessOptions().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::Ipv6Extension::GetTypeId ( )
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,
const Ipv6Header 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::Ipv6ExtensionHopByHop, ns3::Ipv6ExtensionDestination, ns3::Ipv6ExtensionFragment, ns3::Ipv6ExtensionRouting, ns3::Ipv6ExtensionLooseRouting, ns3::Ipv6ExtensionESP, and ns3::Ipv6ExtensionAH.

◆ ProcessOptions()

uint8_t ns3::Ipv6Extension::ProcessOptions ( Ptr< Packet > &  packet,
uint8_t  offset,
uint8_t  length,
const Ipv6Header 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 86 of file ipv6-extension.cc.

References data, ns3::Ipv6L3Protocol::DROP_UNKNOWN_OPTION, ns3::Ipv6Header::GetDestination(), GetNode(), ns3::Object::GetObject(), ns3::Ipv6Header::GetSource(), ns3::Icmpv6Header::ICMPV6_UNKNOWN_OPTION, ns3::Ipv6Address::IsMulticast(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

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 72 of file ipv6-extension.cc.

References m_node, and NS_LOG_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 Ipv6Extension(), AssignStreams(), and ns3::Ipv6ExtensionFragment::GetFragments().


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