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

#include <dsr-option-header.h>

Inheritance diagram for ns3::dsr::DsrOptionSRHeader:

Collaboration diagram for ns3::dsr::DsrOptionSRHeader:

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

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type identificator.

Private Types
typedef std::vector< Ipv4Address >	VectorIpv4Address_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 Typedef Documentation

typedef std::vector<Ipv4Address> ns3::dsr::DsrOptionSRHeader::VectorIpv4Address_t

private

A vector of IPv4 Address.

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

Constructor & Destructor Documentation

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

Constructor.

Definition at line 528 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 536 of file dsr-option-header.cc.

Member Function Documentation

uint32_t ns3::dsr::DsrOptionSRHeader::Deserialize ( Buffer::Iterator start )

virtual

Deserialize the packet.

Parameters

start Buffer iterator

Returns: size of the packet

Reimplemented from ns3::dsr::DsrOptionHeader.

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

References ns3::Ipv4Address::Deserialize(), GetSerializedSize(), m_address, m_ipv4Address, m_salvage, m_segmentsLeft, ns3::Buffer::Iterator::Read(), ns3::Buffer::Iterator::ReadU8(), ns3::dsr::DsrOptionHeader::SetLength(), SetNodeAddress(), ns3::dsr::DsrOptionHeader::SetType(), and visualizer.core::start().

Here is the call graph for this function:

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

Here is the call graph for this function:

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

Get a Node IPv4 Address.

Parameters

index the 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().

Here is the caller graph for this function:

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

Definition at line 587 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 572 of file dsr-option-header.cc.

References m_ipv4Address.

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

Here is the caller graph for this function:

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

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

References m_salvage.

Referenced by ns3::dsr::DsrSRHeaderTest::DoRun(), ns3::dsr::DsrOptionRerr::DoSendError(), ns3::dsr::DsrRouting::LinkScheduleTimerExpire(), ns3::dsr::DsrRouting::NetworkScheduleTimerExpire(), ns3::dsr::DsrOptionSR::Process(), ns3::dsr::DsrRouting::SalvagePacket(), and ns3::dsr::DsrRouting::SendRerrWhenBreaksLinkToNextHop().

Here is the caller graph for this function:

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

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

References m_segmentsLeft.

Referenced by ns3::dsr::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 604 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

Reimplemented from ns3::dsr::DsrOptionHeader.

Definition at line 514 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

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

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

start Buffer iterator

Reimplemented from ns3::dsr::DsrOptionHeader.

Definition at line 609 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

index	the index of the IPv4 Address
addr	the new IPv4 Address

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

References m_ipv4Address.

Referenced by Deserialize().

Here is the caller graph for this function:

void ns3::dsr::DsrOptionSRHeader::SetNodesAddress ( std::vector< Ipv4Address > ipv4Address )

Set the vector of ipv4 address.

Parameters

ipv4Address the vector of ipv4 address

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

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

Referenced by ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::dsr::DsrSRHeaderTest::DoRun(), ns3::dsr::DsrOptionRerr::DoSendError(), ns3::dsr::DsrRouting::PacketNewRoute(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrOptionRrep::Process(), ns3::dsr::DsrOptionSR::Process(), ns3::dsr::DsrRouting::RouteRequestTimerExpire(), ns3::dsr::DsrRouting::SalvagePacket(), ns3::dsr::DsrRouting::Send(), ns3::dsr::DsrRouting::SendErrorRequest(), ns3::dsr::DsrRouting::SendRerrWhenBreaksLinkToNextHop(), and ns3::dsr::DsrRouting::SendUnreachError().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Set the number of ipv4 address.

Parameters

n	the number of ipv4' address

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

References m_ipv4Address.

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

Here is the caller graph for this function:

void ns3::dsr::DsrOptionSRHeader::SetSalvage ( uint8_t salvage )

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

References m_salvage.

Referenced by ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::dsr::DsrSRHeaderTest::DoRun(), ns3::dsr::DsrOptionRerr::DoSendError(), ns3::dsr::DsrRouting::PacketNewRoute(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrOptionRrep::Process(), ns3::dsr::DsrOptionSR::Process(), ns3::dsr::DsrRouting::RouteRequestTimerExpire(), ns3::dsr::DsrRouting::SalvagePacket(), ns3::dsr::DsrRouting::Send(), ns3::dsr::DsrRouting::SendErrorRequest(), and ns3::dsr::DsrRouting::SendRerrWhenBreaksLinkToNextHop().

Here is the caller graph for this function:

void ns3::dsr::DsrOptionSRHeader::SetSegmentsLeft ( uint8_t segmentsLeft )

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

References m_segmentsLeft.

Referenced by ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::dsr::DsrSRHeaderTest::DoRun(), ns3::dsr::DsrOptionRerr::DoSendError(), ns3::dsr::DsrRouting::PacketNewRoute(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrOptionRrep::Process(), ns3::dsr::DsrOptionSR::Process(), ns3::dsr::DsrRouting::RouteRequestTimerExpire(), ns3::dsr::DsrRouting::SalvagePacket(), ns3::dsr::DsrRouting::Send(), ns3::dsr::DsrRouting::SendErrorRequest(), ns3::dsr::DsrRouting::SendRerrWhenBreaksLinkToNextHop(), and ns3::dsr::DsrRouting::SendUnreachError().

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 694 of file dsr-option-header.h.

Referenced by Deserialize().

VectorIpv4Address_t ns3::dsr::DsrOptionSRHeader::m_ipv4Address

private

The vector of Nodes' IPv4 Address.

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

Referenced by Deserialize(), DsrOptionSRHeader(), GetNodeAddress(), GetNodeListSize(), GetNodesAddress(), GetSerializedSize(), Print(), Serialize(), SetNodeAddress(), SetNodesAddress(), and SetNumberAddress().

uint8_t ns3::dsr::DsrOptionSRHeader::m_salvage

private

Number of savlage times for a packet.

Definition at line 702 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 698 of file dsr-option-header.h.

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

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

src/dsr/model/dsr-option-header.h
src/dsr/model/dsr-option-header.cc

Public Member Functions

Static Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation