Common packet header fields. More...

#include "uan-header-common.h"

Inheritance diagram for ns3::UanHeaderCommon:

Collaboration diagram for ns3::UanHeaderCommon:

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

	UanHeaderCommon (const UanAddress src, const UanAddress dest, uint8_t type)
	Create UanHeaderCommon object with given source and destination address and header type. More...

virtual	~UanHeaderCommon ()
	Destructor. More...

virtual uint32_t	Deserialize (Buffer::Iterator start)

UanAddress	GetDest (void) const
	Get the destination address. More...

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

virtual uint32_t	GetSerializedSize (void) const

UanAddress	GetSrc (void) const
	Get the source address. More...

uint8_t	GetType (void) const
	Get the header type value. More...

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

virtual void	Serialize (Buffer::Iterator start) const

void	SetDest (UanAddress dest)
	Set the destination address. More...

void	SetSrc (UanAddress src)
	Set the source address. More...

void	SetType (uint8_t type)
	Set the header type. 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
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Attributes
UanAddress	m_dest
	The destination address. More...

UanAddress	m_src
	The source address. More...

uint8_t	m_type
	The type field. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Common packet header fields.

Introspection did not find any typical Config paths.

Includes 1 byte src address, 1 byte dest address, and a 1 byte type field.

The type field is protocol specific; see the relevant MAC protocol.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 48 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

ns3::UanHeaderCommon::UanHeaderCommon ( )

Default constructor.

Definition at line 28 of file uan-header-common.cc.

ns3::UanHeaderCommon::UanHeaderCommon	(	const UanAddress	src,
		const UanAddress	dest,
		uint8_t	type
	)

Create UanHeaderCommon object with given source and destination address and header type.

Parameters

src	Source address defined in header.
dest	Destination address defined in header.
type	Header type.

Definition at line 32 of file uan-header-common.cc.

ns3::UanHeaderCommon::~UanHeaderCommon ( )

virtual

Destructor.

Definition at line 57 of file uan-header-common.cc.

Member Function Documentation

uint32_t ns3::UanHeaderCommon::Deserialize ( Buffer::Iterator start )

virtual

Parameters

start an iterator which points to where the header should read from.

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.

Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.

Implements ns3::Header.

Definition at line 112 of file uan-header-common.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_dest, m_src, m_type, ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

Here is the call graph for this function:

UanAddress ns3::UanHeaderCommon::GetDest ( void ) const

Get the destination address.

Returns: UanAddress in destination field.

Definition at line 80 of file uan-header-common.cc.

References m_dest.

Referenced by ns3::UanMacRc::IsPhy1Ok(), ns3::UanMacCw::PhyRxPacketGood(), ns3::UanMacRc::ReceiveOkFromPhy(), ns3::UanMacRcGw::ReceivePacket(), ns3::UanMacAloha::RxPacketGood(), ns3::UanMacRcGw::SendPacket(), and ns3::UanMacRc::SendPacket().

Here is the caller graph for this function:

TypeId ns3::UanHeaderCommon::GetInstanceTypeId ( void ) const

virtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 53 of file uan-header-common.cc.

References GetTypeId().

Here is the call graph for this function:

uint32_t ns3::UanHeaderCommon::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 98 of file uan-header-common.cc.

Referenced by ns3::UanMacRcGw::ComputeExpS(), AcousticModemEnergyTestCase::DoRun(), ns3::UanMacRc::ReceiveOkFromPhy(), ns3::Reservation::Reservation(), and ns3::UanMacRcGw::UanMacRcGw().

Here is the caller graph for this function:

UanAddress ns3::UanHeaderCommon::GetSrc ( void ) const

Get the source address.

Returns: UanAddress in source field.

Definition at line 85 of file uan-header-common.cc.

References m_src.

Referenced by ns3::UanPhyCalcSinrDual::CalcSinrDb(), ns3::UanMacCw::PhyRxPacketGood(), ns3::UanMacRc::ReceiveOkFromPhy(), ns3::UanMacRcGw::ReceivePacket(), and ns3::UanMacAloha::RxPacketGood().

Here is the caller graph for this function:

uint8_t ns3::UanHeaderCommon::GetType ( void ) const

Get the header type value.

Returns: value of type field.

Definition at line 90 of file uan-header-common.cc.

References m_type.

Referenced by ns3::UanPhyCalcSinrDual::CalcSinrDb(), ns3::UanMacRc::IsPhy1Ok(), ns3::UanMacRc::ReceiveOkFromPhy(), ns3::UanMacRcGw::ReceivePacket(), ns3::UanMacRcGw::SendPacket(), and ns3::UanMacRc::SendPacket().

Here is the caller graph for this function:

TypeId ns3::UanHeaderCommon::GetTypeId ( void )

static

Register this type.

Returns: The TypeId.

Definition at line 42 of file uan-header-common.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::UanHeaderCommon::Print ( std::ostream & os ) const

virtual

Parameters

os output stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header 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 124 of file uan-header-common.cc.

References m_dest, m_src, and m_type.

void ns3::UanHeaderCommon::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 104 of file uan-header-common.cc.

References ns3::UanAddress::GetAsInt(), m_dest, m_src, m_type, and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function: