a virtual net device that bridges multiple LAN segments More...

#include "bridge-net-device.h"

Inheritance diagram for ns3::BridgeNetDevice:

Classes
struct	LearnedState
	Structure holding the status of an address. More...

Public Member Functions
	BridgeNetDevice ()

virtual	~BridgeNetDevice ()

void	AddBridgePort (Ptr< NetDevice > bridgePort)
	Add a 'port' to a bridge device. More...

virtual void	AddLinkChangeCallback (Callback< void > callback)

virtual Address	GetAddress (void) const

Ptr< NetDevice >	GetBridgePort (uint32_t n) const
	Gets the n-th bridged port. More...

virtual Address	GetBroadcast (void) const

virtual Ptr< Channel >	GetChannel (void) const

virtual uint32_t	GetIfIndex (void) const

virtual uint16_t	GetMtu (void) const

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

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

uint32_t	GetNBridgePorts (void) const
	Gets the number of bridged 'ports', i.e., the NetDevices currently bridged. More...

virtual Ptr< Node >	GetNode (void) const

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

virtual bool	IsBroadcast (void) const

virtual bool	IsLinkUp (void) const

virtual bool	IsMulticast (void) const

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

virtual bool	NeedsArp (void) const

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 void	SetAddress (Address address)
	Set the address of this interface. More...

virtual void	SetIfIndex (const uint32_t index)

virtual bool	SetMtu (const uint16_t mtu)

virtual void	SetNode (Ptr< Node > node)

virtual void	SetPromiscReceiveCallback (NetDevice::PromiscReceiveCallback cb)

virtual void	SetReceiveCallback (NetDevice::ReceiveCallback cb)

virtual bool	SupportsSendFrom () const

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

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

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

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized (void) const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default 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 operator. 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
	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)
	Get the type ID. More...

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

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

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

Protected Member Functions
virtual void	DoDispose (void)
	Destructor implementation. More...

void	ForwardBroadcast (Ptr< NetDevice > incomingPort, Ptr< const Packet > packet, uint16_t protocol, Mac48Address src, Mac48Address dst)
	Forwards a broadcast or a multicast packet. More...

void	ForwardUnicast (Ptr< NetDevice > incomingPort, Ptr< const Packet > packet, uint16_t protocol, Mac48Address src, Mac48Address dst)
	Forwards a unicast packet. More...

Ptr< NetDevice >	GetLearnedState (Mac48Address source)
	Gets the port associated to a source address. More...

void	Learn (Mac48Address source, Ptr< NetDevice > port)
	Learns the port a MAC address is sending from. More...

void	ReceiveFromDevice (Ptr< NetDevice > device, Ptr< const Packet > packet, uint16_t protocol, Address const &source, Address const &destination, PacketType packetType)
	Receives a packet from one bridged port. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

virtual void	NotifyNewAggregate (void)
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

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

Private Member Functions
	BridgeNetDevice (const BridgeNetDevice &)
	Copy constructor. More...

BridgeNetDevice &	operator= (const BridgeNetDevice &)
	Copy constructor. More...

Private Attributes
Mac48Address	m_address
	MAC address of the NetDevice. More...

Ptr< BridgeChannel >	m_channel
	virtual bridged channel More...

bool	m_enableLearning
	true if the bridge will learn the node status More...

Time	m_expirationTime
	time it takes for learned MAC state to expire More...

uint32_t	m_ifIndex
	Interface index. More...

std::map< Mac48Address, LearnedState >	m_learnState
	Container for known address statuses. More...

uint16_t	m_mtu
	MTU of the bridged NetDevice. More...

Ptr< Node >	m_node
	node owning this NetDevice More...

std::vector< Ptr< NetDevice > >	m_ports
	bridged ports More...

NetDevice::PromiscReceiveCallback	m_promiscRxCallback
	promiscuous receive callback More...

NetDevice::ReceiveCallback	m_rxCallback
	receive callback More...

Additional Inherited Members
Public Types inherited from ns3::NetDevice
typedef void(*	LinkChangeTracedCallback) (void)
	TracedCallback signature for link changed event. More...

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

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

a virtual net device that bridges multiple LAN segments

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::BridgeNetDevice"

Attributes

Mtu: The MAC-level Maximum Transmission Unit
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 1500
- Flags: construct write read
EnableLearning: Enable the learning mode of the Learning Bridge
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
ExpirationTime: Time it takes for learned MAC state entry to expire.
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +300000000000.0ns
- Flags: construct write read

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

Definition at line 65 of file bridge-net-device.h.

Constructor & Destructor Documentation

◆ BridgeNetDevice() [1/2]

ns3::BridgeNetDevice::BridgeNetDevice ( )

Definition at line 61 of file bridge-net-device.cc.

References m_channel, and NS_LOG_FUNCTION_NOARGS.

◆ ~BridgeNetDevice()

ns3::BridgeNetDevice::~BridgeNetDevice ( )

virtual

Definition at line 69 of file bridge-net-device.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ BridgeNetDevice() [2/2]

ns3::BridgeNetDevice::BridgeNetDevice ( const BridgeNetDevice & )

private

Copy constructor.

Defined and unimplemented to avoid misuse

Member Function Documentation

◆ AddBridgePort()

void ns3::BridgeNetDevice::AddBridgePort ( Ptr< NetDevice > bridgePort )

Add a 'port' to a bridge device.

Parameters

bridgePort the NetDevice to add

This method adds a new bridge port to a BridgeNetDevice, so that the new bridge port NetDevice becomes part of the bridge and L2 frames start being forwarded to/from this NetDevice.

Parameters

bridgePort NetDevice

Attention: The netdevice that is being added as bridge port must not have an IP address. In order to add IP connectivity to a bridging node you must enable IP on the BridgeNetDevice itself, never on its port netdevices.

Definition at line 244 of file bridge-net-device.cc.

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

◆ AddLinkChangeCallback()

void ns3::BridgeNetDevice::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.

incomingPort	the packet incoming port
packet	the packet
protocol	the packet protocol (e.g., Ethertype)
src	the packet source
dst	the packet destination

device	the originating port
packet	the received packet
protocol	the packet protocol (e.g., Ethertype)
source	the packet source
destination	the packet destination
packetType	the packet type (e.g., host, broadcast, etc.)

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.

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Constructor & Destructor Documentation

◆ BridgeNetDevice() [1/2]

◆ ~BridgeNetDevice()

◆ BridgeNetDevice() [2/2]

Member Function Documentation

◆ AddBridgePort()

◆ AddLinkChangeCallback()

◆ DoDispose()

◆ ForwardBroadcast()

◆ ForwardUnicast()

◆ GetAddress()

◆ GetBridgePort()

◆ GetBroadcast()

◆ GetChannel()

◆ GetIfIndex()

◆ GetLearnedState()

◆ GetMtu()

◆ GetMulticast() [1/2]

◆ GetMulticast() [2/2]

◆ GetNBridgePorts()

◆ GetNode()

◆ GetTypeId()

◆ IsBridge()

◆ IsBroadcast()

◆ IsLinkUp()

◆ IsMulticast()

◆ IsPointToPoint()

◆ Learn()

◆ NeedsArp()

◆ operator=()

◆ ReceiveFromDevice()

◆ Send()

◆ SendFrom()

◆ SetAddress()

◆ SetIfIndex()

◆ SetMtu()

◆ SetNode()

◆ SetPromiscReceiveCallback()

◆ SetReceiveCallback()

◆ SupportsSendFrom()

Member Data Documentation

◆ m_address

◆ m_channel

◆ m_enableLearning

◆ m_expirationTime

◆ m_ifIndex

◆ m_learnState

◆ m_mtu

◆ m_node

◆ m_ports

◆ m_promiscRxCallback

◆ m_rxCallback