A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::dsr::DsrOptionSRHeader Class Reference

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

#include <dsr-option-header.h>

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

Public Member Functions

 DsrOptionSRHeader ()
 Constructor.
 
virtual ~DsrOptionSRHeader ()
 Destructor.
 
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.
 
virtual ~DsrOptionHeader ()
 Destructor.
 
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::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::dsr::DsrOptionHeader
static TypeId GetTypeId ()
 Get the type identificator. More...
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Types

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

Private Attributes

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

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

Source Route (SR) Message Format.

Header of Dsr Option Source Route.

 |      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]                         |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

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

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 648 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 523 of file dsr-option-header.cc.

References GetTypeId().

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 582 of file dsr-option-header.cc.

References m_ipv4Address.

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

std::vector< Ipv4Address > ns3::dsr::DsrOptionSRHeader::GetNodesAddress ( ) const
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 604 of file dsr-option-header.cc.

References m_ipv4Address.

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

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

Get the type identificator.

Returns
type identificator

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

References ns3::TypeId::AddConstructor().

Referenced by GetInstanceTypeId().

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 592 of file dsr-option-header.cc.

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

void ns3::dsr::DsrOptionSRHeader::Serialize ( Buffer::Iterator  start) const
virtual
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 577 of file dsr-option-header.cc.

References m_ipv4Address.

Referenced by Deserialize().


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