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

Doxygen introspection did not find any typical Config paths. More...

#include <olsr-header.h>

+ Inheritance diagram for ns3::olsr::PacketHeader:
+ Collaboration diagram for ns3::olsr::PacketHeader:

Public Member Functions

 PacketHeader ()
 
virtual ~PacketHeader ()
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 
virtual TypeId GetInstanceTypeId (void) const
 
uint16_t GetPacketLength () const
 
uint16_t GetPacketSequenceNumber () const
 
virtual uint32_t GetSerializedSize (void) const
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator start) const
 
void SetPacketLength (uint16_t length)
 
void SetPacketSequenceNumber (uint16_t seqnum)
 
- 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)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- 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

uint16_t m_packetLength
 
uint16_t m_packetSequenceNumber
 

Additional Inherited Members

- 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

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 69 of file olsr-header.h.

Constructor & Destructor Documentation

ns3::olsr::PacketHeader::PacketHeader ( )

Definition at line 101 of file olsr-header.cc.

ns3::olsr::PacketHeader::~PacketHeader ( )
virtual

Definition at line 105 of file olsr-header.cc.

Member Function Documentation

uint32_t ns3::olsr::PacketHeader::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 145 of file olsr-header.cc.

References GetSerializedSize(), m_packetLength, m_packetSequenceNumber, ns3::Buffer::Iterator::ReadNtohU16(), and visualizer.core::start().

+ Here is the call graph for this function:

TypeId ns3::olsr::PacketHeader::GetInstanceTypeId ( void  ) 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 119 of file olsr-header.cc.

References GetTypeId().

+ Here is the call graph for this function:

uint16_t ns3::olsr::PacketHeader::GetPacketLength ( ) const
inline

Definition at line 79 of file olsr-header.h.

References m_packetLength.

Referenced by ns3::olsr::RoutingProtocol::RecvOlsr().

+ Here is the caller graph for this function:

uint16_t ns3::olsr::PacketHeader::GetPacketSequenceNumber ( ) const
inline

Definition at line 88 of file olsr-header.h.

References m_packetSequenceNumber.

uint32_t ns3::olsr::PacketHeader::GetSerializedSize ( void  ) 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 125 of file olsr-header.cc.

References OLSR_PKT_HEADER_SIZE.

Referenced by Deserialize(), ns3::olsr::RoutingProtocol::RecvOlsr(), and ns3::olsr::RoutingProtocol::SendPacket().

+ Here is the caller graph for this function:

TypeId ns3::olsr::PacketHeader::GetTypeId ( void  )
static

Definition at line 110 of file olsr-header.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::olsr::PacketHeader::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
Todo:

Implements ns3::Header.

Definition at line 131 of file olsr-header.cc.

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

+ Here is the caller graph for this function:

void ns3::olsr::PacketHeader::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 137 of file olsr-header.cc.

References m_packetLength, m_packetSequenceNumber, visualizer.core::start(), and ns3::Buffer::Iterator::WriteHtonU16().

+ Here is the call graph for this function:

void ns3::olsr::PacketHeader::SetPacketLength ( uint16_t  length)
inline

Definition at line 75 of file olsr-header.h.

References m_packetLength.

Referenced by ns3::olsr::RoutingProtocol::SendPacket().

+ Here is the caller graph for this function:

void ns3::olsr::PacketHeader::SetPacketSequenceNumber ( uint16_t  seqnum)
inline

Definition at line 84 of file olsr-header.h.

References m_packetSequenceNumber.

Referenced by ns3::olsr::RoutingProtocol::SendPacket().

+ Here is the caller graph for this function:

Member Data Documentation

uint16_t ns3::olsr::PacketHeader::m_packetLength
private

Definition at line 94 of file olsr-header.h.

Referenced by Deserialize(), GetPacketLength(), Serialize(), and SetPacketLength().

uint16_t ns3::olsr::PacketHeader::m_packetSequenceNumber
private

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