ns3::UanHeaderRcRts Class Reference

RTS header. More...

#include <uan-header-rc.h>

Inheritance diagram for ns3::UanHeaderRcRts:

Collaboration diagram for ns3::UanHeaderRcRts:

List of all members.

Public Member Functions
	UanHeaderRcRts (uint8_t frameNo, uint8_t retryNo, uint8_t noFrames, uint16_t length, Time ts)
void	SetFrameNo (uint8_t fno)
void	SetNoFrames (uint8_t no)
void	SetTimeStamp (Time timeStamp)
void	SetLength (uint16_t length)
void	SetRetryNo (uint8_t no)
uint8_t	GetFrameNo (void) const
uint8_t	GetNoFrames (void) const
Time	GetTimeStamp (void) const
uint16_t	GetLength (void) const
uint8_t	GetRetryNo (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::UanHeaderRcRts.

---

Detailed Description

RTS header.

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

---

Constructor & Destructor Documentation

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

---

Member Function Documentation

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

uint8_t ns3::UanHeaderRcRts::GetFrameNo

(

void

)

const

Returns:

Frame #

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

uint16_t ns3::UanHeaderRcRts::GetLength

(

void

)

const

Returns:

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

uint8_t ns3::UanHeaderRcRts::GetNoFrames

(

void

)

const

Returns:

# of data frames in reservation

uint8_t ns3::UanHeaderRcRts::GetRetryNo

(

void

)

const

Returns:

Retry number of this RTS packet

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

Time ns3::UanHeaderRcRts::GetTimeStamp

(

void

)

const

Returns:

TX time of the RTS packet

Note:

Timestamp is serialized with 32 bits in ms precision

static TypeId ns3::UanHeaderRcRts::GetTypeId

(

void

)

[static]

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

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

Reimplemented from ns3::Header.

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

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

void ns3::UanHeaderRcRts::SetFrameNo

(

uint8_t

fno

)

Parameters:

fno

TX frame #

void ns3::UanHeaderRcRts::SetLength

(

uint16_t

length

)

Parameters:

length

Total number of data bytes in reservation (including headers)

Note:

Timestamp is serialized with 32 bits in ms precision

void ns3::UanHeaderRcRts::SetNoFrames

(

uint8_t

no

)

Parameters:

no

Number of data frames included in this reservation request

void ns3::UanHeaderRcRts::SetRetryNo

(

uint8_t

no

)

Parameters:

no

Retry number of this RTS (Used to match timestamp to correctly received RTS)

void ns3::UanHeaderRcRts::SetTimeStamp

(

Time

timeStamp

)

Parameters:

timeStamp

RTS transmission time

---

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

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