A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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
bool operator== (RreqHeader const &o) const
Fields
void SetHopCount (uint8_t count)
uint8_t GetHopCount () const
void SetId (uint32_t id)
uint32_t GetId () const
void SetDst (Ipv4Address a)
Ipv4Address GetDst () const
void SetDstSeqno (uint32_t s)
uint32_t GetDstSeqno () const
void SetOrigin (Ipv4Address a)
Ipv4Address GetOrigin () const
void SetOriginSeqno (uint32_t s)
uint32_t GetOriginSeqno () const
Flags
void SetGratiousRrep (bool f)
bool GetGratiousRrep () const
void SetDestinationOnly (bool f)
bool GetDestinationOnly () const
void SetUnknownSeqno (bool f)
bool GetUnknownSeqno () const
- Public Member Functions inherited from ns3::Header
virtual ~Header ()

Private Attributes

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

Header serialization/deserialization

TypeId GetInstanceTypeId () const
uint32_t GetSerializedSize () const
void Serialize (Buffer::Iterator start) const
uint32_t Deserialize (Buffer::Iterator start)
void Print (std::ostream &os) const
static TypeId GetTypeId ()
 This method returns the TypeId associated to ns3::aodv::RreqHeader.

Additional Inherited Members

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

Detailed Description

Route Request (RREQ) Message Format.

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

Definition at line 102 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 142 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 written.
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.

Implements ns3::Header.

Definition at line 187 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 247 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 128 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 130 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 232 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 124 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 126 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
Returns
the TypeId associated to the most-derived type of this instance.

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

Implements ns3::ObjectBase.

Definition at line 162 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 132 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 134 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 168 of file aodv-packet.cc.

Referenced by Deserialize().

+ Here is the caller graph for this function:

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

This method returns the TypeId associated to ns3::aodv::RreqHeader.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Header.

Definition at line 152 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 262 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 268 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 trailer as ascii data to a c++ output stream. Although the trailer 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 205 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 174 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 238 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 127 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 129 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 223 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 123 of file aodv-packet.h.

References m_hopCount.

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::SetId ( uint32_t  id)
inline

Definition at line 125 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 131 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 133 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 253 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 153 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 154 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 151 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 155 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 156 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 152 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 150 of file aodv-packet.h.

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


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