A Discrete-Event Network Simulator
API
ns3::aodv::RreqHeader Class Reference

Route Request (RREQ) Message Format. More...

#include "aodv-packet.h"

+ Inheritance diagram for ns3::aodv::RreqHeader:
+ Collaboration diagram for ns3::aodv::RreqHeader:

Public Member Functions

 RreqHeader (uint8_t flags=0, uint8_t reserved=0, uint8_t hopCount=0, uint32_t requestID=0, Ipv4Address dst=Ipv4Address(), uint32_t dstSeqNo=0, Ipv4Address origin=Ipv4Address(), uint32_t originSeqNo=0)
 c-tor More...
 
uint32_t Deserialize (Buffer::Iterator start)
 
bool GetDestinationOnly () const
 
Ipv4Address GetDst () const
 
uint32_t GetDstSeqno () const
 
bool GetGratiousRrep () const
 
uint8_t GetHopCount () const
 
uint32_t GetId () const
 
TypeId GetInstanceTypeId () const
 Get the most derived TypeId for this Object. More...
 
Ipv4Address GetOrigin () const
 
uint32_t GetOriginSeqno () const
 
uint32_t GetSerializedSize () const
 
bool GetUnknownSeqno () const
 
bool operator== (RreqHeader const &o) const
 
void Print (std::ostream &os) const
 
void Serialize (Buffer::Iterator start) const
 
void SetDestinationOnly (bool f)
 
void SetDst (Ipv4Address a)
 
void SetDstSeqno (uint32_t s)
 
void SetGratiousRrep (bool f)
 
void SetHopCount (uint8_t count)
 
void SetId (uint32_t id)
 
void SetOrigin (Ipv4Address a)
 
void SetOriginSeqno (uint32_t s)
 
void SetUnknownSeqno (bool f)
 
- 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 ()
 
- 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 Attributes

Ipv4Address m_dst
 Destination IP Address. More...
 
uint32_t m_dstSeqNo
 Destination Sequence Number. More...
 
uint8_t m_flags
 |J|R|G|D|U| bit flags, see RFC More...
 
uint8_t m_hopCount
 Hop Count. More...
 
Ipv4Address m_origin
 Originator IP Address. More...
 
uint32_t m_originSeqNo
 Source Sequence Number. More...
 
uint32_t m_requestID
 RREQ ID. More...
 
uint8_t m_reserved
 Not used. 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

Route Request (RREQ) Message Format.

Introspection did not find any typical Config paths.

0                   1                   2                   3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|     Type      |J|R|G|D|U|   Reserved          |   Hop Count   |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                            RREQ ID                            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                    Destination IP Address                     |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                  Destination Sequence Number                  |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                    Originator IP Address                      |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                  Originator Sequence Number                   |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+


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

Definition at line 100 of file aodv-packet.h.

Constructor & Destructor Documentation

ns3::aodv::RreqHeader::RreqHeader ( uint8_t  flags = 0,
uint8_t  reserved = 0,
uint8_t  hopCount = 0,
uint32_t  requestID = 0,
Ipv4Address  dst = Ipv4Address (),
uint32_t  dstSeqNo = 0,
Ipv4Address  origin = Ipv4Address (),
uint32_t  originSeqNo = 0 
)

c-tor

Definition at line 143 of file aodv-packet.cc.

Member Function Documentation

uint32_t ns3::aodv::RreqHeader::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan iterator which points to where the header should read from.
Returns
the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.

Implements ns3::Header.

Definition at line 189 of file aodv-packet.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), GetSerializedSize(), m_dst, m_dstSeqNo, m_flags, m_hopCount, m_origin, m_originSeqNo, m_requestID, m_reserved, NS_ASSERT, ns3::ReadFrom(), ns3::Buffer::Iterator::ReadNtohU32(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

+ Here is the call graph for this function:

bool ns3::aodv::RreqHeader::GetDestinationOnly ( ) const

Definition at line 249 of file aodv-packet.cc.

References m_flags.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::RecvRequest().

+ Here is the caller graph for this function:

Ipv4Address ns3::aodv::RreqHeader::GetDst ( ) const
inline

Definition at line 123 of file aodv-packet.h.

References m_dst.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), ns3::aodv::RoutingProtocol::RecvRequest(), and ns3::aodv::RoutingProtocol::SendReply().

+ Here is the caller graph for this function:

uint32_t ns3::aodv::RreqHeader::GetDstSeqno ( ) const
inline

Definition at line 125 of file aodv-packet.h.

References m_dstSeqNo.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), ns3::aodv::RoutingProtocol::RecvRequest(), and ns3::aodv::RoutingProtocol::SendReply().

+ Here is the caller graph for this function:

bool ns3::aodv::RreqHeader::GetGratiousRrep ( ) const

Definition at line 234 of file aodv-packet.cc.

References m_flags.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::RecvRequest().

+ Here is the caller graph for this function:

uint8_t ns3::aodv::RreqHeader::GetHopCount ( ) const
inline

Definition at line 119 of file aodv-packet.h.

References m_hopCount.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::RecvRequest().

+ Here is the caller graph for this function:

uint32_t ns3::aodv::RreqHeader::GetId ( ) const
inline

Definition at line 121 of file aodv-packet.h.

References m_requestID.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), ns3::aodv::RoutingProtocol::RecvRequest(), and ns3::aodv::RoutingProtocol::SendRequest().

+ Here is the caller graph for this function:

TypeId ns3::aodv::RreqHeader::GetInstanceTypeId ( ) const
virtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns
The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 164 of file aodv-packet.cc.

References GetTypeId().

+ Here is the call graph for this function:

Ipv4Address ns3::aodv::RreqHeader::GetOrigin ( ) const
inline

Definition at line 127 of file aodv-packet.h.

References m_origin.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::RecvRequest().

+ Here is the caller graph for this function:

uint32_t ns3::aodv::RreqHeader::GetOriginSeqno ( ) const
inline

Definition at line 129 of file aodv-packet.h.

References m_originSeqNo.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::RecvRequest().

+ Here is the caller graph for this function:

uint32_t ns3::aodv::RreqHeader::GetSerializedSize ( ) const
virtual
Returns
the expected size of the header.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

Definition at line 170 of file aodv-packet.cc.

Referenced by Deserialize().

+ Here is the caller graph for this function:

TypeId ns3::aodv::RreqHeader::GetTypeId ( void  )
static

Definition at line 153 of file aodv-packet.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::aodv::RreqHeader::GetUnknownSeqno ( ) const

Definition at line 264 of file aodv-packet.cc.

References m_flags.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), ns3::aodv::RoutingProtocol::RecvRequest(), and ns3::aodv::RoutingProtocol::SendReply().

+ Here is the caller graph for this function:

bool ns3::aodv::RreqHeader::operator== ( RreqHeader const &  o) const

Definition at line 270 of file aodv-packet.cc.

References m_dst, m_dstSeqNo, m_flags, m_hopCount, m_origin, m_originSeqNo, m_requestID, and m_reserved.

void ns3::aodv::RreqHeader::Print ( std::ostream &  os) const
virtual
Parameters
osoutput stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

Definition at line 207 of file aodv-packet.cc.

References m_dst, m_dstSeqNo, m_origin, m_originSeqNo, and m_requestID.

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

+ Here is the caller graph for this function:

void ns3::aodv::RreqHeader::Serialize ( Buffer::Iterator  start) const
virtual
Parameters
startan iterator which points to where the header should be written.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

Definition at line 176 of file aodv-packet.cc.

References m_dst, m_dstSeqNo, m_flags, m_hopCount, m_origin, m_originSeqNo, m_requestID, m_reserved, ns3::Buffer::Iterator::WriteHtonU32(), ns3::WriteTo(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::aodv::RreqHeader::SetDestinationOnly ( bool  f)

Definition at line 240 of file aodv-packet.cc.

References m_flags.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::SendRequest().

+ Here is the caller graph for this function:

void ns3::aodv::RreqHeader::SetDst ( Ipv4Address  a)
inline

Definition at line 122 of file aodv-packet.h.

References m_dst.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::SendRequest().

+ Here is the caller graph for this function:

void ns3::aodv::RreqHeader::SetDstSeqno ( uint32_t  s)
inline

Definition at line 124 of file aodv-packet.h.

References m_dstSeqNo.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), ns3::aodv::RoutingProtocol::RecvRequest(), and ns3::aodv::RoutingProtocol::SendRequest().

+ Here is the caller graph for this function:

void ns3::aodv::RreqHeader::SetGratiousRrep ( bool  f)

Definition at line 225 of file aodv-packet.cc.

References m_flags.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::SendRequest().

+ Here is the caller graph for this function:

void ns3::aodv::RreqHeader::SetHopCount ( uint8_t  count)
inline

Definition at line 118 of file aodv-packet.h.

References m_hopCount.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::RecvRequest().

+ Here is the caller graph for this function:

void ns3::aodv::RreqHeader::SetId ( uint32_t  id)
inline

Definition at line 120 of file aodv-packet.h.

References m_requestID.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::SendRequest().

+ Here is the caller graph for this function:

void ns3::aodv::RreqHeader::SetOrigin ( Ipv4Address  a)
inline

Definition at line 126 of file aodv-packet.h.

References m_origin.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::SendRequest().

+ Here is the caller graph for this function:

void ns3::aodv::RreqHeader::SetOriginSeqno ( uint32_t  s)
inline

Definition at line 128 of file aodv-packet.h.

References m_originSeqNo.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::SendRequest().

+ Here is the caller graph for this function:

void ns3::aodv::RreqHeader::SetUnknownSeqno ( bool  f)

Definition at line 255 of file aodv-packet.cc.

References m_flags.

Referenced by ns3::aodv::RreqHeaderTest::DoRun(), ns3::aodv::RoutingProtocol::RecvRequest(), and ns3::aodv::RoutingProtocol::SendRequest().

+ Here is the caller graph for this function:

Member Data Documentation

Ipv4Address ns3::aodv::RreqHeader::m_dst
private

Destination IP Address.

Definition at line 145 of file aodv-packet.h.

Referenced by Deserialize(), GetDst(), operator==(), Print(), Serialize(), and SetDst().

uint32_t ns3::aodv::RreqHeader::m_dstSeqNo
private

Destination Sequence Number.

Definition at line 146 of file aodv-packet.h.

Referenced by Deserialize(), GetDstSeqno(), operator==(), Print(), Serialize(), and SetDstSeqno().

uint8_t ns3::aodv::RreqHeader::m_flags
private
uint8_t ns3::aodv::RreqHeader::m_hopCount
private

Hop Count.

Definition at line 143 of file aodv-packet.h.

Referenced by Deserialize(), GetHopCount(), operator==(), Serialize(), and SetHopCount().

Ipv4Address ns3::aodv::RreqHeader::m_origin
private

Originator IP Address.

Definition at line 147 of file aodv-packet.h.

Referenced by Deserialize(), GetOrigin(), operator==(), Print(), Serialize(), and SetOrigin().

uint32_t ns3::aodv::RreqHeader::m_originSeqNo
private

Source Sequence Number.

Definition at line 148 of file aodv-packet.h.

Referenced by Deserialize(), GetOriginSeqno(), operator==(), Print(), Serialize(), and SetOriginSeqno().

uint32_t ns3::aodv::RreqHeader::m_requestID
private

RREQ ID.

Definition at line 144 of file aodv-packet.h.

Referenced by Deserialize(), GetId(), operator==(), Print(), Serialize(), and SetId().

uint8_t ns3::aodv::RreqHeader::m_reserved
private

Not used.

Definition at line 142 of file aodv-packet.h.

Referenced by Deserialize(), operator==(), and Serialize().


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