Extra data header information. More...

#include <uan-header-rc.h>

Inheritance diagram for ns3::UanHeaderRcData:

Collaboration diagram for ns3::UanHeaderRcData:

Public Member Functions
	UanHeaderRcData ()
	Default constructor. More...

	UanHeaderRcData (uint8_t frameNum, Time propDelay)
	Constructor. More...

virtual	~UanHeaderRcData ()
	Destructor. More...

virtual uint32_t	Deserialize (Buffer::Iterator start)

uint8_t	GetFrameNo (void) const
	Get the frame number of the reservation being transmitted. More...

virtual TypeId	GetInstanceTypeId (void) const

Time	GetPropDelay (void) const
	Get the propagation delay found in handshaking. More...

virtual uint32_t	GetSerializedSize (void) const

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

virtual void	Serialize (Buffer::Iterator start) const

void	SetFrameNo (uint8_t frameNum)
	Set the frame number of the reservation being transmitted. More...

void	SetPropDelay (Time propDelay)
	Set the propagation delay as found in handshaking. More...

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

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

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)
	Register this type. More...

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)
	Get the type ID. More...

Private Attributes
uint8_t	m_frameNo
	Data frame number. More...

Time	m_propDelay
	Propagation delay. More...

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

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

Extra data header information.

Doxygen introspection did not find any typical Config paths.

Adds propagation delay measure, and frame number info to transmitted data packet.

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

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

Constructor & Destructor Documentation

ns3::UanHeaderRcData::UanHeaderRcData ( )

Default constructor.

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

ns3::UanHeaderRcData::UanHeaderRcData	(	uint8_t	frameNum,
		Time	propDelay
	)

Constructor.

Parameters

frameNum	Data frame # of reservation being transmitted.
propDelay	Measured propagation delay found in handshaking.

Note: Prop. delay is transmitted with 16 bits and ms accuracy.

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

ns3::UanHeaderRcData::~UanHeaderRcData ( )

virtual

Destructor.

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

Member Function Documentation

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

References ns3::Buffer::Iterator::GetDistanceFrom(), m_frameNo, m_propDelay, ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

Here is the call graph for this function:

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

Get the frame number of the reservation being transmitted.

Returns: The data frame number.

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

References m_frameNo.

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

Here is the caller graph for this function:

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

References GetTypeId().

Here is the call graph for this function:

Time ns3::UanHeaderRcData::GetPropDelay ( void ) const

Get the propagation delay found in handshaking.

Returns: The measured propagation delay.

Note: Prop. delay is transmitted with 16 bits and ms accuracy

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

References m_propDelay.

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

Here is the caller graph for this function:

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

Referenced by ns3::Reservation::Reservation().

Here is the caller graph for this function:

TypeId ns3::UanHeaderRcData::GetTypeId ( void )

static

Register this type.

Returns: The TypeId.

Definition at line 59 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::UanHeaderRcData::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 116 of file uan-header-rc.cc.

References ns3::Time::GetSeconds(), m_frameNo, and m_propDelay.

Here is the call graph for this function:

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

References ns3::Time::GetSeconds(), m_frameNo, m_propDelay, ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function: