Virtual channel implementation for bridges (BridgeNetDevice). More...

#include "bridge-channel.h"

Inheritance diagram for ns3::BridgeChannel:

Collaboration diagram for ns3::BridgeChannel:

Public Member Functions
	BridgeChannel ()

	BridgeChannel (const BridgeChannel &)=delete

	~BridgeChannel () override

void	AddChannel (Ptr< Channel > bridgedChannel)
	Adds a channel to the bridged pool.

Ptr< NetDevice >	GetDevice (std::size_t i) const override

std::size_t	GetNDevices () const override

BridgeChannel &	operator= (const BridgeChannel &)=delete

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

	~Channel () override

virtual Ptr< NetDevice >	GetDevice (std::size_t i) const =0

uint32_t	GetId () const

virtual std::size_t	GetNDevices () 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< Object >	GetObject () 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< Object >	GetObject (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.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

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.

SimpleRefCount &	operator= (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::Channel
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 Attributes
std::vector< Ptr< Channel > >	m_bridgedChannels
	pool of bridged channels

Additional Inherited Members
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.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Virtual channel implementation for bridges (BridgeNetDevice).

Just like BridgeNetDevice aggregates multiple NetDevices, BridgeChannel aggregates multiple channels and make them appear as a single channel to upper layers.

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::BridgeChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::BridgeChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::BridgeChannel"
"/ChannelList/[i]/$ns3::BridgeChannel"

No Attributes are defined for this type.

Attributes defined in parent class ns3::Channel

Id: The id (unique integer) of this Channel.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Flags: read

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

Definition at line 43 of file bridge-channel.h.

Constructor & Destructor Documentation

◆ BridgeChannel() [1/2]

ns3::BridgeChannel::BridgeChannel ( )

Definition at line 45 of file bridge-channel.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ ~BridgeChannel()

ns3::BridgeChannel::~BridgeChannel ( )

override

Definition at line 51 of file bridge-channel.cc.

References m_bridgedChannels, and NS_LOG_FUNCTION_NOARGS.

◆ BridgeChannel() [2/2]

ns3::BridgeChannel::BridgeChannel ( const BridgeChannel & )

delete

Member Function Documentation

◆ AddChannel()

void ns3::BridgeChannel::AddChannel ( Ptr< Channel > bridgedChannel )

Adds a channel to the bridged pool.

Parameters

bridgedChannel the channel to add to the pool

Definition at line 63 of file bridge-channel.cc.

References m_bridgedChannels.

◆ GetDevice()

Ptr< NetDevice > ns3::BridgeChannel::GetDevice ( std::size_t i ) const

overridevirtual

Parameters

i	index of NetDevice to retrieve

Returns: one of the NetDevices connected to this channel.

This method must be implemented by subclasses.

Implements ns3::Channel.

Definition at line 80 of file bridge-channel.cc.

References m_bridgedChannels.

◆ GetNDevices()

std::size_t ns3::BridgeChannel::GetNDevices ( ) const

overridevirtual

Returns: the number of NetDevices connected to this Channel.

This method must be implemented by subclasses.

Implements ns3::Channel.

Definition at line 69 of file bridge-channel.cc.

References m_bridgedChannels.

◆ GetTypeId()

TypeId ns3::BridgeChannel::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 36 of file bridge-channel.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ operator=()

BridgeChannel & ns3::BridgeChannel::operator= ( const BridgeChannel & )

delete

Member Data Documentation

◆ m_bridgedChannels

std::vector<Ptr<Channel> > ns3::BridgeChannel::m_bridgedChannels

private

pool of bridged channels

Definition at line 69 of file bridge-channel.h.

Referenced by ~BridgeChannel(), AddChannel(), GetDevice(), and GetNDevices().

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

src/bridge/model/bridge-channel.h
src/bridge/model/bridge-channel.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes defined in parent class ns3::Channel

Constructor & Destructor Documentation

◆ BridgeChannel() [1/2]

◆ ~BridgeChannel()

◆ BridgeChannel() [2/2]

Member Function Documentation

◆ AddChannel()

◆ GetDevice()

◆ GetNDevices()

◆ GetTypeId()

◆ operator=()

Member Data Documentation

◆ m_bridgedChannels