ns-3
ns3::UanHeaderRcData Class Reference

Extra data header information. More...

#include <uan-header-rc.h>

Inheritance diagram for ns3::UanHeaderRcData:
Collaboration diagram for ns3::UanHeaderRcData:

List of all members.

Public Member Functions

 UanHeaderRcData (uint8_t frameNum, Time propDelay)
void SetFrameNo (uint8_t frameNum)
void SetPropDelay (Time propDelay)
uint8_t GetFrameNo (void) const
Time GetPropDelay (void) const
virtual uint32_t GetSerializedSize (void) const
virtual void Serialize (Buffer::Iterator start) const
virtual uint32_t Deserialize (Buffer::Iterator start)
virtual void Print (std::ostream &os) const
virtual TypeId GetInstanceTypeId (void) const

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::UanHeaderRcData.

Detailed Description

Extra data header information.

Adds prop. delay measure, and frame number info to transmitted data packet


Constructor & Destructor Documentation

ns3::UanHeaderRcData::UanHeaderRcData ( uint8_t  frameNum,
Time  propDelay 
)
Parameters:
frameNumData frame # of reservation being transmitted
propDelayMeasured propagation delay found in handshaking
Note:
Prop. delay is transmitted with 16 bits and ms accuracy

Member Function Documentation

uint32_t ns3::UanHeaderRcData::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.

References ns3::Buffer::Iterator::GetDistanceFrom(), ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU8(), and ns3::Seconds().

uint8_t ns3::UanHeaderRcData::GetFrameNo ( void  ) const
Returns:
Data frame # of reservation being transmitted
TypeId ns3::UanHeaderRcData::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.

References GetTypeId().

Time ns3::UanHeaderRcData::GetPropDelay ( void  ) const
Returns:
Measured propagation delay found in handshaking
Note:
Prop. delay is transmitted with 16 bits and ms accuracy
uint32_t ns3::UanHeaderRcData::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.

Referenced by ns3::Reservation::Reservation().

TypeId ns3::UanHeaderRcData::GetTypeId ( void  )
static

This method returns the TypeId associated to ns3::UanHeaderRcData.

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

Reimplemented from ns3::Header.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

void ns3::UanHeaderRcData::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.

References ns3::Time::GetSeconds().

void ns3::UanHeaderRcData::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.

References ns3::Time::GetSeconds(), ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU8().

void ns3::UanHeaderRcData::SetFrameNo ( uint8_t  frameNum)
Parameters:
frameNumData frame # of reservation being transmitted
void ns3::UanHeaderRcData::SetPropDelay ( Time  propDelay)
Parameters:
propDelayMeasured propagation delay found in handshaking
Note:
Prop. delay is transmitted with 16 bits and ms accuracy

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