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

Doxygen introspection did not find any typical Config paths. More...

#include <ipv6-option.h>

+ Inheritance diagram for ns3::Ipv6Option:
+ Collaboration diagram for ns3::Ipv6Option:

Public Member Functions

virtual ~Ipv6Option ()
 Destructor. More...
 
virtual uint8_t GetOptionNumber () const =0
 Get the option number. More...
 
virtual uint8_t Process (Ptr< Packet > packet, uint8_t offset, Ipv6Header const &ipv6Header, bool &isDropped)=0
 Process method. 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...
 

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 Option base.


Attributes

No TraceSources are defined for this type.

If you want to implement a new IPv6 option, all you have to do is implement a subclass of this class and add it to an Ipv6OptionDemux.

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

Constructor & Destructor Documentation

ns3::Ipv6Option::~Ipv6Option ( )
virtual

Destructor.

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

virtual uint8_t ns3::Ipv6Option::GetOptionNumber ( ) const
pure virtual

Get the option number.

Returns
option number

Implemented in ns3::Ipv6OptionRouterAlert, ns3::Ipv6OptionJumbogram, ns3::Ipv6OptionPadn, and ns3::Ipv6OptionPad1.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

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

Get the type identificator.

Returns
type identificator

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

References GetOptionNumber(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

virtual uint8_t ns3::Ipv6Option::Process ( Ptr< Packet packet,
uint8_t  offset,
Ipv6Header const &  ipv6Header,
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
isDroppedif the packet must be dropped
Returns
the processed size

Implemented in ns3::Ipv6OptionRouterAlert, ns3::Ipv6OptionJumbogram, ns3::Ipv6OptionPadn, and ns3::Ipv6OptionPad1.

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

Set the node.

Parameters
nodethe node to set

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

References m_node, and NS_LOG_FUNCTION.

Member Data Documentation

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

The node.

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

Referenced by SetNode().


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