FLAME routing protocol. More...

#include <flame-protocol.h>

Inheritance diagram for ns3::flame::FlameProtocol:

Classes
struct	Statistics

Public Member Functions
void	DoDispose ()

Mac48Address	GetAddress ()

bool	Install (Ptr< MeshPointDevice >)
	Install FLAME on given mesh point. More...

bool	RemoveRoutingStuff (uint32_t fromIface, const Mac48Address source, const Mac48Address destination, Ptr< Packet > packet, uint16_t &protocolType)
	Cleanup flame headers!

void	Report (std::ostream &) const
	Statistics.

bool	RequestRoute (uint32_t sourceIface, const Mac48Address source, const Mac48Address destination, Ptr< const Packet > packet, uint16_t protocolType, RouteReplyCallback routeReply)
	Route request, inherited from MeshL2RoutingProtocol.

void	ResetStats ()

Public Member Functions inherited from ns3::MeshL2RoutingProtocol
virtual	~MeshL2RoutingProtocol ()
	virtual D-tor for subclasses

Ptr< MeshPointDevice >	GetMeshPoint () const
	Each mesh protocol must be installed on the mesh point to work.

void	SetMeshPoint (Ptr< MeshPointDevice > mp)
	Set host mesh point, analog of SetNode (...) methods for upper layer protocols.

Public Member Functions inherited from ns3::Object
void	AggregateObject (Ptr< Object > other)

void	Dispose (void)

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)

uint32_t	GetReferenceCount (void) const

SimpleRefCount &	operator= (const SimpleRefCount &o)

void	Ref (void) const

void	Unref (void) const

Public Member Functions inherited from ns3::ObjectBase
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 ()

Static Public Member Functions inherited from ns3::MeshL2RoutingProtocol
static TypeId	GetTypeId ()
	Never forget to support NS3 object model.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Private Member Functions
	FlameProtocol (const FlameProtocol &)

bool	HandleDataFrame (uint16_t seqno, Mac48Address source, const FlameHeader flameHdr, Mac48Address receiver, uint32_t fromIface)
	Handles a packet: adds a routing information and drops packets by TTL or Seqno. More...

FlameProtocol &	operator= (const FlameProtocol &)

Private Attributes
uint8_t	m_maxCost
	Max Cost value (or TTL, because cost is actually hopcount)

uint16_t	m_myLastSeqno
	Sequence number:

Ptr< FlameRtable >	m_rtable
	Routing table:

Broadcast timers:
Time	m_broadcastInterval

Time	m_lastBroadcast

Statistics:
Statistics	m_stats

Static Private Attributes
static const uint16_t	FLAME_PROTOCOL = 0x4040
	LLC protocol number reserved by flame.

Information about MeshPointDeviceaddress, plugins
typedef std::map< uint32_t, Ptr< FlameProtocolMac > >	FlamePluginMap

FlamePluginMap	m_interfaces

Mac48Address	m_address

Additional Inherited Members
Public Types inherited from ns3::MeshL2RoutingProtocol
typedef Callback< void, bool, Ptr< Packet >, Mac48Address, Mac48Address, uint16_t, uint32_t >	RouteReplyCallback

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)

virtual void	NotifyNewAggregate (void)

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

virtual void	NotifyConstructionCompleted (void)

Protected Attributes inherited from ns3::MeshL2RoutingProtocol
Ptr< MeshPointDevice >	m_mp
	Host mesh point.

Detailed Description

FLAME routing protocol.

Config Paths

ns3::flame::FlameProtocol is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]/DeviceList/[i]/$ns3::MeshPointDevice/RoutingProtocol/$ns3::flame::FlameProtocol

Attributes

BroadcastInterval: How often we must send broadcast packets
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +5000000000.0ns
- Flags: construct write read
MaxCost: Cost threshold after which packet will be dropped
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 3:255
- Initial value: 32
- Flags: construct write read

No TraceSources are defined for this type.

Definition at line 80 of file flame-protocol.h.

Member Function Documentation

void ns3::flame::FlameProtocol::DoDispose ( void )

virtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

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

References ns3::MeshL2RoutingProtocol::m_mp, and m_rtable.

bool ns3::flame::FlameProtocol::HandleDataFrame	(	uint16_t	seqno,
		Mac48Address	source,
		const FlameHeader	flameHdr,
		Mac48Address	receiver,
		uint32_t	fromIface
	)

private

Handles a packet: adds a routing information and drops packets by TTL or Seqno.

Returns: true if packet shall be dropped

Definition at line 325 of file flame-protocol.cc.

References ns3::Mac48Address::GetBroadcast(), m_maxCost, and m_rtable.

Referenced by RemoveRoutingStuff(), and RequestRoute().

bool ns3::flame::FlameProtocol::Install ( Ptr< MeshPointDevice > mp )

Install FLAME on given mesh point.

Installing protocol cause installing its interface MAC plugins.

Also MP aggregates all installed protocols, FLAME protocol can be accessed via MeshPointDevice::GetObject<flame::FlameProtocol>();

Definition at line 290 of file flame-protocol.cc.

References ns3::Mac48Address::ConvertFrom(), and ns3::MeshL2RoutingProtocol::m_mp.

Referenced by ns3::FlameStack::InstallStack().

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

src/mesh/model/flame/flame-protocol.h
src/mesh/model/flame/flame-protocol.cc

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Information about MeshPointDeviceaddress, plugins

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Member Function Documentation