A Discrete-Event Network Simulator
API
ns3::dsr::DsrOptionSRHeader Class Reference

Source Route (SR) Message Format. More...

#include "dsr-option-header.h"

+ Inheritance diagram for ns3::dsr::DsrOptionSRHeader:
+ Collaboration diagram for ns3::dsr::DsrOptionSRHeader:

Public Types

typedef void(* TracedCallback) (const DsrOptionSRHeader &header)
 TracedCallback signature for DsrOptionSrHeader. More...
 

Public Member Functions

 DsrOptionSRHeader ()
 Constructor. More...
 
virtual ~DsrOptionSRHeader ()
 Destructor. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 Deserialize the packet. More...
 
virtual Alignment GetAlignment () const
 Get the Alignment requirement of this option header. More...
 
virtual TypeId GetInstanceTypeId () const
 Get the instance type ID. More...
 
Ipv4Address GetNodeAddress (uint8_t index) const
 Get a Node IPv4 Address. More...
 
uint8_t GetNodeListSize () const
 
std::vector< Ipv4AddressGetNodesAddress () const
 Get the vector of ipv4 address. More...
 
uint8_t GetSalvage () const
 
uint8_t GetSegmentsLeft () const
 
virtual uint32_t GetSerializedSize () const
 Get the serialized size of the packet. More...
 
virtual void Print (std::ostream &os) const
 Print some informations about the packet. More...
 
virtual void Serialize (Buffer::Iterator start) const
 Serialize the packet. More...
 
void SetNodeAddress (uint8_t index, Ipv4Address addr)
 Set a Node IPv4 Address. More...
 
void SetNodesAddress (std::vector< Ipv4Address > ipv4Address)
 Set the vector of ipv4 address. More...
 
void SetNumberAddress (uint8_t n)
 Set the number of ipv4 address. More...
 
void SetSalvage (uint8_t salvage)
 
void SetSegmentsLeft (uint8_t segmentsLeft)
 
- Public Member Functions inherited from ns3::dsr::DsrOptionHeader
 DsrOptionHeader ()
 Constructor. More...
 
virtual ~DsrOptionHeader ()
 Destructor. More...
 
uint8_t GetLength () const
 Get the option length. More...
 
uint8_t GetType () const
 Get the type of the option. More...
 
void SetLength (uint8_t length)
 Set the option length. More...
 
void SetType (uint8_t type)
 Set the type of the option. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
- 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::dsr::DsrOptionHeader
static TypeId GetTypeId ()
 Get the type identificator. More...
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Types

typedef std::vector< Ipv4AddressVectorIpv4Address_t
 A vector of IPv4 Address. More...
 

Private Attributes

Ipv4Address m_address
 The ip address header deserilize to. More...
 
VectorIpv4Address_t m_ipv4Address
 The vector of Nodes' IPv4 Address. More...
 
uint8_t m_salvage
 Number of savlage times for a packet. More...
 
uint8_t m_segmentsLeft
 Number of left segments. More...
 

Additional Inherited Members

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

Detailed Description

Source Route (SR) Message Format.

Header of Dsr Option Source Route.

Introspection did not find any typical Config paths.

 |      0        |      1        |      2        |      3        |
 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |  Option Type |  Opt Data Len |F|L|Reservd|Salvage|  Segs Left |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                            Address[1]                         |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                            Address[2]                         |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                               ...                             |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                            Address[n]                         |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+


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

Definition at line 569 of file dsr-option-header.h.

Member Typedef Documentation

typedef void(* ns3::dsr::DsrOptionSRHeader::TracedCallback) (const DsrOptionSRHeader &header)

TracedCallback signature for DsrOptionSrHeader.

Parameters
[in]headerThe DsrOptionsSRHeader

Definition at line 675 of file dsr-option-header.h.

A vector of IPv4 Address.

Definition at line 693 of file dsr-option-header.h.

Constructor & Destructor Documentation

ns3::dsr::DsrOptionSRHeader::DsrOptionSRHeader ( )

Constructor.

Definition at line 536 of file dsr-option-header.cc.

References m_ipv4Address, ns3::dsr::DsrOptionHeader::SetLength(), and ns3::dsr::DsrOptionHeader::SetType().

+ Here is the call graph for this function:

ns3::dsr::DsrOptionSRHeader::~DsrOptionSRHeader ( )
virtual

Destructor.

Definition at line 544 of file dsr-option-header.cc.

Member Function Documentation

uint32_t ns3::dsr::DsrOptionSRHeader::Deserialize ( Buffer::Iterator  start)
virtual
DsrOptionHeader::Alignment ns3::dsr::DsrOptionSRHeader::GetAlignment ( ) const
virtual

Get the Alignment requirement of this option header.

Returns
The required alignment

Reimplemented from ns3::dsr::DsrOptionHeader.

Definition at line 656 of file dsr-option-header.cc.

TypeId ns3::dsr::DsrOptionSRHeader::GetInstanceTypeId ( void  ) const
virtual

Get the instance type ID.

Returns
instance type ID

Reimplemented from ns3::dsr::DsrOptionHeader.

Definition at line 531 of file dsr-option-header.cc.

References GetTypeId().

+ Here is the call graph for this function:

Ipv4Address ns3::dsr::DsrOptionSRHeader::GetNodeAddress ( uint8_t  index) const

Get a Node IPv4 Address.

Parameters
indexthe index of the IPv4 Address
Returns
the router IPv4 Address

Definition at line 590 of file dsr-option-header.cc.

References m_ipv4Address.

Referenced by DsrSRHeaderTest::DoRun(), ns3::dsr::DsrOptionRerr::DoSendError(), and ns3::dsr::DsrOptionSR::Process().

+ Here is the caller graph for this function:

uint8_t ns3::dsr::DsrOptionSRHeader::GetNodeListSize ( ) const

Definition at line 595 of file dsr-option-header.cc.

References m_ipv4Address.

std::vector< Ipv4Address > ns3::dsr::DsrOptionSRHeader::GetNodesAddress ( ) const

Get the vector of ipv4 address.

Returns
the vector of ipv4 address

Definition at line 580 of file dsr-option-header.cc.

References m_ipv4Address.

Referenced by ns3::dsr::DsrRouting::CancelPacketTimerNextHop(), ns3::dsr::DsrOptionRerr::DoSendError(), ns3::dsr::DsrOptionSR::Process(), and ns3::dsr::DsrRouting::SendPacketFromBuffer().

+ Here is the caller graph for this function:

uint8_t ns3::dsr::DsrOptionSRHeader::GetSalvage ( ) const
uint8_t ns3::dsr::DsrOptionSRHeader::GetSegmentsLeft ( ) const

Definition at line 553 of file dsr-option-header.cc.

References m_segmentsLeft.

Referenced by DsrSRHeaderTest::DoRun(), ns3::dsr::DsrOptionRerr::DoSendError(), ns3::dsr::DsrRouting::ForwardPacket(), and ns3::dsr::DsrOptionSR::Process().

+ Here is the caller graph for this function:

uint32_t ns3::dsr::DsrOptionSRHeader::GetSerializedSize ( void  ) const
virtual

Get the serialized size of the packet.

Returns
size

Reimplemented from ns3::dsr::DsrOptionHeader.

Definition at line 612 of file dsr-option-header.cc.

References m_ipv4Address.

Referenced by Deserialize(), ns3::dsr::DsrOptionRerr::DoSendError(), and ns3::dsr::DsrOptionSR::Process().

+ Here is the caller graph for this function:

TypeId ns3::dsr::DsrOptionSRHeader::GetTypeId ( void  )
static

Get the type identificator.

Returns
type identificator

Definition at line 521 of file dsr-option-header.cc.

References ns3::TypeId::AddConstructor().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::dsr::DsrOptionSRHeader::Print ( std::ostream &  os) const
virtual

Print some informations about the packet.

Parameters
osoutput stream
Returns
info about this packet

Reimplemented from ns3::dsr::DsrOptionHeader.

Definition at line 600 of file dsr-option-header.cc.

References ns3::dsr::DsrOptionHeader::GetLength(), ns3::dsr::DsrOptionHeader::GetType(), and m_ipv4Address.

Referenced by ns3::dsr::operator<<().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::dsr::DsrOptionSRHeader::Serialize ( Buffer::Iterator  start) const
virtual

Serialize the packet.

Parameters
startBuffer iterator

Reimplemented from ns3::dsr::DsrOptionHeader.

Definition at line 617 of file dsr-option-header.cc.

References ns3::dsr::DsrOptionHeader::GetLength(), ns3::dsr::DsrOptionHeader::GetType(), m_ipv4Address, m_salvage, m_segmentsLeft, visualizer.core::start(), ns3::Buffer::Iterator::Write(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::dsr::DsrOptionSRHeader::SetNodeAddress ( uint8_t  index,
Ipv4Address  addr 
)

Set a Node IPv4 Address.

Parameters
indexthe index of the IPv4 Address
addrthe new IPv4 Address

Definition at line 585 of file dsr-option-header.cc.

References m_ipv4Address.

Referenced by Deserialize().

+ Here is the caller graph for this function:

void ns3::dsr::DsrOptionSRHeader::SetNumberAddress ( uint8_t  n)

Set the number of ipv4 address.

Parameters
nthe number of ipv4' address

Definition at line 568 of file dsr-option-header.cc.

References m_ipv4Address.

Referenced by ns3::dsr::DsrRouting::AddAckReqHeader(), ns3::dsr::DsrRouting::CancelPacketTimerNextHop(), DsrSRHeaderTest::DoRun(), ns3::dsr::DsrOptionRerr::DoSendError(), ns3::dsr::DsrOptionSR::Process(), and ns3::dsr::DsrRouting::SalvagePacket().

+ Here is the caller graph for this function:

Member Data Documentation

Ipv4Address ns3::dsr::DsrOptionSRHeader::m_address
private

The ip address header deserilize to.

Definition at line 681 of file dsr-option-header.h.

Referenced by Deserialize().

VectorIpv4Address_t ns3::dsr::DsrOptionSRHeader::m_ipv4Address
private
uint8_t ns3::dsr::DsrOptionSRHeader::m_salvage
private

Number of savlage times for a packet.

Definition at line 689 of file dsr-option-header.h.

Referenced by Deserialize(), GetSalvage(), Serialize(), and SetSalvage().

uint8_t ns3::dsr::DsrOptionSRHeader::m_segmentsLeft
private

Number of left segments.

Definition at line 685 of file dsr-option-header.h.

Referenced by Deserialize(), GetSegmentsLeft(), Serialize(), and SetSegmentsLeft().


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