RTS header. More...
#include "uan-header-rc.h"
Public Member Functions | |
UanHeaderRcRts () | |
Default constructor. More... | |
UanHeaderRcRts (uint8_t frameNo, uint8_t retryNo, uint8_t noFrames, uint16_t length, Time ts) | |
Constructor. More... | |
~UanHeaderRcRts () override | |
Destructor. More... | |
uint32_t | Deserialize (Buffer::Iterator start) override |
uint8_t | GetFrameNo () const |
Get the frame number. More... | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. More... | |
uint16_t | GetLength () const |
Get the total number of bytes in the reservation, including headers. More... | |
uint8_t | GetNoFrames () const |
Get the number of data frames in the reservation. More... | |
uint8_t | GetRetryNo () const |
Get the retry number of this RTS packet. More... | |
uint32_t | GetSerializedSize () const override |
Time | GetTimeStamp () const |
Get the transmit timestamp of this RTS packet. More... | |
void | Print (std::ostream &os) const override |
void | Print (std::ostream &os, Time::Unit unit) const |
Specialized Print with Time::Unit declared. More... | |
void | Serialize (Buffer::Iterator start) const override |
void | SetFrameNo (uint8_t fno) |
Set the frame number. More... | |
void | SetLength (uint16_t length) |
Set the number of data bytes in the reservation. More... | |
void | SetNoFrames (uint8_t no) |
Set the number of data frames included in this reservation request. More... | |
void | SetRetryNo (uint8_t no) |
Set the retry number of this RTS packet. More... | |
void | SetTimeStamp (Time timeStamp) |
Set RTS transmission time. More... | |
Public Member Functions inherited from ns3::Header | |
~Header () override | |
virtual uint32_t | Deserialize (Buffer::Iterator start)=0 |
Deserialize the object from a buffer iterator. More... | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. More... | |
Public Member Functions inherited from ns3::Chunk | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. More... | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. More... | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. More... | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. More... | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. More... | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. More... | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. More... | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. More... | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. More... | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Register this type. More... | |
Static Public Member Functions inherited from ns3::Header | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::Chunk | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Private Attributes | |
uint8_t | m_frameNo |
Reservation frame number. More... | |
uint16_t | m_length |
Number of bytes (including headers) in data. More... | |
uint8_t | m_noFrames |
Number of data frames in reservation. More... | |
uint8_t | m_retryNo |
Retry number of RTS packet. More... | |
Time | m_timeStamp |
RTS TX timestamp. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. More... | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. More... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
RTS header.
Contains frame number, retry number, number of frames, length, and timestamp.
Definition at line 116 of file uan-header-rc.h.
ns3::UanHeaderRcRts::UanHeaderRcRts | ( | ) |
Default constructor.
Definition at line 129 of file uan-header-rc.cc.
ns3::UanHeaderRcRts::UanHeaderRcRts | ( | uint8_t | frameNo, |
uint8_t | retryNo, | ||
uint8_t | noFrames, | ||
uint16_t | length, | ||
Time | ts | ||
) |
Constructor.
frameNo | Reservation frame number. |
retryNo | Retry number of RTS packet. |
noFrames | Number of data frames in reservation. |
length | Number of bytes (including headers) in data. |
ts | RTS TX timestamp. |
Definition at line 139 of file uan-header-rc.cc.
|
override |
Destructor.
Definition at line 153 of file uan-header-rc.cc.
|
overridevirtual |
start | an iterator which points to where the header should read from. |
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.
Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.
Implements ns3::Header.
Definition at line 244 of file uan-header-rc.cc.
References ns3::Buffer::Iterator::GetDistanceFrom(), m_frameNo, m_length, m_noFrames, m_retryNo, m_timeStamp, ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU32(), ns3::Buffer::Iterator::ReadU8(), ns3::Seconds(), and two-ray-to-three-gpp-ch-calibration::start.
uint8_t ns3::UanHeaderRcRts::GetFrameNo | ( | ) | const |
Get the frame number.
Definition at line 222 of file uan-header-rc.cc.
References m_frameNo.
Referenced by ns3::UanMacRcGw::ReceivePacket().
|
overridevirtual |
Get the most derived TypeId for this Object.
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 271 of file uan-header-rc.cc.
References GetTypeId().
uint16_t ns3::UanHeaderRcRts::GetLength | ( | void | ) | const |
Get the total number of bytes in the reservation, including headers.
Definition at line 204 of file uan-header-rc.cc.
References m_length.
Referenced by ns3::UanMacRcGw::ReceivePacket().
uint8_t ns3::UanHeaderRcRts::GetNoFrames | ( | ) | const |
Get the number of data frames in the reservation.
Definition at line 198 of file uan-header-rc.cc.
References m_noFrames.
Referenced by ns3::UanMacRcGw::ReceivePacket().
uint8_t ns3::UanHeaderRcRts::GetRetryNo | ( | ) | const |
Get the retry number of this RTS packet.
Definition at line 216 of file uan-header-rc.cc.
References m_retryNo.
Referenced by ns3::UanMacRcGw::ReceivePacket().
|
overridevirtual |
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 228 of file uan-header-rc.cc.
Referenced by ns3::UanMacRcGw::UanMacRcGw().
Time ns3::UanHeaderRcRts::GetTimeStamp | ( | ) | const |
Get the transmit timestamp of this RTS packet.
Definition at line 210 of file uan-header-rc.cc.
References m_timeStamp.
|
static |
Register this type.
Definition at line 158 of file uan-header-rc.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
|
overridevirtual |
os | output stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header 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 265 of file uan-header-rc.cc.
References Print(), and ns3::Time::S.
void ns3::UanHeaderRcRts::Print | ( | std::ostream & | os, |
Time::Unit | unit | ||
) | const |
Specialized Print with Time::Unit declared.
os | ostream. |
unit | Time unit. |
Definition at line 257 of file uan-header-rc.cc.
References ns3::Time::As(), m_frameNo, m_length, m_noFrames, m_retryNo, and m_timeStamp.
Referenced by Print().
|
overridevirtual |
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.
Definition at line 234 of file uan-header-rc.cc.
References ns3::Time::GetMilliSeconds(), m_frameNo, m_length, m_noFrames, m_retryNo, m_timeStamp, ns3::Time::MS, ns3::Time::RoundTo(), and two-ray-to-three-gpp-ch-calibration::start.
void ns3::UanHeaderRcRts::SetFrameNo | ( | uint8_t | fno | ) |
Set the frame number.
fno | TX frame number |
Definition at line 168 of file uan-header-rc.cc.
References m_frameNo.
Referenced by ns3::UanMacRc::CreateRtsHeader().
void ns3::UanHeaderRcRts::SetLength | ( | uint16_t | length | ) |
Set the number of data bytes in the reservation.
length | Total number of data bytes in reservation (including headers). |
Definition at line 180 of file uan-header-rc.cc.
References m_length.
Referenced by ns3::UanMacRc::CreateRtsHeader().
void ns3::UanHeaderRcRts::SetNoFrames | ( | uint8_t | no | ) |
Set the number of data frames included in this reservation request.
no | Number of frames. |
Definition at line 174 of file uan-header-rc.cc.
References m_noFrames.
Referenced by ns3::UanMacRc::CreateRtsHeader().
void ns3::UanHeaderRcRts::SetRetryNo | ( | uint8_t | no | ) |
Set the retry number of this RTS packet.
This is used to match timestamp to correctly received RTS.
no | Retry number. |
Definition at line 192 of file uan-header-rc.cc.
References m_retryNo.
Referenced by ns3::UanMacRc::CreateRtsHeader().
void ns3::UanHeaderRcRts::SetTimeStamp | ( | Time | timeStamp | ) |
Set RTS transmission time.
timeStamp | The RTS transmission time. |
Definition at line 186 of file uan-header-rc.cc.
References m_timeStamp.
Referenced by ns3::UanMacRc::CreateRtsHeader().
|
private |
Reservation frame number.
Definition at line 222 of file uan-header-rc.h.
Referenced by Deserialize(), GetFrameNo(), Print(), Serialize(), and SetFrameNo().
|
private |
Number of bytes (including headers) in data.
Definition at line 224 of file uan-header-rc.h.
Referenced by Deserialize(), GetLength(), Print(), Serialize(), and SetLength().
|
private |
Number of data frames in reservation.
Definition at line 223 of file uan-header-rc.h.
Referenced by Deserialize(), GetNoFrames(), Print(), Serialize(), and SetNoFrames().
|
private |
Retry number of RTS packet.
Definition at line 226 of file uan-header-rc.h.
Referenced by Deserialize(), GetRetryNo(), Print(), Serialize(), and SetRetryNo().
|
private |
RTS TX timestamp.
Definition at line 225 of file uan-header-rc.h.
Referenced by Deserialize(), GetTimeStamp(), Print(), Serialize(), and SetTimeStamp().