Virtual net device modeling mesh point. More...

#include <mesh-point-device.h>

Inheritance diagram for ns3::MeshPointDevice:

Collaboration diagram for ns3::MeshPointDevice:

Classes
struct	Statistics

Public Member Functions
	MeshPointDevice ()
	C-tor create empty (without interfaces and protocols) mesh point. More...

virtual	~MeshPointDevice ()
	D-tor. More...

Interfaces
void	AddInterface (Ptr< NetDevice > port)
	Attach new interface to the station. More...

uint32_t	GetNInterfaces () const

Ptr< NetDevice >	GetInterface (uint32_t id) const

std::vector< Ptr< NetDevice > >	GetInterfaces () const

Protocols
void	SetRoutingProtocol (Ptr< MeshL2RoutingProtocol > protocol)
	Register routing protocol to be used. Protocol must be already installed on this mesh point. More...

Ptr< MeshL2RoutingProtocol >	GetRoutingProtocol () const
	Access current routing protocol. More...

NetDevice interface for upper layers
virtual void	SetIfIndex (const uint32_t index)

virtual uint32_t	GetIfIndex () const

virtual Ptr< Channel >	GetChannel () const

virtual Address	GetAddress () const

virtual void	SetAddress (Address a)
	Set the address of this interface. More...

virtual bool	SetMtu (const uint16_t mtu)

virtual uint16_t	GetMtu () const

virtual bool	IsLinkUp () const

virtual void	AddLinkChangeCallback (Callback< void > callback)

virtual bool	IsBroadcast () const

virtual Address	GetBroadcast () const

virtual bool	IsMulticast () const

virtual Address	GetMulticast (Ipv4Address multicastGroup) const
	Make and return a MAC multicast address using the provided multicast group. More...

virtual bool	IsPointToPoint () const
	Return true if the net device is on a point-to-point link. More...

virtual bool	IsBridge () const
	Return true if the net device is acting as a bridge. More...

virtual bool	Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)

virtual bool	SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)

virtual Ptr< Node >	GetNode () const

virtual void	SetNode (Ptr< Node > node)

virtual bool	NeedsArp () const

virtual void	SetReceiveCallback (NetDevice::ReceiveCallback cb)

virtual void	SetPromiscReceiveCallback (NetDevice::PromiscReceiveCallback cb)

virtual bool	SupportsSendFrom () const

virtual Address	GetMulticast (Ipv6Address addr) const
	Get the MAC multicast address corresponding to the IPv6 address provided. More...

virtual void	DoDispose ()
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

Statistics
void	Report (std::ostream &os) const
	Print statistics counters. More...

void	ResetStats ()
	Reset statistics counters. More...

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

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

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 ()
	Object type ID for NS3 object system. More...

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

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

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

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

Private Member Functions
void	DoSend (bool success, Ptr< Packet > packet, Mac48Address src, Mac48Address dst, uint16_t protocol, uint32_t iface)
	Response callback for L2 routing protocol. More...

void	Forward (Ptr< NetDevice > incomingPort, Ptr< const Packet > packet, uint16_t protocol, const Mac48Address src, const Mac48Address dst)
	Forward packet down to interfaces. More...

void	ReceiveFromDevice (Ptr< NetDevice > device, Ptr< const Packet > packet, uint16_t protocol, Address const &source, Address const &destination, PacketType packetType)
	Receive packet from interface. More...

Private Attributes
Mac48Address	m_address
	Mesh point MAC address, supposed to be the address of the first added interface. More...

Ptr< BridgeChannel >	m_channel
	Virtual channel for upper layers. More...

std::vector< Ptr< NetDevice > >	m_ifaces
	List of interfaces. More...

uint32_t	m_ifIndex
	If index. More...

uint16_t	m_mtu
	MTU in bytes. More...

Ptr< Node >	m_node
	Parent node. More...

NetDevice::PromiscReceiveCallback	m_promiscRxCallback
	Promisc receive action. More...

Ptr< MeshL2RoutingProtocol >	m_routingProtocol
	Current routing protocol, used mainly by GetRoutingProtocol. More...

NetDevice::ReceiveCallback	m_rxCallback
	Receive action. More...

Device statistics counters
Statistics	m_rxStats
	Counters. More...

Statistics	m_txStats
	Counters. More...

Statistics	m_fwdStats
	Counters. More...

Additional Inherited Members
Public Types inherited from ns3::NetDevice
enum	PacketType { PACKET_HOST = 1, NS3_PACKET_HOST = PACKET_HOST, PACKET_BROADCAST, NS3_PACKET_BROADCAST = PACKET_BROADCAST, PACKET_MULTICAST, NS3_PACKET_MULTICAST = PACKET_MULTICAST, PACKET_OTHERHOST, NS3_PACKET_OTHERHOST = PACKET_OTHERHOST }
	Packet types are used as they are in Linux. More...

typedef Callback< bool, Ptr < NetDevice >, Ptr< const Packet >, uint16_t, const Address &, const Address &, enum PacketType >	PromiscReceiveCallback

typedef Callback< bool, Ptr < NetDevice >, Ptr< const Packet >, uint16_t, const Address & >	ReceiveCallback

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

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

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

Virtual net device modeling mesh point.

Mesh point is a virtual net device which is responsible for

Aggregating and coordinating 1..* real devices – mesh interfaces, see MeshInterfaceDevice class.
Hosting all mesh-related level 2 protocols.

One of hosted L2 protocols must inplement L2RoutingProtocol interface and is used for packets forwarding.

From the level 3 point of view MeshPointDevice is similar to BridgeNetDevice, but the packets, which going through may be changed (because L2 protocols may require their own headers or tags).

Attributes:

Todo:

Config Paths

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

/NodeList/[i]/DeviceList/[i]/$ns3::MeshPointDevice

Attributes

Mtu: The MAC-level Maximum Transmission Unit
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 65535
- Flags: construct write read
RoutingProtocol: The mesh routing protocol used by this mesh point.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::MeshL2RoutingProtocol >
- Initial value: 0
- Flags: construct write read

No TraceSources are defined for this type.

Definition at line 49 of file mesh-point-device.h.

Constructor & Destructor Documentation

ns3::MeshPointDevice::MeshPointDevice ( )

C-tor create empty (without interfaces and protocols) mesh point.

Definition at line 58 of file mesh-point-device.cc.

References m_channel, and NS_LOG_FUNCTION_NOARGS.

ns3::MeshPointDevice::~MeshPointDevice ( )

virtual

D-tor.

Definition at line 65 of file mesh-point-device.cc.

References m_channel, m_node, m_routingProtocol, and NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

void ns3::MeshPointDevice::AddInterface ( Ptr< NetDevice > port )

Attach new interface to the station.

Interface must support 48-bit MAC address and SendFrom method.

Attention: Only MeshPointDevice can have IP address, but not individual interfaces.

Definition at line 346 of file mesh-point-device.cc.

References ns3::Mac48Address::ConvertFrom(), ns3::Mac48Address::IsMatchingType(), m_address, m_channel, m_ifaces, m_node, ns3::MakeCallback(), NS_ASSERT, NS_FATAL_ERROR, NS_LOG_FUNCTION_NOARGS, ReceiveFromDevice(), and ns3::Node::RegisterProtocolHandler().

Here is the call graph for this function:

void ns3::MeshPointDevice::AddLinkChangeCallback ( Callback< void > callback )

virtual

Parameters

callback the callback to invoke

Add a callback invoked whenever the link status changes to UP. This callback is typically used by the IP/ARP layer to flush the ARP cache and by IPv6 stack to flush NDISC cache whenever the link goes up.

success	True is route found.
packet	Packet to send
src	Source MAC address
dst	Destination MAC address
protocol	Protocol ID
iface	Interface to use (ID) for send (decided by routing protocol). All interfaces will be used if outIface = 0xffffffff

packet	packet sent from above down to Network Device
dest	mac address of the destination (already resolved)
protocolNumber	identifies the type of payload contained in this packet. Used to call the right L3Protocol when the packet is received.

packet	packet sent from above down to Network Device
source	source mac address (so called "MAC spoofing")
dest	mac address of the destination (already resolved)
protocolNumber	identifies the type of payload contained in this packet. Used to call the right L3Protocol when the packet is received.

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation