Flame header. More...

#include <flame-header.h>

Inheritance diagram for ns3::flame::FlameHeader:

Collaboration diagram for ns3::flame::FlameHeader:

Public Member Functions
	FlameHeader ()

	~FlameHeader ()

void	AddCost (uint8_t cost)

virtual uint32_t	Deserialize (Buffer::Iterator start)

uint8_t	GetCost () const

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

Mac48Address	GetOrigDst () const

Mac48Address	GetOrigSrc () const

uint16_t	GetProtocol () const

uint16_t	GetSeqno () const

virtual uint32_t	GetSerializedSize (void) const

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

virtual void	Serialize (Buffer::Iterator start) const

void	SetOrigDst (Mac48Address dst)

void	SetOrigSrc (Mac48Address OrigSrc)

void	SetProtocol (uint16_t protocol)

void	SetSeqno (uint16_t seqno)

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)

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
uint8_t	m_cost

Mac48Address	m_origDst

Mac48Address	m_origSrc

uint16_t	m_protocol

uint16_t	m_seqno

Friends
bool	operator== (const FlameHeader &a, const FlameHeader &b)

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

Flame header.

Introspection did not find any typical Config paths.

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

Definition at line 37 of file flame-header.h.

Constructor & Destructor Documentation

ns3::flame::FlameHeader::FlameHeader ( )

Definition at line 31 of file flame-header.cc.

ns3::flame::FlameHeader::~FlameHeader ( )

Definition at line 35 of file flame-header.cc.

Member Function Documentation

void ns3::flame::FlameHeader::AddCost ( uint8_t cost )

Definition at line 93 of file flame-header.cc.

References m_cost.

Referenced by FlameHeaderTest::DoRun(), and ns3::flame::FlameProtocol::RequestRoute().

Here is the caller graph for this function:

uint32_t ns3::flame::FlameHeader::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 81 of file flame-header.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_cost, m_origDst, m_origSrc, m_protocol, m_seqno, ns3::Buffer::Iterator::Next(), ns3::ReadFrom(), ns3::Buffer::Iterator::ReadNtohU16(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

Here is the call graph for this function:

uint8_t ns3::flame::FlameHeader::GetCost ( ) const

Definition at line 98 of file flame-header.cc.

References m_cost.

Referenced by ns3::flame::FlameProtocol::HandleDataFrame().

Here is the caller graph for this function:

TypeId ns3::flame::FlameHeader::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 48 of file flame-header.cc.

References GetTypeId().

Here is the call graph for this function:

Mac48Address ns3::flame::FlameHeader::GetOrigDst ( ) const

Definition at line 118 of file flame-header.cc.

References m_origDst.

Mac48Address ns3::flame::FlameHeader::GetOrigSrc ( ) const

Definition at line 128 of file flame-header.cc.

References m_origSrc.

uint16_t ns3::flame::FlameHeader::GetProtocol ( void ) const

Definition at line 138 of file flame-header.cc.

References m_protocol.

uint16_t ns3::flame::FlameHeader::GetSeqno ( ) const

Definition at line 108 of file flame-header.cc.

References m_seqno.

Referenced by ns3::flame::FlameProtocol::HandleDataFrame(), ns3::flame::FlameProtocol::RemoveRoutingStuff(), and ns3::flame::FlameProtocol::RequestRoute().

Here is the caller graph for this function:

uint32_t ns3::flame::FlameHeader::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 59 of file flame-header.cc.

TypeId ns3::flame::FlameHeader::GetTypeId ( void )

static

Definition at line 39 of file flame-header.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::flame::FlameHeader::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 53 of file flame-header.cc.

References m_cost, m_origDst, m_origSrc, and m_seqno.

void ns3::flame::FlameHeader::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 70 of file flame-header.cc.

References m_cost, m_origDst, m_origSrc, m_protocol, m_seqno, visualizer.core::start(), ns3::Buffer::Iterator::WriteHtonU16(), ns3::WriteTo(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function: