A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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 <introspected-doxygen.h>

+ Inheritance diagram for ns3::Ipv6Extension:

Public Member Functions

 Ipv6Extension ()
 Constructor.
 
virtual ~Ipv6Extension ()
 Destructor.
 
int64_t AssignStreams (int64_t stream)
 
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
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
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)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
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)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Protected Attributes

TracedCallback< Ptr< const
Packet > > 
m_dropTrace
 Drop trace callback.
 
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)
 
virtual void DoDispose (void)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

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.

Doxygen introspection did not find any typical Config paths.

Attributes

TraceSources

  • Drop: Drop ipv6 packet

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

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

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

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

virtual uint8_t ns3::Ipv6Extension::GetExtensionNumber ( ) const
pure virtual
TypeId ns3::Ipv6Extension::GetTypeId ( void  )
static

Get the type identificator.

Returns
type identificator

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

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

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

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

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

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

Set the node.

Parameters
nodethe node to set

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

References m_node, and NS_LOG_FUNCTION.

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


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