RTS header. More...

#include <uan-header-rc.h>

Inheritance diagram for ns3::UanHeaderRcRts:

Collaboration diagram for ns3::UanHeaderRcRts:

Public Member Functions
	UanHeaderRcRts ()
	UanHeaderRcRts (uint8_t frameNo, uint8_t retryNo, uint8_t noFrames, uint16_t length, Time ts)
virtual	~UanHeaderRcRts ()
virtual uint32_t	Deserialize (Buffer::Iterator start)
uint8_t	GetFrameNo (void) const
virtual TypeId	GetInstanceTypeId (void) const
uint16_t	GetLength (void) const
uint8_t	GetNoFrames (void) const
uint8_t	GetRetryNo (void) const
virtual uint32_t	GetSerializedSize (void) const
Time	GetTimeStamp (void) const
virtual void	Print (std::ostream &os) const
virtual void	Serialize (Buffer::Iterator start) const
void	SetFrameNo (uint8_t fno)
void	SetLength (uint16_t length)
void	SetNoFrames (uint8_t no)
void	SetRetryNo (uint8_t no)
void	SetTimeStamp (Time timeStamp)
Public Member Functions inherited from ns3::Header
virtual	~Header ()

Static Public Member Functions
static TypeId	GetTypeId (void)

Private Attributes
uint8_t	m_frameNo
uint16_t	m_length
uint8_t	m_noFrames
uint8_t	m_retryNo
Time	m_timeStamp

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

Detailed Description

RTS header.

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Contains frame #, retry #, # frames, length, and timestamp

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

Constructor & Destructor Documentation

ns3::UanHeaderRcRts::UanHeaderRcRts ( )

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

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

Parameters

frameNo	Reservation frame #
retryNo	Retry # of RTS packet
noFrames	# of data frames in reservation
length	# of bytes (including headers) in data
ts	RTS TX timestamp

Note: Timestamp is serialized into 32 bits with ms accuracy

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

ns3::UanHeaderRcRts::~UanHeaderRcRts ( )

virtual

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

Member Function Documentation

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

Definition at line 237 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 visualizer.core::start().

Here is the call graph for this function:

uint8_t ns3::UanHeaderRcRts::GetFrameNo ( void ) const

Returns: Frame #

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

References m_frameNo.

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

Here is the caller graph for this function:

TypeId ns3::UanHeaderRcRts::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.

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

References GetTypeId().

Here is the call graph for this function:

uint16_t ns3::UanHeaderRcRts::GetLength ( void ) const

Returns: Total # of bytes in data packets for reservation (including headers)

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

References m_length.

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

Here is the caller graph for this function:

uint8_t ns3::UanHeaderRcRts::GetNoFrames ( void ) const

Returns: # of data frames in reservation

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

References m_noFrames.

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

Here is the caller graph for this function:

uint8_t ns3::UanHeaderRcRts::GetRetryNo ( void ) const

Returns: Retry number of this RTS packet

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

References m_retryNo.

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

Here is the caller graph for this function:

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

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

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

Here is the caller graph for this function:

Time ns3::UanHeaderRcRts::GetTimeStamp ( void ) const

Returns: TX time of the RTS packet

Note: Timestamp is serialized with 32 bits in ms precision

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

References m_timeStamp.

TypeId ns3::UanHeaderRcRts::GetTypeId ( void )

static

Reimplemented from ns3::Header.

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

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

References ns3::Time::GetSeconds(), m_frameNo, m_length, m_noFrames, m_retryNo, and m_timeStamp.

Here is the call graph for this function:

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

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

References ns3::Time::GetSeconds(), m_frameNo, m_length, m_noFrames, m_retryNo, m_timeStamp, ns3::Buffer::Iterator::WriteU16(), ns3::Buffer::Iterator::WriteU32(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function: