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

AODV types. More...

#include <aodv-packet.h>

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

Public Member Functions

 TypeHeader (MessageType t=AODVTYPE_RREQ)
 c-tor
MessageType Get () const
 Return type.
bool IsValid () const
 Check that type if valid.
bool operator== (TypeHeader const &o) const
- Public Member Functions inherited from ns3::Header
virtual ~Header ()

Private Attributes

MessageType m_type
bool m_valid

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::TypeHeader.

Additional Inherited Members

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

Detailed Description

AODV types.

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

Constructor & Destructor Documentation

ns3::aodv::TypeHeader::TypeHeader ( MessageType  t = AODVTYPE_RREQ)

c-tor

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

Member Function Documentation

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

References ns3::aodv::AODVTYPE_RERR, ns3::aodv::AODVTYPE_RREP, ns3::aodv::AODVTYPE_RREP_ACK, ns3::aodv::AODVTYPE_RREQ, ns3::Buffer::Iterator::GetDistanceFrom(), GetSerializedSize(), m_type, m_valid, NS_ASSERT, ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

+ Here is the call graph for this function:

MessageType ns3::aodv::TypeHeader::Get ( ) const
inline

Return type.

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

References m_type.

Referenced by ns3::aodv::TypeHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::RecvAodv().

+ Here is the caller graph for this function:

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

References GetTypeId().

+ Here is the call graph for this function:

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

Referenced by Deserialize().

+ Here is the caller graph for this function:

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

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

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

Reimplemented from ns3::Header.

Definition at line 45 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::TypeHeader::IsValid ( ) const
inline

Check that type if valid.

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

References m_valid.

Referenced by ns3::aodv::TypeHeaderTest::DoRun(), and ns3::aodv::RoutingProtocol::RecvAodv().

+ Here is the caller graph for this function:

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

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

References m_type, and m_valid.

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

References ns3::aodv::AODVTYPE_RERR, ns3::aodv::AODVTYPE_RREP, ns3::aodv::AODVTYPE_RREP_ACK, ns3::aodv::AODVTYPE_RREQ, and m_type.

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

+ Here is the caller graph for this function:

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

References m_type, and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

Member Data Documentation

MessageType ns3::aodv::TypeHeader::m_type
private

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

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

bool ns3::aodv::TypeHeader::m_valid
private

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

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


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