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

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

#include <aodv-packet.h>

+ Inheritance 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, uint16_t channel=1)
 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
 
void SetRXChannel (uint16_t s)
 
uint16_t GetRXChannel () 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::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)
 

Private Attributes

uint16_t m_channelNo
 RX channel of source.
 
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 ()
 

Additional Inherited Members

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

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 102 of file aodv-packet.h.

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 188 of file aodv-packet.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), GetSerializedSize(), m_channelNo, m_dst, m_dstSeqNo, m_flags, m_hopCount, m_origin, m_originSeqNo, m_requestID, m_reserved, NS_ASSERT, ns3::Buffer::Iterator::ReadNtohU32(), ns3::Buffer::Iterator::ReadU16(), and ns3::Buffer::Iterator::ReadU8().

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.

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

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 207 of file aodv-packet.cc.

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

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_channelNo, m_dst, m_dstSeqNo, m_flags, m_hopCount, m_origin, m_originSeqNo, m_requestID, m_reserved, ns3::Buffer::Iterator::WriteHtonU32(), ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU8().


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