A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::MeshPointDevice Class Reference

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
 statistics counters More...
 

Public Member Functions

 MeshPointDevice ()
 C-tor create empty (without interfaces and protocols) mesh point.
 
 ~MeshPointDevice () override
 D-tor.
 
void AddLinkChangeCallback (Callback< void > callback) override
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model.
 
void DoDispose () override
 Destructor implementation.
 
Address GetAddress () const override
 
Address GetBroadcast () const override
 
Ptr< ChannelGetChannel () const override
 
Time GetForwardingDelay () const
 Return a (random) forwarding delay value from the random variable ForwardingDelay attribute.
 
uint32_t GetIfIndex () const override
 
uint16_t GetMtu () const override
 
Address GetMulticast (Ipv4Address multicastGroup) const override
 Make and return a MAC multicast address using the provided multicast group.
 
Address GetMulticast (Ipv6Address addr) const override
 Get the MAC multicast address corresponding to the IPv6 address provided.
 
Ptr< NodeGetNode () const override
 
bool IsBridge () const override
 Return true if the net device is acting as a bridge.
 
bool IsBroadcast () const override
 
bool IsLinkUp () const override
 
bool IsMulticast () const override
 
bool IsPointToPoint () const override
 Return true if the net device is on a point-to-point link.
 
bool NeedsArp () const override
 
bool Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber) override
 
bool SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber) override
 
void SetAddress (Address a) override
 Set the address of this interface.
 
void SetIfIndex (const uint32_t index) override
 
bool SetMtu (const uint16_t mtu) override
 
void SetNode (Ptr< Node > node) override
 
void SetPromiscReceiveCallback (NetDevice::PromiscReceiveCallback cb) override
 
void SetReceiveCallback (NetDevice::ReceiveCallback cb) override
 
bool SupportsSendFrom () const override
 
Interfaces
void AddInterface (Ptr< NetDevice > port)
 Attach new interface to the station.
 
uint32_t GetNInterfaces () const
 
Ptr< NetDeviceGetInterface (uint32_t id) const
 
std::vector< Ptr< NetDevice > > GetInterfaces () const
 
Protocols
void SetRoutingProtocol (Ptr< MeshL2RoutingProtocol > protocol)
 Register routing protocol to be used.
 
Ptr< MeshL2RoutingProtocolGetRoutingProtocol () const
 Access current routing protocol.
 
Statistics
void Report (std::ostream &os) const
 Print statistics counters.
 
void ResetStats ()
 Reset statistics counters.
 
- Public Member Functions inherited from ns3::NetDevice
 ~NetDevice () override
 
virtual void AddLinkChangeCallback (Callback< void > callback)=0
 
virtual Address GetAddress () const =0
 
virtual Address GetBroadcast () const =0
 
virtual Ptr< ChannelGetChannel () const =0
 
virtual uint32_t GetIfIndex () const =0
 
virtual uint16_t GetMtu () const =0
 
virtual Address GetMulticast (Ipv4Address multicastGroup) const =0
 Make and return a MAC multicast address using the provided multicast group.
 
virtual Address GetMulticast (Ipv6Address addr) const =0
 Get the MAC multicast address corresponding to the IPv6 address provided.
 
virtual Ptr< NodeGetNode () const =0
 
virtual bool IsBridge () const =0
 Return true if the net device is acting as a bridge.
 
virtual bool IsBroadcast () const =0
 
virtual bool IsLinkUp () const =0
 
virtual bool IsMulticast () const =0
 
virtual bool IsPointToPoint () const =0
 Return true if the net device is on a point-to-point link.
 
virtual bool NeedsArp () const =0
 
virtual bool Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)=0
 
virtual bool SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)=0
 
virtual void SetAddress (Address address)=0
 Set the address of this interface.
 
virtual void SetIfIndex (const uint32_t index)=0
 
virtual bool SetMtu (const uint16_t mtu)=0
 
virtual void SetNode (Ptr< Node > node)=0
 
virtual void SetPromiscReceiveCallback (PromiscReceiveCallback cb)=0
 
virtual void SetReceiveCallback (ReceiveCallback cb)=0
 
virtual bool SupportsSendFrom () const =0
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
virtual TypeId GetInstanceTypeId () const =0
 Get the most derived TypeId for this Object.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::NetDevice
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

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.
 
void Forward (Ptr< NetDevice > incomingPort, Ptr< const Packet > packet, uint16_t protocol, const Mac48Address src, const Mac48Address dst)
 Forward packet down to interfaces.
 
void ReceiveFromDevice (Ptr< NetDevice > device, Ptr< const Packet > packet, uint16_t protocol, const Address &source, const Address &destination, PacketType packetType)
 Receive packet from interface.
 

Private Attributes

Mac48Address m_address
 Mesh point MAC address, supposed to be the address of the first added interface.
 
Ptr< BridgeChannelm_channel
 Virtual channel for upper layers.
 
Ptr< RandomVariableStreamm_forwardingRandomVariable
 Random variable used for forwarding delay and jitter.
 
Statistics m_fwdStats
 forward statistics
 
std::vector< Ptr< NetDevice > > m_ifaces
 List of interfaces.
 
uint32_t m_ifIndex
 If index.
 
uint16_t m_mtu
 MTU in bytes.
 
Ptr< Nodem_node
 Parent node.
 
NetDevice::PromiscReceiveCallback m_promiscRxCallback
 Promisc receive action.
 
Ptr< MeshL2RoutingProtocolm_routingProtocol
 Current routing protocol, used mainly by GetRoutingProtocol.
 
NetDevice::ReceiveCallback m_rxCallback
 Receive action.
 
Statistics m_rxStats
 receive statistics
 
Statistics m_txStats
 transmit statistics
 

Additional Inherited Members

- Public Types inherited from ns3::NetDevice
typedef void(* LinkChangeTracedCallback) ()
 TracedCallback signature for link changed event.
 
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 &, PacketTypePromiscReceiveCallback
 
typedef Callback< bool, Ptr< NetDevice >, Ptr< const Packet >, uint16_t, const Address & > ReceiveCallback
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

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 implement 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

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

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

Constructor & Destructor Documentation

◆ MeshPointDevice()

ns3::MeshPointDevice::MeshPointDevice ( )

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

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

References m_channel, and NS_LOG_FUNCTION.

◆ ~MeshPointDevice()

ns3::MeshPointDevice::~MeshPointDevice ( )
override

D-tor.

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

References m_channel, m_node, m_routingProtocol, and NS_LOG_FUNCTION.

Member Function Documentation

◆ AddInterface()

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

Attach new interface to the station.

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

Parameters
portthe port used
Attention
Only MeshPointDevice can have IP address, but not individual interfaces.

Definition at line 419 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, ReceiveFromDevice(), and ns3::Node::RegisterProtocolHandler().

+ Here is the call graph for this function:

◆ AddLinkChangeCallback()

void ns3::MeshPointDevice::AddLinkChangeCallback ( Callback< void >  callback)
overridevirtual
Parameters
callbackthe 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.

Implements ns3::NetDevice.

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

References NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ AssignStreams()

int64_t ns3::MeshPointDevice::AssignStreams ( int64_t  stream)

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

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

References m_forwardingRandomVariable, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

+ Here is the call graph for this function:

◆ DoDispose()

void ns3::MeshPointDevice::DoDispose ( )
overridevirtual

Destructor implementation.

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

Subclasses are expected to implement their real destruction code in an overridden 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 82 of file mesh-point-device.cc.

References ns3::Object::DoDispose(), m_channel, m_ifaces, m_node, m_routingProtocol, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoSend()

void ns3::MeshPointDevice::DoSend ( bool  success,
Ptr< Packet packet,
Mac48Address  src,
Mac48Address  dst,
uint16_t  protocol,
uint32_t  iface 
)
private

Response callback for L2 routing protocol.

This will be executed when routing information is ready.

Parameters
successTrue is route found.
packetPacket to send
srcSource MAC address
dstDestination MAC address
protocolProtocol ID
ifaceInterface to use (ID) for send (decided by routing protocol). All interfaces will be used if outIface = 0xffffffff
Todo:
diagnose routing errors

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

References ns3::MeshPointDevice::Statistics::broadcastData, ns3::MeshPointDevice::Statistics::broadcastDataBytes, GetInterface(), ns3::Mac48Address::IsBroadcast(), m_address, m_fwdStats, m_ifaces, m_txStats, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::MeshPointDevice::Statistics::unicastData, and ns3::MeshPointDevice::Statistics::unicastDataBytes.

Referenced by Forward(), Send(), and SendFrom().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Forward()

void ns3::MeshPointDevice::Forward ( Ptr< NetDevice incomingPort,
Ptr< const Packet packet,
uint16_t  protocol,
const Mac48Address  src,
const Mac48Address  dst 
)
private

Forward packet down to interfaces.

Parameters
incomingPortthe incoming port
packetthe packet to forward
protocolthe protocol
srcthe source MAC address
dstthe destination MAC address

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

References DoSend(), m_address, m_routingProtocol, ns3::MakeCallback(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by ReceiveFromDevice().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetAddress()

Address ns3::MeshPointDevice::GetAddress ( ) const
overridevirtual
Returns
the current Address of this interface.

Implements ns3::NetDevice.

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

References m_address, and NS_LOG_FUNCTION.

◆ GetBroadcast()

Address ns3::MeshPointDevice::GetBroadcast ( ) const
overridevirtual
Returns
the broadcast address supported by this netdevice.

Calling this method is invalid if IsBroadcast returns not true.

Implements ns3::NetDevice.

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

References NS_LOG_FUNCTION.

◆ GetChannel()

Ptr< Channel > ns3::MeshPointDevice::GetChannel ( ) const
overridevirtual
Returns
the channel this NetDevice is connected to. The value returned can be zero if the NetDevice is not yet connected to any channel or if the underlying NetDevice has no concept of a channel. i.e., callers must check for zero and be ready to handle it.

Implements ns3::NetDevice.

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

References m_channel, and NS_LOG_FUNCTION.

◆ GetForwardingDelay()

Time ns3::MeshPointDevice::GetForwardingDelay ( ) const

Return a (random) forwarding delay value from the random variable ForwardingDelay attribute.

Returns
A Time value from the ForwardingDelay random variable

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

References ns3::RandomVariableStream::GetInteger(), m_forwardingRandomVariable, and ns3::MicroSeconds().

Referenced by ReceiveFromDevice().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetIfIndex()

uint32_t ns3::MeshPointDevice::GetIfIndex ( ) const
overridevirtual
Returns
index ifIndex of the device

Implements ns3::NetDevice.

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

References m_ifIndex, and NS_LOG_FUNCTION.

◆ GetInterface()

Ptr< NetDevice > ns3::MeshPointDevice::GetInterface ( uint32_t  id) const
Returns
interface device by its index (aka ID)
Parameters
idis interface id, 0 <= id < GetNInterfaces

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

References m_ifaces, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by DoSend().

+ Here is the caller graph for this function:

◆ GetInterfaces()

std::vector< Ptr< NetDevice > > ns3::MeshPointDevice::GetInterfaces ( ) const
Returns
vector of interfaces

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

References m_ifaces.

◆ GetMtu()

uint16_t ns3::MeshPointDevice::GetMtu ( ) const
overridevirtual
Returns
the link-level MTU in bytes for this interface.

This value is typically used by the IP layer to perform IP fragmentation when needed.

Implements ns3::NetDevice.

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

References m_mtu, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetMulticast() [1/2]

Address ns3::MeshPointDevice::GetMulticast ( Ipv4Address  multicastGroup) const
overridevirtual

Make and return a MAC multicast address using the provided multicast group.

RFC 1112 says that an Ipv4 host group address is mapped to an Ethernet multicast address by placing the low-order 23-bits of the IP address into the low-order 23 bits of the Ethernet multicast address 01-00-5E-00-00-00 (hex). Similar RFCs exist for Ipv6 and Eui64 mappings. This method performs the multicast address creation function appropriate to the underlying MAC address of the device. This MAC address is encapsulated in an abstract Address to avoid dependencies on the exact MAC address format.

In the case of net devices that do not support multicast, clients are expected to test NetDevice::IsMulticast and avoid attempting to map multicast packets. Subclasses of NetDevice that do support multicasting are expected to override this method and provide an implementation appropriate to the particular device.

Parameters
multicastGroupThe IP address for the multicast group destination of the packet.
Returns
The MAC multicast Address used to send packets to the provided multicast group.
Warning
Calling this method is invalid if IsMulticast returns not true.
See also
IsMulticast()

Implements ns3::NetDevice.

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

References ns3::Mac48Address::GetMulticast(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetMulticast() [2/2]

Address ns3::MeshPointDevice::GetMulticast ( Ipv6Address  addr) const
overridevirtual

Get the MAC multicast address corresponding to the IPv6 address provided.

Parameters
addrIPv6 address
Returns
the MAC multicast address
Warning
Calling this method is invalid if IsMulticast returns not true.

Implements ns3::NetDevice.

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

References ns3::Mac48Address::GetMulticast(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetNInterfaces()

uint32_t ns3::MeshPointDevice::GetNInterfaces ( ) const
Returns
number of interfaces

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

References m_ifaces, and NS_LOG_FUNCTION.

◆ GetNode()

Ptr< Node > ns3::MeshPointDevice::GetNode ( ) const
overridevirtual
Returns
the node base class which contains this network interface.

When a subclass needs to get access to the underlying node base class to print the nodeid for example, it can invoke this method.

Implements ns3::NetDevice.

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

References m_node, and NS_LOG_FUNCTION.

◆ GetRoutingProtocol()

Ptr< MeshL2RoutingProtocol > ns3::MeshPointDevice::GetRoutingProtocol ( ) const

Access current routing protocol.

Returns
the current routing protocol

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

References m_routingProtocol, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::MeshPointDevice::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

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

References GetMtu(), GetRoutingProtocol(), m_forwardingRandomVariable, ns3::MakePointerAccessor(), ns3::MakeUintegerAccessor(), SetMtu(), ns3::TypeId::SetParent(), and SetRoutingProtocol().

+ Here is the call graph for this function:

◆ IsBridge()

bool ns3::MeshPointDevice::IsBridge ( ) const
overridevirtual

Return true if the net device is acting as a bridge.

Returns
value of m_isBridge flag

Implements ns3::NetDevice.

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

References NS_LOG_FUNCTION.

◆ IsBroadcast()

bool ns3::MeshPointDevice::IsBroadcast ( ) const
overridevirtual
Returns
true if this interface supports a broadcast address, false otherwise.

Implements ns3::NetDevice.

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

References NS_LOG_FUNCTION.

◆ IsLinkUp()

bool ns3::MeshPointDevice::IsLinkUp ( ) const
overridevirtual
Returns
true if link is up; false otherwise

Implements ns3::NetDevice.

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

References NS_LOG_FUNCTION.

◆ IsMulticast()

bool ns3::MeshPointDevice::IsMulticast ( ) const
overridevirtual
Returns
value of m_isMulticast flag

Implements ns3::NetDevice.

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

References NS_LOG_FUNCTION.

◆ IsPointToPoint()

bool ns3::MeshPointDevice::IsPointToPoint ( ) const
overridevirtual

Return true if the net device is on a point-to-point link.

Returns
value of m_isPointToPoint flag

Implements ns3::NetDevice.

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

References NS_LOG_FUNCTION.

◆ NeedsArp()

bool ns3::MeshPointDevice::NeedsArp ( ) const
overridevirtual
Returns
true if ARP is needed, false otherwise.

Called by higher-layers to check if this NetDevice requires ARP to be used.

Implements ns3::NetDevice.

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

References NS_LOG_FUNCTION.

◆ ReceiveFromDevice()

void ns3::MeshPointDevice::ReceiveFromDevice ( Ptr< NetDevice device,
Ptr< const Packet packet,
uint16_t  protocol,
const Address source,
const Address destination,
PacketType  packetType 
)
private

Receive packet from interface.

Parameters
devicethe device to receive from
packetthe received packet
protocolthe protocol
sourcethe source address
destinationthe destination address
packetTypethe packet type

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

References ns3::Time::As(), ns3::MeshPointDevice::Statistics::broadcastData, ns3::MeshPointDevice::Statistics::broadcastDataBytes, ns3::Mac48Address::ConvertFrom(), Forward(), GetForwardingDelay(), ns3::Mac48Address::IsGroup(), ns3::Callback< R, UArgs >::IsNull(), m_address, m_promiscRxCallback, m_routingProtocol, m_rxCallback, m_rxStats, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), ns3::MeshPointDevice::Statistics::unicastData, ns3::MeshPointDevice::Statistics::unicastDataBytes, and ns3::Time::US.

Referenced by AddInterface().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Report()

void ns3::MeshPointDevice::Report ( std::ostream &  os) const

◆ ResetStats()

void ns3::MeshPointDevice::ResetStats ( )

Reset statistics counters.

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

References m_fwdStats, m_rxStats, m_txStats, and NS_LOG_FUNCTION.

◆ Send()

bool ns3::MeshPointDevice::Send ( Ptr< Packet packet,
const Address dest,
uint16_t  protocolNumber 
)
overridevirtual
Parameters
packetpacket sent from above down to Network Device
destmac address of the destination (already resolved)
protocolNumberidentifies the type of payload contained in this packet. Used to call the right L3Protocol when the packet is received.

Called from higher layer to send packet into Network Device to the specified destination Address

Returns
whether the Send operation succeeded

Implements ns3::NetDevice.

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

References ns3::Mac48Address::ConvertFrom(), DoSend(), m_address, m_ifIndex, m_routingProtocol, ns3::MakeCallback(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SendFrom()

bool ns3::MeshPointDevice::SendFrom ( Ptr< Packet packet,
const Address source,
const Address dest,
uint16_t  protocolNumber 
)
overridevirtual
Parameters
packetpacket sent from above down to Network Device
sourcesource mac address (so called "MAC spoofing")
destmac address of the destination (already resolved)
protocolNumberidentifies the type of payload contained in this packet. Used to call the right L3Protocol when the packet is received.

Called from higher layer to send packet into Network Device with the specified source and destination Addresses.

Returns
whether the Send operation succeeded

Implements ns3::NetDevice.

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

References ns3::Mac48Address::ConvertFrom(), DoSend(), m_ifIndex, m_routingProtocol, ns3::MakeCallback(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SetAddress()

void ns3::MeshPointDevice::SetAddress ( Address  address)
overridevirtual

Set the address of this interface.

Parameters
addressaddress to set

Implements ns3::NetDevice.

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

References ns3::Mac48Address::ConvertFrom(), m_address, NS_LOG_FUNCTION, and NS_LOG_WARN.

+ Here is the call graph for this function:

◆ SetIfIndex()

void ns3::MeshPointDevice::SetIfIndex ( const uint32_t  index)
overridevirtual
Parameters
indexifIndex of the device

Implements ns3::NetDevice.

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

References m_ifIndex, and NS_LOG_FUNCTION.

◆ SetMtu()

bool ns3::MeshPointDevice::SetMtu ( const uint16_t  mtu)
overridevirtual
Parameters
mtuMTU value, in bytes, to set for the device
Returns
whether the MTU value was within legal bounds

Override for default MTU defined on a per-type basis.

Implements ns3::NetDevice.

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

References m_mtu, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetNode()

void ns3::MeshPointDevice::SetNode ( Ptr< Node node)
overridevirtual
Parameters
nodethe node associated to this netdevice.

This method is called from ns3::Node::AddDevice.

Implements ns3::NetDevice.

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

References m_node, and NS_LOG_FUNCTION.

◆ SetPromiscReceiveCallback()

void ns3::MeshPointDevice::SetPromiscReceiveCallback ( NetDevice::PromiscReceiveCallback  cb)
overridevirtual
Parameters
cbcallback to invoke whenever a packet has been received in promiscuous mode and must be forwarded to the higher layers.

Enables netdevice promiscuous mode and sets the callback that will handle promiscuous mode packets. Note, promiscuous mode packets means all packets, including those packets that can be sensed by the netdevice but which are intended to be received by other hosts.

Implements ns3::NetDevice.

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

References m_promiscRxCallback, and NS_LOG_FUNCTION.

◆ SetReceiveCallback()

void ns3::MeshPointDevice::SetReceiveCallback ( NetDevice::ReceiveCallback  cb)
overridevirtual
Parameters
cbcallback to invoke whenever a packet has been received and must be forwarded to the higher layers.

Set the callback to be used to notify higher layers when a packet has been received.

Implements ns3::NetDevice.

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

References m_rxCallback, and NS_LOG_FUNCTION.

◆ SetRoutingProtocol()

void ns3::MeshPointDevice::SetRoutingProtocol ( Ptr< MeshL2RoutingProtocol protocol)

Register routing protocol to be used.

Protocol must be already installed on this mesh point.

Parameters
protocolthe routing protocol

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

References m_routingProtocol, NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::PeekPointer().

Referenced by GetTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SupportsSendFrom()

bool ns3::MeshPointDevice::SupportsSendFrom ( ) const
overridevirtual
Returns
true if this interface supports a bridging mode, false otherwise.

Implements ns3::NetDevice.

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

References NS_LOG_FUNCTION.

Member Data Documentation

◆ m_address

Mac48Address ns3::MeshPointDevice::m_address
private

Mesh point MAC address, supposed to be the address of the first added interface.

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

Referenced by AddInterface(), DoSend(), Forward(), GetAddress(), ReceiveFromDevice(), Send(), and SetAddress().

◆ m_channel

Ptr<BridgeChannel> ns3::MeshPointDevice::m_channel
private

Virtual channel for upper layers.

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

Referenced by MeshPointDevice(), ~MeshPointDevice(), AddInterface(), DoDispose(), and GetChannel().

◆ m_forwardingRandomVariable

Ptr<RandomVariableStream> ns3::MeshPointDevice::m_forwardingRandomVariable
private

Random variable used for forwarding delay and jitter.

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

Referenced by AssignStreams(), GetForwardingDelay(), and GetTypeId().

◆ m_fwdStats

Statistics ns3::MeshPointDevice::m_fwdStats
private

forward statistics

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

Referenced by DoSend(), Report(), and ResetStats().

◆ m_ifaces

std::vector<Ptr<NetDevice> > ns3::MeshPointDevice::m_ifaces
private

List of interfaces.

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

Referenced by AddInterface(), DoDispose(), DoSend(), GetInterface(), GetInterfaces(), and GetNInterfaces().

◆ m_ifIndex

uint32_t ns3::MeshPointDevice::m_ifIndex
private

If index.

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

Referenced by GetIfIndex(), Send(), SendFrom(), and SetIfIndex().

◆ m_mtu

uint16_t ns3::MeshPointDevice::m_mtu
private

MTU in bytes.

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

Referenced by GetMtu(), and SetMtu().

◆ m_node

Ptr<Node> ns3::MeshPointDevice::m_node
private

Parent node.

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

Referenced by ~MeshPointDevice(), AddInterface(), DoDispose(), GetNode(), and SetNode().

◆ m_promiscRxCallback

NetDevice::PromiscReceiveCallback ns3::MeshPointDevice::m_promiscRxCallback
private

Promisc receive action.

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

Referenced by ReceiveFromDevice(), and SetPromiscReceiveCallback().

◆ m_routingProtocol

Ptr<MeshL2RoutingProtocol> ns3::MeshPointDevice::m_routingProtocol
private

Current routing protocol, used mainly by GetRoutingProtocol.

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

Referenced by ~MeshPointDevice(), DoDispose(), Forward(), GetRoutingProtocol(), ReceiveFromDevice(), Send(), SendFrom(), and SetRoutingProtocol().

◆ m_rxCallback

NetDevice::ReceiveCallback ns3::MeshPointDevice::m_rxCallback
private

Receive action.

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

Referenced by ReceiveFromDevice(), and SetReceiveCallback().

◆ m_rxStats

Statistics ns3::MeshPointDevice::m_rxStats
private

receive statistics

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

Referenced by ReceiveFromDevice(), Report(), and ResetStats().

◆ m_txStats

Statistics ns3::MeshPointDevice::m_txStats
private

transmit statistics

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

Referenced by DoSend(), Report(), and ResetStats().


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