A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::dsr::DsrFsHeader Class Reference
DSR Routing

Dsr fixed size header Format. More...

#include "dsr-fs-header.h"

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

Public Member Functions

 DsrFsHeader ()
 Constructor.
 
 ~DsrFsHeader () override
 Destructor.
 
uint32_t Deserialize (Buffer::Iterator start) override
 Deserialize the packet.
 
uint16_t GetDestId () const
 brief Get the dest ID of the header.
 
TypeId GetInstanceTypeId () const override
 Get the instance type ID.
 
uint8_t GetMessageType () const
 brief Get the message type of the header.
 
uint8_t GetNextHeader () const
 Get the next header.
 
uint16_t GetPayloadLength () const
 Get the payload length of the header.
 
uint32_t GetSerializedSize () const override
 Get the serialized size of the packet.
 
uint16_t GetSourceId () const
 brief Get the source ID of the header.
 
void Print (std::ostream &os) const override
 Print some information about the packet.
 
void Serialize (Buffer::Iterator start) const override
 Serialize the packet.
 
void SetDestId (uint16_t destId)
 brief Set the dest ID of the header.
 
void SetMessageType (uint8_t messageType)
 brief Set the message type of the header.
 
void SetNextHeader (uint8_t protocol)
 Set the "Next header" field.
 
void SetPayloadLength (uint16_t length)
 brief Set the payload length of the header.
 
void SetSourceId (uint16_t sourceId)
 brief Set the source ID of the header.
 
- Public Member Functions inherited from ns3::Header
 ~Header () override
 
uint32_t Deserialize (Buffer::Iterator start) override=0
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator.
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator.
 
virtual uint32_t GetSerializedSize () const =0
 
void Print (std::ostream &os) const override=0
 
virtual void Serialize (Buffer::Iterator start) const =0
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator.
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator.
 
virtual void Print (std::ostream &os) const =0
 Print the object contents.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
virtual TypeId GetInstanceTypeId () const =0
 Get the most derived TypeId for this Object.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type identificator.
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Private Attributes

Buffer m_data
 The data of the extension.
 
uint16_t m_destId
 The destination node id.
 
uint8_t m_messageType
 The type of the message.
 
uint8_t m_nextHeader
 The "next header" field.
 
uint16_t m_payloadLen
 The "payload length" field.
 
uint16_t m_sourceId
 The source node id.
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 
- Related Functions inherited from ns3::ObjectBase
static TypeId GetObjectIid ()
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.
 

Detailed Description

Dsr fixed size header Format. 

 |      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
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |  Next Header |F|     Reservd    |       Payload Length       |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                            Options                           |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

The modified version of Dsr fixed size header Format 

 |      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
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |  Next Header |F|  Message Type  |       Payload Length       |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |             Source Id           |            Dest Id         |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                            Options                           |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Definition at line 81 of file dsr-fs-header.h.

Constructor & Destructor Documentation

◆ DsrFsHeader()

ns3::dsr::DsrFsHeader::DsrFsHeader ( )

Constructor.

Definition at line 65 of file dsr-fs-header.cc.

◆ ~DsrFsHeader()

ns3::dsr::DsrFsHeader::~DsrFsHeader ( )
override

Destructor.

Definition at line 75 of file dsr-fs-header.cc.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::dsr::DsrFsHeader::Deserialize ( Buffer::Iterator  start)
overridevirtual

Deserialize the packet.

Parameters
startBuffer iterator
Returns
size of the packet

Implements ns3::Header.

Reimplemented in ns3::dsr::DsrRoutingHeader.

Definition at line 169 of file dsr-fs-header.cc.

References ns3::Buffer::AddAtEnd(), ns3::Buffer::Begin(), data, GetPayloadLength(), GetSerializedSize(), ns3::Buffer::GetSize(), m_data, m_destId, m_messageType, m_nextHeader, m_payloadLen, m_sourceId, ns3::Buffer::Iterator::Read(), ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU8(), ns3::Buffer::RemoveAtEnd(), and ns3::Buffer::Iterator::Write().

+ Here is the call graph for this function:

◆ GetDestId()

uint16_t ns3::dsr::DsrFsHeader::GetDestId ( ) const

brief Get the dest ID of the header.

Returns
dest ID the dest ID of the header

Definition at line 134 of file dsr-fs-header.cc.

References m_destId.

Referenced by ns3::dsr::DsrRouting::AddAckReqHeader(), Print(), ns3::dsr::DsrRoutingHeader::Print(), ns3::dsr::DsrRouting::PromiscReceive(), and ns3::dsr::DsrRoutingHeader::Serialize().

+ Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::dsr::DsrFsHeader::GetInstanceTypeId ( ) const
overridevirtual

Get the instance type ID.

Returns
instance type ID

Implements ns3::ObjectBase.

Reimplemented in ns3::dsr::DsrRoutingHeader.

Definition at line 60 of file dsr-fs-header.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetMessageType()

uint8_t ns3::dsr::DsrFsHeader::GetMessageType ( ) const

brief Get the message type of the header.

Returns
message type the message type of the header

Definition at line 98 of file dsr-fs-header.cc.

References m_messageType.

Referenced by Print(), ns3::dsr::DsrRoutingHeader::Print(), ns3::dsr::DsrRouting::PromiscReceive(), and ns3::dsr::DsrRoutingHeader::Serialize().

+ Here is the caller graph for this function:

◆ GetNextHeader()

uint8_t ns3::dsr::DsrFsHeader::GetNextHeader ( ) const

Get the next header.

Returns
the next header number

Definition at line 86 of file dsr-fs-header.cc.

References m_nextHeader.

Referenced by ns3::dsr::DsrRouting::AddAckReqHeader(), Print(), ns3::dsr::DsrRoutingHeader::Print(), ns3::dsr::DsrRouting::PromiscReceive(), ns3::dsr::DsrRouting::Receive(), and ns3::dsr::DsrRoutingHeader::Serialize().

+ Here is the caller graph for this function:

◆ GetPayloadLength()

uint16_t ns3::dsr::DsrFsHeader::GetPayloadLength ( ) const

Get the payload length of the header.

Returns
the payload length of the header

Definition at line 110 of file dsr-fs-header.cc.

References m_payloadLen.

Referenced by Deserialize(), ns3::dsr::DsrRoutingHeader::Deserialize(), Print(), ns3::dsr::DsrRoutingHeader::Print(), and ns3::dsr::DsrRoutingHeader::Serialize().

+ Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::dsr::DsrFsHeader::GetSerializedSize ( ) const
overridevirtual

Get the serialized size of the packet.

Returns
size

Implements ns3::Header.

Reimplemented in ns3::dsr::DsrRoutingHeader.

Definition at line 149 of file dsr-fs-header.cc.

Referenced by Deserialize().

+ Here is the caller graph for this function:

◆ GetSourceId()

uint16_t ns3::dsr::DsrFsHeader::GetSourceId ( ) const

brief Get the source ID of the header.

Returns
source ID the source ID of the header

Definition at line 122 of file dsr-fs-header.cc.

References m_sourceId.

Referenced by ns3::dsr::DsrRouting::AddAckReqHeader(), Print(), ns3::dsr::DsrRoutingHeader::Print(), ns3::dsr::DsrRouting::PromiscReceive(), ns3::dsr::DsrRouting::Receive(), and ns3::dsr::DsrRoutingHeader::Serialize().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::dsr::DsrFsHeader::GetTypeId ( )
static

Get the type identificator.

Returns
type identificator

Definition at line 50 of file dsr-fs-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:

◆ Print()

void ns3::dsr::DsrFsHeader::Print ( std::ostream &  os) const
overridevirtual

Print some information about the packet.

Parameters
osoutput stream

Implements ns3::Header.

Reimplemented in ns3::dsr::DsrRoutingHeader.

Definition at line 140 of file dsr-fs-header.cc.

References GetDestId(), GetMessageType(), GetNextHeader(), GetPayloadLength(), and GetSourceId().

+ Here is the call graph for this function:

◆ Serialize()

void ns3::dsr::DsrFsHeader::Serialize ( Buffer::Iterator  start) const
overridevirtual

Serialize the packet.

Parameters
startBuffer iterator

Implements ns3::Header.

Reimplemented in ns3::dsr::DsrRoutingHeader.

Definition at line 155 of file dsr-fs-header.cc.

References ns3::Buffer::GetSize(), m_data, m_destId, m_messageType, m_nextHeader, m_payloadLen, m_sourceId, ns3::Buffer::PeekData(), ns3::Buffer::Iterator::Write(), ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

◆ SetDestId()

void ns3::dsr::DsrFsHeader::SetDestId ( uint16_t  destId)

brief Set the dest ID of the header.

Parameters
destIdthe destination ID of the header

Definition at line 128 of file dsr-fs-header.cc.

References m_destId.

Referenced by ns3::dsr::DsrRouting::AddAckReqHeader(), ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::dsr::DsrRoutingHeader::Deserialize(), ns3::dsr::DsrRouting::ForwardErrPacket(), ns3::dsr::DsrRouting::ForwardPacket(), ns3::dsr::DsrRouting::PacketNewRoute(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrOptionRrep::Process(), ns3::dsr::DsrRouting::SalvagePacket(), ns3::dsr::DsrRouting::Send(), ns3::dsr::DsrRouting::SendAck(), ns3::dsr::DsrRouting::SendErrorRequest(), ns3::dsr::DsrRouting::SendGratuitousReply(), ns3::dsr::DsrRouting::SendInitialRequest(), ns3::dsr::DsrRouting::SendPacketFromBuffer(), and ns3::dsr::DsrRouting::SendUnreachError().

+ Here is the caller graph for this function:

◆ SetMessageType()

void ns3::dsr::DsrFsHeader::SetMessageType ( uint8_t  messageType)

brief Set the message type of the header.

Parameters
messageTypethe message type of the header

Definition at line 92 of file dsr-fs-header.cc.

References m_messageType.

Referenced by ns3::dsr::DsrRouting::AddAckReqHeader(), ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::dsr::DsrRoutingHeader::Deserialize(), ns3::dsr::DsrRouting::ForwardErrPacket(), ns3::dsr::DsrRouting::ForwardPacket(), ns3::dsr::DsrRouting::PacketNewRoute(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrOptionRrep::Process(), ns3::dsr::DsrRouting::SalvagePacket(), ns3::dsr::DsrRouting::Send(), ns3::dsr::DsrRouting::SendAck(), ns3::dsr::DsrRouting::SendErrorRequest(), ns3::dsr::DsrRouting::SendGratuitousReply(), ns3::dsr::DsrRouting::SendInitialRequest(), ns3::dsr::DsrRouting::SendPacketFromBuffer(), and ns3::dsr::DsrRouting::SendUnreachError().

+ Here is the caller graph for this function:

◆ SetNextHeader()

void ns3::dsr::DsrFsHeader::SetNextHeader ( uint8_t  protocol)

Set the "Next header" field.

Parameters
protocolthe next header number

Definition at line 80 of file dsr-fs-header.cc.

References m_nextHeader.

Referenced by ns3::dsr::DsrRouting::AddAckReqHeader(), ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::dsr::DsrRoutingHeader::Deserialize(), ns3::dsr::DsrRouting::ForwardErrPacket(), ns3::dsr::DsrRouting::ForwardPacket(), ns3::dsr::DsrRouting::PacketNewRoute(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrOptionRrep::Process(), ns3::dsr::DsrRouting::SalvagePacket(), ns3::dsr::DsrRouting::Send(), ns3::dsr::DsrRouting::SendAck(), ns3::dsr::DsrRouting::SendErrorRequest(), ns3::dsr::DsrRouting::SendGratuitousReply(), ns3::dsr::DsrRouting::SendInitialRequest(), ns3::dsr::DsrRouting::SendPacketFromBuffer(), and ns3::dsr::DsrRouting::SendUnreachError().

+ Here is the caller graph for this function:

◆ SetPayloadLength()

void ns3::dsr::DsrFsHeader::SetPayloadLength ( uint16_t  length)

brief Set the payload length of the header.

Parameters
lengththe payload length of the header in bytes

Definition at line 104 of file dsr-fs-header.cc.

References m_payloadLen.

Referenced by ns3::dsr::DsrRouting::AddAckReqHeader(), ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::dsr::DsrRoutingHeader::Deserialize(), ns3::dsr::DsrRouting::ForwardErrPacket(), ns3::dsr::DsrRouting::ForwardPacket(), ns3::dsr::DsrRouting::PacketNewRoute(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrOptionRrep::Process(), ns3::dsr::DsrRouting::SalvagePacket(), ns3::dsr::DsrRouting::Send(), ns3::dsr::DsrRouting::SendAck(), ns3::dsr::DsrRouting::SendErrorRequest(), ns3::dsr::DsrRouting::SendGratuitousReply(), ns3::dsr::DsrRouting::SendInitialRequest(), ns3::dsr::DsrRouting::SendPacketFromBuffer(), and ns3::dsr::DsrRouting::SendUnreachError().

+ Here is the caller graph for this function:

◆ SetSourceId()

void ns3::dsr::DsrFsHeader::SetSourceId ( uint16_t  sourceId)

brief Set the source ID of the header.

Parameters
sourceIdthe source ID of the header

Definition at line 116 of file dsr-fs-header.cc.

References m_sourceId.

Referenced by ns3::dsr::DsrRouting::AddAckReqHeader(), ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::dsr::DsrRoutingHeader::Deserialize(), ns3::dsr::DsrRouting::ForwardErrPacket(), ns3::dsr::DsrRouting::ForwardPacket(), ns3::dsr::DsrRouting::PacketNewRoute(), ns3::dsr::DsrOptionRreq::Process(), ns3::dsr::DsrOptionRrep::Process(), ns3::dsr::DsrRouting::SalvagePacket(), ns3::dsr::DsrRouting::Send(), ns3::dsr::DsrRouting::SendAck(), ns3::dsr::DsrRouting::SendErrorRequest(), ns3::dsr::DsrRouting::SendGratuitousReply(), ns3::dsr::DsrRouting::SendInitialRequest(), ns3::dsr::DsrRouting::SendPacketFromBuffer(), and ns3::dsr::DsrRouting::SendUnreachError().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_data

Buffer ns3::dsr::DsrFsHeader::m_data
private

The data of the extension.

Definition at line 198 of file dsr-fs-header.h.

Referenced by Deserialize(), and Serialize().

◆ m_destId

uint16_t ns3::dsr::DsrFsHeader::m_destId
private

The destination node id.

Definition at line 194 of file dsr-fs-header.h.

Referenced by Deserialize(), GetDestId(), Serialize(), and SetDestId().

◆ m_messageType

uint8_t ns3::dsr::DsrFsHeader::m_messageType
private

The type of the message.

Definition at line 182 of file dsr-fs-header.h.

Referenced by Deserialize(), GetMessageType(), Serialize(), and SetMessageType().

◆ m_nextHeader

uint8_t ns3::dsr::DsrFsHeader::m_nextHeader
private

The "next header" field.

Definition at line 178 of file dsr-fs-header.h.

Referenced by Deserialize(), GetNextHeader(), Serialize(), and SetNextHeader().

◆ m_payloadLen

uint16_t ns3::dsr::DsrFsHeader::m_payloadLen
private

The "payload length" field.

Definition at line 186 of file dsr-fs-header.h.

Referenced by Deserialize(), GetPayloadLength(), Serialize(), and SetPayloadLength().

◆ m_sourceId

uint16_t ns3::dsr::DsrFsHeader::m_sourceId
private

The source node id.

Definition at line 190 of file dsr-fs-header.h.

Referenced by Deserialize(), GetSourceId(), Serialize(), and SetSourceId().

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