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

Route Reply (RREP) Message Format. More...

#include <aodv-packet.h>

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

Public Member Functions

 RrepHeader (uint8_t prefixSize=0, uint8_t hopCount=0, Ipv4Address dst=Ipv4Address(), uint32_t dstSeqNo=0, Ipv4Address origin=Ipv4Address(), Time lifetime=MilliSeconds(0))
 c-tor More...
 
bool operator== (RrepHeader const &o) const
 
void SetHello (Ipv4Address src, uint32_t srcSeqNo, Time lifetime)
 Configure RREP to be a Hello message. More...
 
Fields
void SetHopCount (uint8_t count)
 
uint8_t GetHopCount () 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 SetLifeTime (Time t)
 
Time GetLifeTime () const
 
Flags
void SetAckRequired (bool f)
 
bool GetAckRequired () const
 
void SetPrefixSize (uint8_t sz)
 
uint8_t GetPrefixSize () const
 
- 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
 
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

Ipv4Address m_dst
 Destination IP Address. More...
 
uint32_t m_dstSeqNo
 Destination Sequence Number. More...
 
uint8_t m_flags
 A - acknowledgment required flag. More...
 
uint8_t m_hopCount
 Hop Count. More...
 
uint32_t m_lifeTime
 Lifetime (in milliseconds) More...
 
Ipv4Address m_origin
 Source IP Address. More...
 
uint8_t m_prefixSize
 Prefix Size. More...
 

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)
 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...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

Route Reply (RREP) Message Format.

Doxygen 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      |R|A|    Reserved     |Prefix Sz|   Hop Count   |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                     Destination IP address                    |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                  Destination Sequence Number                  |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                    Originator IP address                      |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                           Lifetime                            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+


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

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

Constructor & Destructor Documentation

ns3::aodv::RrepHeader::RrepHeader ( uint8_t  prefixSize = 0,
uint8_t  hopCount = 0,
Ipv4Address  dst = Ipv4Address (),
uint32_t  dstSeqNo = 0,
Ipv4Address  origin = Ipv4Address (),
Time  lifetime = MilliSeconds (0) 
)

c-tor

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

References ns3::Time::GetMilliSeconds(), and m_lifeTime.

+ Here is the call graph for this function:

Member Function Documentation

uint32_t ns3::aodv::RrepHeader::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 325 of file aodv-packet.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), GetSerializedSize(), m_dst, m_dstSeqNo, m_flags, m_hopCount, m_lifeTime, m_origin, m_prefixSize, 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::RrepHeader::GetAckRequired ( ) const

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

References m_flags.

Referenced by ns3::aodv::RrepHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::RecvReply().

+ Here is the caller graph for this function:

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

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

References m_dst.

Referenced by ns3::aodv::RrepHeaderTest::DoRun(), ns3::aodv::RoutingProtocol::ProcessHello(), and ns3::aodv::RoutingProtocol::RecvReply().

+ Here is the caller graph for this function:

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

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

References m_dstSeqNo.

Referenced by ns3::aodv::RrepHeaderTest::DoRun(), ns3::aodv::RoutingProtocol::ProcessHello(), and ns3::aodv::RoutingProtocol::RecvReply().

+ Here is the caller graph for this function:

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

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

References m_hopCount.

Referenced by ns3::aodv::RrepHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::RecvReply().

+ Here is the caller graph for this function:

TypeId ns3::aodv::RrepHeader::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 301 of file aodv-packet.cc.

References GetTypeId().

+ Here is the call graph for this function:

Time ns3::aodv::RrepHeader::GetLifeTime ( ) const

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

References m_lifeTime.

Referenced by ns3::aodv::RrepHeaderTest::DoRun(), ns3::aodv::RoutingProtocol::ProcessHello(), and ns3::aodv::RoutingProtocol::RecvReply().

+ Here is the caller graph for this function:

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

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

References m_origin.

Referenced by ns3::aodv::RrepHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::RecvReply().

+ Here is the caller graph for this function:

uint8_t ns3::aodv::RrepHeader::GetPrefixSize ( ) const

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

References m_prefixSize.

Referenced by ns3::aodv::RrepHeaderTest::DoRun().

+ Here is the caller graph for this function:

uint32_t ns3::aodv::RrepHeader::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 307 of file aodv-packet.cc.

Referenced by Deserialize().

+ Here is the caller graph for this function:

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

Definition at line 291 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::RrepHeader::operator== ( RrepHeader const &  o) const

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

References m_dst, m_dstSeqNo, m_flags, m_hopCount, m_lifeTime, m_origin, and m_prefixSize.

void ns3::aodv::RrepHeader::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 343 of file aodv-packet.cc.

References m_dst, m_dstSeqNo, m_lifeTime, m_origin, and m_prefixSize.

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

+ Here is the caller graph for this function:

void ns3::aodv::RrepHeader::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 313 of file aodv-packet.cc.

References m_dst, m_dstSeqNo, m_flags, m_hopCount, m_lifeTime, m_origin, m_prefixSize, ns3::Buffer::Iterator::WriteHtonU32(), ns3::WriteTo(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::aodv::RrepHeader::SetAckRequired ( bool  f)

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

References m_flags.

Referenced by ns3::aodv::RrepHeaderTest::DoRun(), ns3::aodv::RoutingProtocol::RecvReply(), and ns3::aodv::RoutingProtocol::SendReplyByIntermediateNode().

+ Here is the caller graph for this function:

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

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

References m_dst.

Referenced by ns3::aodv::RrepHeaderTest::DoRun().

+ Here is the caller graph for this function:

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

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

References m_dstSeqNo, and s.

Referenced by ns3::aodv::RrepHeaderTest::DoRun().

+ Here is the caller graph for this function:

void ns3::aodv::RrepHeader::SetHello ( Ipv4Address  src,
uint32_t  srcSeqNo,
Time  lifetime 
)

Configure RREP to be a Hello message.

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

References ns3::Time::GetMilliSeconds(), m_dst, m_dstSeqNo, m_flags, m_hopCount, m_lifeTime, m_origin, and m_prefixSize.

Referenced by ns3::aodv::RrepHeaderTest::DoRun().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

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

References m_hopCount.

Referenced by ns3::aodv::RrepHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::RecvReply().

+ Here is the caller graph for this function:

void ns3::aodv::RrepHeader::SetLifeTime ( Time  t)

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

References ns3::Time::GetMilliSeconds(), and m_lifeTime.

Referenced by ns3::aodv::RrepHeaderTest::DoRun().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

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

References m_origin.

Referenced by ns3::aodv::RrepHeaderTest::DoRun().

+ Here is the caller graph for this function:

void ns3::aodv::RrepHeader::SetPrefixSize ( uint8_t  sz)

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

References m_prefixSize.

Referenced by ns3::aodv::RrepHeaderTest::DoRun().

+ Here is the caller graph for this function:

Member Data Documentation

Ipv4Address ns3::aodv::RrepHeader::m_dst
private

Destination IP Address.

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

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

uint32_t ns3::aodv::RrepHeader::m_dstSeqNo
private

Destination Sequence Number.

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

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

uint8_t ns3::aodv::RrepHeader::m_flags
private

A - acknowledgment required flag.

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

Referenced by Deserialize(), GetAckRequired(), operator==(), Serialize(), SetAckRequired(), and SetHello().

uint8_t ns3::aodv::RrepHeader::m_hopCount
private

Hop Count.

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

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

uint32_t ns3::aodv::RrepHeader::m_lifeTime
private

Lifetime (in milliseconds)

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

Referenced by Deserialize(), GetLifeTime(), operator==(), Print(), RrepHeader(), Serialize(), SetHello(), and SetLifeTime().

Ipv4Address ns3::aodv::RrepHeader::m_origin
private

Source IP Address.

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

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

uint8_t ns3::aodv::RrepHeader::m_prefixSize
private

Prefix Size.

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

Referenced by Deserialize(), GetPrefixSize(), operator==(), Print(), Serialize(), SetHello(), and SetPrefixSize().


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