A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::TapBridgeHelper Class Reference

build TapBridge to allow ns-3 simulations to interact with Linux tap devices and processes on the Linux host. More...

#include <tap-bridge-helper.h>

Public Member Functions

 TapBridgeHelper ()
 
 TapBridgeHelper (Ipv4Address gateway)
 
Ptr< NetDeviceInstall (Ptr< Node > node, Ptr< NetDevice > nd)
 
Ptr< NetDeviceInstall (std::string nodeName, Ptr< NetDevice > nd)
 
Ptr< NetDeviceInstall (Ptr< Node > node, std::string ndName)
 
Ptr< NetDeviceInstall (std::string nodeName, std::string ndName)
 
Ptr< NetDeviceInstall (Ptr< Node > node, Ptr< NetDevice > nd, const AttributeValue &bridgeType)
 
void SetAttribute (std::string n1, const AttributeValue &v1)
 

Private Attributes

ObjectFactory m_deviceFactory
 

Detailed Description

build TapBridge to allow ns-3 simulations to interact with Linux tap devices and processes on the Linux host.

Definition at line 36 of file tap-bridge-helper.h.

Constructor & Destructor Documentation

ns3::TapBridgeHelper::TapBridgeHelper ( )

Construct a TapBridgeHelper to make life easier for people wanting to have their simulations interact with Linux tap devices and processes on the Linux host.

Definition at line 30 of file tap-bridge-helper.cc.

References NS_LOG_FUNCTION_NOARGS, and ns3::ObjectFactory::SetTypeId().

ns3::TapBridgeHelper::TapBridgeHelper ( Ipv4Address  gateway)

Construct a TapBridgeHelper to make life easier for people wanting to have their simulations interact with Linux tap devices and processes on the Linux host.

Parameters
gatewayAn Ipv4Address to be used as the default gateway for the created bridges,

Definition at line 36 of file tap-bridge-helper.cc.

References ns3::TapBridge::CONFIGURE_LOCAL, NS_LOG_FUNCTION_NOARGS, and ns3::ObjectFactory::SetTypeId().

Member Function Documentation

Ptr< NetDevice > ns3::TapBridgeHelper::Install ( Ptr< Node node,
Ptr< NetDevice nd 
)

This method installs a TapBridge on the specified Node and forms the bridge with the NetDevice specified. The Node is specified using a Ptr<Node> and the NetDevice is specified using a Ptr<NetDevice>

Parameters
nodeThe Ptr<Node> to install the TapBridge in
ndThe Ptr<NetDevice> to attach to the bridge.
Returns
A pointer to the new TapBridge NetDevice.

Definition at line 61 of file tap-bridge-helper.cc.

References ns3::Node::AddDevice(), ns3::ObjectFactory::Create(), ns3::Node::GetId(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by Install().

Ptr< NetDevice > ns3::TapBridgeHelper::Install ( std::string  nodeName,
Ptr< NetDevice nd 
)

This method installs a TapBridge on the specified Node and forms the bridge with the NetDevice specified. The node is specified by a name string that has previously been associated with the Node using the Object Name Service. The NetDevice is specified by a Ptr<NetDevice>.

Parameters
nodeNameThe name of the Node to install the TapBridge in
ndThe Ptr<NetDevice> to attach to the bridge.
Returns
A pointer to the new TapBridge NetDevice.

Definition at line 74 of file tap-bridge-helper.cc.

References Install().

Ptr< NetDevice > ns3::TapBridgeHelper::Install ( Ptr< Node node,
std::string  ndName 
)

This method installs a TapBridge on the specified Node and forms the bridge with the NetDevice specified. The NetDevice is specified by a name string that has previously been associated with the NetDevice using the Object Name Service.

Parameters
nodeThe Ptr<Node> to install the TapBridge in
ndNameThe name of the NetDevice to attach to the bridge.
Returns
A pointer to the new TapBridge NetDevice.

Definition at line 81 of file tap-bridge-helper.cc.

References Install().

Ptr< NetDevice > ns3::TapBridgeHelper::Install ( std::string  nodeName,
std::string  ndName 
)

This method installs a TapBridge on the specified Node and forms the bridge with the NetDevice specified. The node is specified by a name string that has previously been associated with the Node using the Object Name Service. The NetDevice is specified by a name string that has previously been associated with the Object Name Service.

Parameters
nodeNameThe name of the Node to install the TapBridge in
ndNameThe name of the NetDevice to attach to the bridge.
Returns
A pointer to the new TapBridge NetDevice.

Definition at line 88 of file tap-bridge-helper.cc.

References Install().

Ptr< NetDevice > ns3::TapBridgeHelper::Install ( Ptr< Node node,
Ptr< NetDevice nd,
const AttributeValue bridgeType 
)

This method installs a TapBridge on the specified Node and forms the bridge with the NetDevice specified. The Node is specified using a Ptr<Node> and the NetDevice is specified using a Ptr<NetDevice>. The type of the actual Bridge device is specified with the provided AttributeValue (typically "ns3::TapBridge").

Parameters
nodeThe Ptr<Node> to install the TapBridge in
ndThe Ptr<NetDevice> to attach to the bridge.
bridgeTypeThe TypeId of the bridge that will be automatically created.
Returns
A pointer to the new TapBridge NetDevice.

Definition at line 53 of file tap-bridge-helper.cc.

References Install(), NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().


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