A Discrete-Event Network Simulator
API
ns3::Ipv6ExtensionFragment Class Reference

IPv6 Extension Fragment. More...

#include "ipv6-extension.h"

+ Inheritance diagram for ns3::Ipv6ExtensionFragment:
+ Collaboration diagram for ns3::Ipv6ExtensionFragment:

Classes

class  Fragments
 This class stores the fragments of a packet waiting to be rebuilt. More...
 

Public Types

typedef std::pair< Ptr< Packet >, Ipv6HeaderIpv6PayloadHeaderPair
 Pair of a packet and an Ipv6 header. More...
 

Public Member Functions

 Ipv6ExtensionFragment ()
 Constructor. More...
 
 ~Ipv6ExtensionFragment ()
 Destructor. More...
 
virtual uint8_t GetExtensionNumber () const
 Get the extension number. More...
 
void GetFragments (Ptr< Packet > packet, Ipv6Header ipv6Header, uint32_t fragmentSize, std::list< Ipv6PayloadHeaderPair > &listFragments)
 Fragment a packet. 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)
 Process method Called from Ipv6L3Protocol::Receive. More...
 
- Public Member Functions inherited from ns3::Ipv6Extension
 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...
 
Ptr< NodeGetNode () const
 Get the node. 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::Ipv6Extension
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...
 

Static Public Attributes

static const uint8_t EXT_NUMBER = 44
 Fragmentation extension number. More...
 

Protected Member Functions

virtual void DoDispose ()
 Dispose this object. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. 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...
 

Private Types

typedef std::pair< Ipv6Address, uint32_t > FragmentKey_t
 Key identifying a fragmented packet. More...
 
typedef std::list< std::tuple< Time, FragmentKey_t, Ipv6Header > > FragmentsTimeoutsList_t
 Container for fragment timeouts. More...
 
typedef std::list< std::tuple< Time, FragmentKey_t, Ipv6Header > >::iterator FragmentsTimeoutsListI_t
 Container Iterator for fragment timeouts. More...
 
typedef std::map< FragmentKey_t, Ptr< Fragments > > MapFragments_t
 Container for the packet fragments. More...
 

Private Member Functions

void CancelTimeout ()
 Cancel the timeout event. More...
 
Ptr< PacketGetPartialPacket () const
 Get the packet parts so far received. More...
 
void HandleFragmentsTimeout (FragmentKey_t key, Ipv6Header ipHeader)
 Process the timeout for packet fragments. More...
 
void HandleTimeout (void)
 Handles a fragmented packet timeout. More...
 
FragmentsTimeoutsListI_t SetTimeout (FragmentKey_t key, Ipv6Header ipHeader)
 Set a new timeout "event" for a fragmented packet. More...
 
void SetTimeoutEventId (EventId event)
 Set the Timeout EventId. More...
 

Private Attributes

Time m_fragmentExpirationTimeout
 Expiration timeout. More...
 
MapFragments_t m_fragments
 The hash of fragmented packets. More...
 
EventId m_timeoutEvent
 Event for the next scheduled timeout. More...
 
FragmentsTimeoutsList_t m_timeoutEventList
 Timeout "events" container. More...
 

Additional Inherited Members

- Protected Attributes inherited from ns3::Ipv6Extension
Ptr< UniformRandomVariablem_uvar
 Provides uniform random variables. More...
 

Detailed Description

IPv6 Extension Fragment.


Introspection did not find any typical Config paths.


Attributes

  • FragmentExpirationTimeout: When this timeout expires, the fragments will be cleared from the buffer.
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +60000000000.0ns
    • Flags: construct write read

Attributes defined in parent class ns3::Ipv6Extension

  • ExtensionNumber: The IPv6 extension number.

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

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

Member Typedef Documentation

◆ FragmentKey_t

typedef std::pair<Ipv6Address, uint32_t> ns3::Ipv6ExtensionFragment::FragmentKey_t
private

Key identifying a fragmented packet.

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

◆ FragmentsTimeoutsList_t

Container for fragment timeouts.

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

◆ FragmentsTimeoutsListI_t

Container Iterator for fragment timeouts.

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

◆ Ipv6PayloadHeaderPair

Pair of a packet and an Ipv6 header.

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

◆ MapFragments_t

Container for the packet fragments.

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

Constructor & Destructor Documentation

◆ Ipv6ExtensionFragment()

ns3::Ipv6ExtensionFragment::Ipv6ExtensionFragment ( )

Constructor.

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

References NS_LOG_FUNCTION_NOARGS.

◆ ~Ipv6ExtensionFragment()

ns3::Ipv6ExtensionFragment::~Ipv6ExtensionFragment ( )

Destructor.

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ CancelTimeout()

void ns3::Ipv6ExtensionFragment::CancelTimeout ( )
private

Cancel the timeout event.

◆ DoDispose()

void ns3::Ipv6ExtensionFragment::DoDispose ( void  )
protectedvirtual

Dispose this object.

Reimplemented from ns3::Object.

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

References ns3::EventId::Cancel(), ns3::Object::DoDispose(), ns3::EventId::IsRunning(), m_fragments, m_timeoutEvent, m_timeoutEventList, and NS_LOG_FUNCTION_NOARGS.

+ Here is the call graph for this function:

◆ GetExtensionNumber()

uint8_t ns3::Ipv6ExtensionFragment::GetExtensionNumber ( ) const
virtual

Get the extension number.

Returns
extension number

Implements ns3::Ipv6Extension.

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

References EXT_NUMBER, and NS_LOG_FUNCTION_NOARGS.

◆ GetFragments()

void ns3::Ipv6ExtensionFragment::GetFragments ( Ptr< Packet packet,
Ipv6Header  ipv6Header,
uint32_t  fragmentSize,
std::list< Ipv6PayloadHeaderPair > &  listFragments 
)

◆ GetPartialPacket()

Ptr<Packet> ns3::Ipv6ExtensionFragment::GetPartialPacket ( ) const
private

Get the packet parts so far received.

Returns
the partial packet

◆ GetTypeId()

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

Get the type identificator.

Returns
type identificator

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

References m_fragmentExpirationTimeout, ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ HandleFragmentsTimeout()

void ns3::Ipv6ExtensionFragment::HandleFragmentsTimeout ( FragmentKey_t  key,
Ipv6Header  ipHeader 
)
private

Process the timeout for packet fragments.

Parameters
keyrepresenting the packet fragments
ipHeaderthe IP header of the original packet

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

References ns3::Packet::AddHeader(), ns3::Packet::Copy(), ns3::Ipv6L3Protocol::DROP_FRAGMENT_TIMEOUT, ns3::Ipv6Extension::GetNode(), ns3::Object::GetObject(), ns3::Packet::GetSize(), ns3::Ipv6Header::GetSourceAddress(), ns3::Icmpv6Header::ICMPV6_FRAGTIME, m_fragments, and NS_ASSERT_MSG().

Referenced by HandleTimeout().

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

◆ HandleTimeout()

void ns3::Ipv6ExtensionFragment::HandleTimeout ( void  )
private

Handles a fragmented packet timeout.

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

References HandleFragmentsTimeout(), m_timeoutEvent, m_timeoutEventList, ns3::Simulator::Now(), and ns3::Simulator::Schedule().

Referenced by SetTimeout().

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

◆ Process()

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

◆ SetTimeout()

Ipv6ExtensionFragment::FragmentsTimeoutsListI_t ns3::Ipv6ExtensionFragment::SetTimeout ( FragmentKey_t  key,
Ipv6Header  ipHeader 
)
private

Set a new timeout "event" for a fragmented packet.

Parameters
keythe fragment identification
ipHeaderthe IPv6 header of the fragmented packet
Returns
an iterator to the inserted "event"

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

References HandleTimeout(), m_fragmentExpirationTimeout, m_timeoutEvent, m_timeoutEventList, ns3::Simulator::Now(), and ns3::Simulator::Schedule().

Referenced by Process().

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

◆ SetTimeoutEventId()

void ns3::Ipv6ExtensionFragment::SetTimeoutEventId ( EventId  event)
private

Set the Timeout EventId.

Parameters
eventThe event.

Member Data Documentation

◆ EXT_NUMBER

const uint8_t ns3::Ipv6ExtensionFragment::EXT_NUMBER = 44
static

◆ m_fragmentExpirationTimeout

Time ns3::Ipv6ExtensionFragment::m_fragmentExpirationTimeout
private

Expiration timeout.

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

Referenced by GetTypeId(), and SetTimeout().

◆ m_fragments

MapFragments_t ns3::Ipv6ExtensionFragment::m_fragments
private

The hash of fragmented packets.

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

Referenced by DoDispose(), HandleFragmentsTimeout(), and Process().

◆ m_timeoutEvent

EventId ns3::Ipv6ExtensionFragment::m_timeoutEvent
private

Event for the next scheduled timeout.

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

Referenced by DoDispose(), HandleTimeout(), and SetTimeout().

◆ m_timeoutEventList

FragmentsTimeoutsList_t ns3::Ipv6ExtensionFragment::m_timeoutEventList
private

Timeout "events" container.

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

Referenced by DoDispose(), HandleTimeout(), Process(), and SetTimeout().


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