ns3::UanHeaderRcCts Class Reference

CTS header. More...

#include <uan-header-rc.h>

Inheritance diagram for ns3::UanHeaderRcCts:

Collaboration diagram for ns3::UanHeaderRcCts:

List of all members.

Public Member Functions
	UanHeaderRcCts (uint8_t frameNo, uint8_t retryNo, Time rtsTs, Time delay, UanAddress addr)
void	SetFrameNo (uint8_t frameNo)
void	SetRtsTimeStamp (Time timeStamp)
void	SetDelayToTx (Time delay)
void	SetRetryNo (uint8_t no)
void	SetAddress (UanAddress addr)
uint8_t	GetFrameNo (void) const
Time	GetRtsTimeStamp (void) const
Time	GetDelayToTx (void) const
uint8_t	GetRetryNo (void) const
UanAddress	GetAddress (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::UanHeaderRcCts.

---

Detailed Description

CTS header.

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

---

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.

---

Member Function Documentation

virtual 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.

UanAddress ns3::UanHeaderRcCts::GetAddress

(

void

)

const

Returns:

Destination for scheduling info

Time ns3::UanHeaderRcCts::GetDelayToTx

(

void

)

const

Returns:

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

uint8_t ns3::UanHeaderRcCts::GetFrameNo

(

void

)

const

Returns:

Frame # of RTS being cleared

virtual 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.

uint8_t ns3::UanHeaderRcCts::GetRetryNo

(

void

)

const

Returns:

Retry # of RTS packet being cleared

Time ns3::UanHeaderRcCts::GetRtsTimeStamp

(

void

)

const

Returns:

RX time of RTS being cleared

virtual 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.

static TypeId ns3::UanHeaderRcCts::GetTypeId

(

void

)

[static]

This method returns the TypeId associated to ns3::UanHeaderRcCts.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Header.

virtual 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.

virtual 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.

void ns3::UanHeaderRcCts::SetAddress

(

UanAddress

addr

)

Parameters:

addr

Destination for scheduling info

void ns3::UanHeaderRcCts::SetDelayToTx

(

Time

delay

)

Parameters:

delay

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

void ns3::UanHeaderRcCts::SetFrameNo

(

uint8_t

frameNo

)

Parameters:

frameNo

Frame # of RTS being cleared

void ns3::UanHeaderRcCts::SetRetryNo

(

uint8_t

no

)

Parameters:

no

Retry number of RTS frame being cleared

void ns3::UanHeaderRcCts::SetRtsTimeStamp

(

Time

timeStamp

)

Parameters:

timeStamp

Time of RTS reception

---

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

• src/devices/uan/model/uan-header-rc.h
• doc/introspected-doxygen.h