ns3::UanHeaderRcData Class Reference
Extra data header information. More...
#include <uan-header-rc.h>
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:
-
frameNum Data frame # of reservation being transmitted propDelay Measured propagation delay found in handshaking
- Note:
- Prop. delay is transmitted with 16 bits and ms accuracy
Member Function Documentation
| virtual uint32_t ns3::UanHeaderRcData::Deserialize | ( | Buffer::Iterator | start | ) | [virtual] |
- Parameters:
-
start an 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.
| uint8_t ns3::UanHeaderRcData::GetFrameNo | ( | void | ) | const |
- Returns:
- Data frame # of reservation being transmitted
| virtual 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.
| Time ns3::UanHeaderRcData::GetPropDelay | ( | void | ) | const |
- Returns:
- Measured propagation delay found in handshaking
- Note:
- Prop. delay is transmitted with 16 bits and ms accuracy
| virtual 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.
| static 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.
| virtual void ns3::UanHeaderRcData::Print | ( | std::ostream & | os | ) | const [virtual] |
- Parameters:
-
os output 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.
| virtual void ns3::UanHeaderRcData::Serialize | ( | Buffer::Iterator | start | ) | const [virtual] |
- Parameters:
-
start an 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.
| void ns3::UanHeaderRcData::SetFrameNo | ( | uint8_t | frameNum | ) |
- Parameters:
-
frameNum Data frame # of reservation being transmitted
| void ns3::UanHeaderRcData::SetPropDelay | ( | Time | propDelay | ) |
- Parameters:
-
propDelay Measured 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:
- src/devices/uan/model/uan-header-rc.h
- doc/introspected-doxygen.h
