RTS header. More...

#include "uan-header-rc.h"

Inheritance diagram for ns3::UanHeaderRcRts:

Collaboration diagram for ns3::UanHeaderRcRts:

Public Member Functions
	UanHeaderRcRts ()
	Default constructor.

	UanHeaderRcRts (uint8_t frameNo, uint8_t retryNo, uint8_t noFrames, uint16_t length, Time ts)
	Constructor.

	~UanHeaderRcRts () override
	Destructor.

uint32_t	Deserialize (Buffer::Iterator start) override

uint8_t	GetFrameNo () const
	Get the frame number.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

uint16_t	GetLength () const
	Get the total number of bytes in the reservation, including headers.

uint8_t	GetNoFrames () const
	Get the number of data frames in the reservation.

uint8_t	GetRetryNo () const
	Get the retry number of this RTS packet.

uint32_t	GetSerializedSize () const override

Time	GetTimeStamp () const
	Get the transmit timestamp of this RTS packet.

void	Print (std::ostream &os) const override

void	Print (std::ostream &os, Time::Unit unit) const
	Specialized Print with Time::Unit declared.

void	Serialize (Buffer::Iterator start) const override

void	SetFrameNo (uint8_t fno)
	Set the frame number.

void	SetLength (uint16_t length)
	Set the number of data bytes in the reservation.

void	SetNoFrames (uint8_t no)
	Set the number of data frames included in this reservation request.

void	SetRetryNo (uint8_t no)
	Set the retry number of this RTS packet.

void	SetTimeStamp (Time timeStamp)
	Set RTS transmission time.

Public Member Functions inherited from ns3::Header
	~Header () override

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Attributes
uint8_t	m_frameNo
	Reservation frame number.

uint16_t	m_length
	Number of bytes (including headers) in data.

uint8_t	m_noFrames
	Number of data frames in reservation.

uint8_t	m_retryNo
	Retry number of RTS packet.

Time	m_timeStamp
	RTS TX timestamp.

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

RTS header.

Introspection did not find any typical Config paths
No Attributes are defined for this type
No TraceSources are defined for this type
Group: Uan
Size of this type is 32 bytes (on a 64-bit architecture).

Contains frame number, retry number, number of frames, length, and timestamp.

Definition at line 106 of file uan-header-rc.h.

Constructor & Destructor Documentation

◆ UanHeaderRcRts() [1/2]

ns3::UanHeaderRcRts::UanHeaderRcRts ( )

Default constructor.

Definition at line 118 of file uan-header-rc.cc.

References m_frameNo, m_length, m_noFrames, m_retryNo, and m_timeStamp.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ UanHeaderRcRts() [2/2]

ns3::UanHeaderRcRts::UanHeaderRcRts	(	uint8_t	frameNo,
		uint8_t	retryNo,
		uint8_t	noFrames,
		uint16_t	length,
		Time	ts )

Constructor.

Parameters

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.

Note: Timestamp is serialized into 32 bits with ms accuracy.

Definition at line 128 of file uan-header-rc.cc.

References m_frameNo, m_length, m_noFrames, m_retryNo, and m_timeStamp.

◆ ~UanHeaderRcRts()

ns3::UanHeaderRcRts::~UanHeaderRcRts ( )

override

Destructor.

Definition at line 142 of file uan-header-rc.cc.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::UanHeaderRcRts::Deserialize ( Buffer::Iterator start )

overridevirtual

Parameters

start an iterator which points to where the header should read from.

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.

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 233 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(), and ns3::Seconds().

Here is the call graph for this function:

◆ GetFrameNo()

uint8_t ns3::UanHeaderRcRts::GetFrameNo ( ) const

Get the frame number.

Returns: The frame number.

Definition at line 211 of file uan-header-rc.cc.

References m_frameNo.

Referenced by ns3::UanMacRcGw::ReceivePacket().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::UanHeaderRcRts::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is provided by ns3::Object::GetInstanceTypeId but classes which derive from ns3::ObjectBase directly have to implement it themselves. Typically, this method should simply return the output of GetTypeId().

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 260 of file uan-header-rc.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetLength()

uint16_t ns3::UanHeaderRcRts::GetLength ( ) const

Get the total number of bytes in the reservation, including headers.

Returns: Total number of bytes in data packets for reservation.

Definition at line 193 of file uan-header-rc.cc.

References m_length.

Referenced by ns3::UanMacRcGw::ReceivePacket().

Here is the caller graph for this function:

◆ GetNoFrames()

uint8_t ns3::UanHeaderRcRts::GetNoFrames ( ) const

Get the number of data frames in the reservation.

Returns: The number of data frames.

Definition at line 187 of file uan-header-rc.cc.

References m_noFrames.

Referenced by ns3::UanMacRcGw::ReceivePacket().

Here is the caller graph for this function:

◆ GetRetryNo()

uint8_t ns3::UanHeaderRcRts::GetRetryNo ( ) const

Get the retry number of this RTS packet.

Returns: The retry number.

Definition at line 205 of file uan-header-rc.cc.

References m_retryNo.

Referenced by ns3::UanMacRcGw::ReceivePacket().

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::UanHeaderRcRts::GetSerializedSize ( ) const

overridevirtual

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 217 of file uan-header-rc.cc.

Referenced by ns3::UanMacRcGw::UanMacRcGw().

Here is the caller graph for this function:

◆ GetTimeStamp()

Time ns3::UanHeaderRcRts::GetTimeStamp ( ) const

Get the transmit timestamp of this RTS packet.

Returns: The TX time.

Note: Timestamp is serialized with 32 bits in ms precision.

Definition at line 199 of file uan-header-rc.cc.

References m_timeStamp.

◆ GetTypeId()

TypeId ns3::UanHeaderRcRts::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

Definition at line 147 of file uan-header-rc.cc.

References UanHeaderRcRts(), and ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Print() [1/2]

void ns3::UanHeaderRcRts::Print ( std::ostream & os ) const

overridevirtual

Parameters

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 254 of file uan-header-rc.cc.

References Print(), and ns3::Time::S.

Here is the call graph for this function:

◆ Print() [2/2]

void ns3::UanHeaderRcRts::Print	(	std::ostream &	os,
		Time::Unit	unit ) const

Specialized Print with Time::Unit declared.

Parameters

os	ostream.
unit	Time unit.

Definition at line 246 of file uan-header-rc.cc.

References m_frameNo, m_length, m_noFrames, m_retryNo, and m_timeStamp.

Referenced by Print().

Here is the caller graph for this function:

◆ Serialize()

void ns3::UanHeaderRcRts::Serialize ( Buffer::Iterator start ) const

overridevirtual

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.

Definition at line 223 of file uan-header-rc.cc.

References m_frameNo, m_length, m_noFrames, m_retryNo, m_timeStamp, and ns3::Time::MS.

◆ SetFrameNo()

void ns3::UanHeaderRcRts::SetFrameNo ( uint8_t fno )

Set the frame number.

Parameters

fno	TX frame number

Definition at line 157 of file uan-header-rc.cc.

References m_frameNo.

Referenced by ns3::UanMacRc::CreateRtsHeader().

Here is the caller graph for this function:

◆ SetLength()

void ns3::UanHeaderRcRts::SetLength ( uint16_t length )

Set the number of data bytes in the reservation.

Parameters

length Total number of data bytes in reservation (including headers).

Note: Timestamp is serialized with 32 bits in ms precision.

Definition at line 169 of file uan-header-rc.cc.

References m_length.

Referenced by ns3::UanMacRc::CreateRtsHeader().

Here is the caller graph for this function:

◆ SetNoFrames()

void ns3::UanHeaderRcRts::SetNoFrames ( uint8_t no )

Set the number of data frames included in this reservation request.

Parameters

no	Number of frames.

Definition at line 163 of file uan-header-rc.cc.

References m_noFrames.

Referenced by ns3::UanMacRc::CreateRtsHeader().

Here is the caller graph for this function:

◆ SetRetryNo()

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.

Parameters

no	Retry number.

Definition at line 181 of file uan-header-rc.cc.

References m_retryNo.

Referenced by ns3::UanMacRc::CreateRtsHeader().

Here is the caller graph for this function:

◆ SetTimeStamp()

void ns3::UanHeaderRcRts::SetTimeStamp ( Time timeStamp )

Set RTS transmission time.

Parameters

timeStamp The RTS transmission time.

Definition at line 175 of file uan-header-rc.cc.

References m_timeStamp.

Referenced by ns3::UanMacRc::CreateRtsHeader().

Here is the caller graph for this function:

Member Data Documentation

◆ m_frameNo

uint8_t ns3::UanHeaderRcRts::m_frameNo

private

Reservation frame number.

Definition at line 212 of file uan-header-rc.h.

Referenced by UanHeaderRcRts(), UanHeaderRcRts(), Deserialize(), GetFrameNo(), Print(), Serialize(), and SetFrameNo().

◆ m_length

uint16_t ns3::UanHeaderRcRts::m_length

private

Number of bytes (including headers) in data.

Definition at line 214 of file uan-header-rc.h.

Referenced by UanHeaderRcRts(), UanHeaderRcRts(), Deserialize(), GetLength(), Print(), Serialize(), and SetLength().

◆ m_noFrames

uint8_t ns3::UanHeaderRcRts::m_noFrames

private

Number of data frames in reservation.

Definition at line 213 of file uan-header-rc.h.

Referenced by UanHeaderRcRts(), UanHeaderRcRts(), Deserialize(), GetNoFrames(), Print(), Serialize(), and SetNoFrames().

◆ m_retryNo

uint8_t ns3::UanHeaderRcRts::m_retryNo

private

Retry number of RTS packet.

Definition at line 216 of file uan-header-rc.h.

Referenced by UanHeaderRcRts(), UanHeaderRcRts(), Deserialize(), GetRetryNo(), Print(), Serialize(), and SetRetryNo().

◆ m_timeStamp

Time ns3::UanHeaderRcRts::m_timeStamp

private

RTS TX timestamp.

Definition at line 215 of file uan-header-rc.h.

Referenced by UanHeaderRcRts(), UanHeaderRcRts(), Deserialize(), GetTimeStamp(), Print(), Serialize(), and SetTimeStamp().

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

src/uan/model/uan-header-rc.h
src/uan/model/uan-header-rc.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UanHeaderRcRts() [1/2]

◆ UanHeaderRcRts() [2/2]

◆ ~UanHeaderRcRts()

Member Function Documentation

◆ Deserialize()

◆ GetFrameNo()

◆ GetInstanceTypeId()

◆ GetLength()

◆ GetNoFrames()

◆ GetRetryNo()

◆ GetSerializedSize()

◆ GetTimeStamp()

◆ GetTypeId()

◆ Print() [1/2]

◆ Print() [2/2]

◆ Serialize()

◆ SetFrameNo()

◆ SetLength()

◆ SetNoFrames()

◆ SetRetryNo()

◆ SetTimeStamp()

Member Data Documentation

◆ m_frameNo

◆ m_length

◆ m_noFrames

◆ m_retryNo

◆ m_timeStamp