A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::SeqTsHeader Class Reference
UdpClientServer

Packet header for Udp client/server application The header is made of a 32bits sequence number followed by a 64bits time stamp. More...

#include <introspected-doxygen.h>

+ Inheritance diagram for ns3::SeqTsHeader:

Public Member Functions

uint32_t GetSeq (void) const
 
Time GetTs (void) const
 
void SetSeq (uint32_t seq)
 
- 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)
 

Static Public Member Functions

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

Private Member Functions

virtual uint32_t Deserialize (Buffer::Iterator start)
 
virtual TypeId GetInstanceTypeId (void) const
 
virtual uint32_t GetSerializedSize (void) const
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator start) const
 

Private Attributes

uint32_t m_seq
 
uint64_t m_ts
 

Additional Inherited Members

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

Detailed Description

Packet header for Udp client/server application The header is made of a 32bits sequence number followed by a 64bits time stamp.

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 35 of file seq-ts-header.h.

Member Function Documentation

uint32_t ns3::SeqTsHeader::Deserialize ( Buffer::Iterator  start)
privatevirtual
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 96 of file seq-ts-header.cc.

References GetSerializedSize(), NS_LOG_FUNCTION, ns3::Buffer::Iterator::ReadNtohU32(), and ns3::Buffer::Iterator::ReadNtohU64().

TypeId ns3::SeqTsHeader::GetInstanceTypeId ( void  ) const
privatevirtual
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 70 of file seq-ts-header.cc.

uint32_t ns3::SeqTsHeader::GetSeq ( void  ) const
Returns
the sequence number

Definition at line 47 of file seq-ts-header.cc.

References NS_LOG_FUNCTION.

uint32_t ns3::SeqTsHeader::GetSerializedSize ( void  ) const
privatevirtual
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 81 of file seq-ts-header.cc.

References NS_LOG_FUNCTION.

Referenced by Deserialize().

Time ns3::SeqTsHeader::GetTs ( void  ) const
Returns
the time stamp

Definition at line 54 of file seq-ts-header.cc.

References NS_LOG_FUNCTION.

void ns3::SeqTsHeader::Print ( std::ostream &  os) const
privatevirtual
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 75 of file seq-ts-header.cc.

References ns3::Time::GetSeconds(), and NS_LOG_FUNCTION.

void ns3::SeqTsHeader::Serialize ( Buffer::Iterator  start) const
privatevirtual
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 88 of file seq-ts-header.cc.

References NS_LOG_FUNCTION, ns3::Buffer::Iterator::WriteHtonU32(), and ns3::Buffer::Iterator::WriteHtonU64().

void ns3::SeqTsHeader::SetSeq ( uint32_t  seq)
Parameters
seqthe sequence number

Definition at line 41 of file seq-ts-header.cc.

References NS_LOG_FUNCTION.

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