ns-3
ns3::flame::FlameProtocol Class Reference

FLAME routing protocol. More...

#include <flame-protocol.h>

Inheritance diagram for ns3::flame::FlameProtocol:
Collaboration diagram for ns3::flame::FlameProtocol:

List of all members.

Classes

struct  Statistics

Public Member Functions

void DoDispose ()
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.
bool RemoveRoutingStuff (uint32_t fromIface, const Mac48Address source, const Mac48Address destination, Ptr< Packet > packet, uint16_t &protocolType)
 Cleanup flame headers!
bool Install (Ptr< MeshPointDevice >)
 Install FLAME on given mesh point.
Mac48Address GetAddress ()
void Report (std::ostream &) const
 Statistics.
void ResetStats ()
- Public Member Functions inherited from ns3::MeshL2RoutingProtocol
virtual ~MeshL2RoutingProtocol ()
 virtual D-tor for subclasses
void SetMeshPoint (Ptr< MeshPointDevice > mp)
 Set host mesh point, analog of SetNode (...) methods for upper layer protocols.
Ptr< MeshPointDeviceGetMeshPoint () const
 Each mesh protocol must be installed on the mesh point to work.
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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 ()
 This method returns the TypeId associated to ns3::flame::FlameProtocol.

Additional Inherited Members

- Public Types inherited from ns3::MeshL2RoutingProtocol
typedef Callback< void, bool,
Ptr< Packet >, Mac48Address,
Mac48Address, uint16_t,
uint32_t > 
RouteReplyCallback
- Protected Attributes inherited from ns3::MeshL2RoutingProtocol
Ptr< MeshPointDevicem_mp
 Host mesh point.

Detailed Description

FLAME routing protocol.


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.

References ns3::MeshL2RoutingProtocol::m_mp.

TypeId ns3::flame::FlameProtocol::GetTypeId ( void  )
static

This method returns the TypeId associated to ns3::flame::FlameProtocol.

This object is accessible through the following paths with Config::Set and Config::Connect:

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

Attributes defined for this type:

  • 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

No TraceSources defined for this type.

Reimplemented from ns3::MeshL2RoutingProtocol.

References ns3::Seconds(), and ns3::TypeId::SetParent().

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

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