A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::Ipv6Extension Class Referenceabstract

Doxygen introspection did not find any typical Config paths. 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 &isDropped)=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 &isDropped)
 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 ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
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)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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
 
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)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Attributes

TracedCallback< Ptr< const
Packet > > 
m_dropTrace
 Drop trace callback. More...
 
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)
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

Doxygen introspection did not find any typical Config paths.

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.


Attributes

TraceSources

  • Drop: Drop IPv6 packet

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

Constructor & Destructor Documentation

ns3::Ipv6Extension::Ipv6Extension ( )

Constructor.

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

References m_uvar, and NS_LOG_FUNCTION_NOARGS.

ns3::Ipv6Extension::~Ipv6Extension ( )
virtual

Destructor.

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

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 179 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:

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:

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

Get the type identificator.

Returns
type identificator

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

References GetExtensionNumber(), m_dropTrace, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

virtual uint8_t ns3::Ipv6Extension::Process ( Ptr< Packet > &  packet,
uint8_t  offset,
Ipv6Header const &  ipv6Header,
Ipv6Address  dst,
uint8_t *  nextHeader,
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
dstdestination address of the packet received (i.e. us)
nextHeaderthe next header
isDroppedif the packet must be dropped
Returns
the size processed

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

uint8_t ns3::Ipv6Extension::ProcessOptions ( Ptr< Packet > &  packet,
uint8_t  offset,
uint8_t  length,
Ipv6Header const &  ipv6Header,
Ipv6Address  dst,
uint8_t *  nextHeader,
bool &  isDropped 
)
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
isDroppedif the packet must be dropped
Returns
the size processed

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

References ns3::Packet::AddHeader(), ns3::Packet::Copy(), ns3::Packet::CopyData(), data, ns3::Ipv6Header::GetDestinationAddress(), GetNode(), ns3::Object::GetObject(), ns3::Packet::GetSize(), ns3::Ipv6Header::GetSourceAddress(), ns3::Icmpv6Header::ICMPV6_UNKNOWN_OPTION, ns3::Ipv6Address::IsMulticast(), m_dropTrace, 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:

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

Set the node.

Parameters
nodethe node to set

Definition at line 76 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

TracedCallback<Ptr<const Packet> > ns3::Ipv6Extension::m_dropTrace
protected
Ptr<Node> ns3::Ipv6Extension::m_node
private
Ptr<UniformRandomVariable> ns3::Ipv6Extension::m_uvar
protected

Provides uniform random variables.

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

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


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