CTS header. More...

#include <introspected-doxygen.h>

Inheritance diagram for ns3::UanHeaderRcCts:

Public Member Functions
	UanHeaderRcCts (uint8_t frameNo, uint8_t retryNo, Time rtsTs, Time delay, UanAddress addr)

virtual uint32_t	Deserialize (Buffer::Iterator start)

UanAddress	GetAddress (void) const

Time	GetDelayToTx (void) const

uint8_t	GetFrameNo (void) const

virtual TypeId	GetInstanceTypeId (void) const

uint8_t	GetRetryNo (void) const

Time	GetRtsTimeStamp (void) const

virtual uint32_t	GetSerializedSize (void) const

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

virtual void	Serialize (Buffer::Iterator start) const

void	SetAddress (UanAddress addr)

void	SetDelayToTx (Time delay)

void	SetFrameNo (uint8_t frameNo)

void	SetRetryNo (uint8_t no)

void	SetRtsTimeStamp (Time timeStamp)

Public Member Functions inherited from ns3::ObjectBase
void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Private Attributes
UanAddress	m_address

Time	m_delay

uint8_t	m_frameNo

uint8_t	m_retryNo

Time	m_timeStampRts

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

virtual void	NotifyConstructionCompleted (void)

Detailed Description

CTS header.

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

Includes RTS RX time, CTS TX time, delay until TX, RTS blocking period, RTS tx period, rate #, and retry rate #

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

Constructor & Destructor Documentation

ns3::UanHeaderRcCts::UanHeaderRcCts	(	uint8_t	frameNo,
		uint8_t	retryNo,
		Time	rtsTs,
		Time	delay,
		UanAddress	addr
	)

Parameters

frameNo	Resrvation frame # being cleared
retryNo	Retry # of received RTS packet
rtsTs	RX time of RTS packet at gateway
delay	Delay until transmission
addr	Destination of CTS packet

Note: Times are serialized, with ms precission, into 32 bit fields.

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

Member Function Documentation

uint32_t ns3::UanHeaderRcCts::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 501 of file uan-header-rc.cc.

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

UanAddress ns3::UanHeaderRcCts::GetAddress ( void ) const

Returns: Destination for scheduling info

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

Time ns3::UanHeaderRcCts::GetDelayToTx ( void ) const

Returns: Delay from TX time of CTS packet until arrival of first data frame

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

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

Returns: Frame # of RTS being cleared

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

TypeId ns3::UanHeaderRcCts::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 520 of file uan-header-rc.cc.

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

Returns: Retry # of RTS packet being cleared

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

Time ns3::UanHeaderRcCts::GetRtsTimeStamp ( void ) const

Returns: RX time of RTS being cleared

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

uint32_t ns3::UanHeaderRcCts::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 484 of file uan-header-rc.cc.

void ns3::UanHeaderRcCts::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 514 of file uan-header-rc.cc.

References ns3::Time::GetSeconds().

void ns3::UanHeaderRcCts::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 491 of file uan-header-rc.cc.

References ns3::UanAddress::GetAsInt(), ns3::Time::GetSeconds(), ns3::Buffer::Iterator::WriteU32(), and ns3::Buffer::Iterator::WriteU8().

void ns3::UanHeaderRcCts::SetAddress ( UanAddress addr )

Parameters

addr	Destination for scheduling info

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

void ns3::UanHeaderRcCts::SetDelayToTx ( Time delay )

Parameters

delay Time duration, from CTS TX, before first data frame arrival

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

void ns3::UanHeaderRcCts::SetFrameNo ( uint8_t frameNo )

Parameters

frameNo Frame # of RTS being cleared

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

void ns3::UanHeaderRcCts::SetRetryNo ( uint8_t no )

Parameters

no	Retry number of RTS frame being cleared

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

void ns3::UanHeaderRcCts::SetRtsTimeStamp ( Time timeStamp )

Parameters

timeStamp Time of RTS reception

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

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

Member Function Documentation