--- a/src/helper/bridge-helper.h Fri Jul 03 09:08:01 2009 +0200
+++ b/src/helper/bridge-helper.h Fri Jul 03 14:12:28 2009 +0100
@@ -1,3 +1,23 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/*
+ * Copyright (c) 2008 INRIA
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation;
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ *
+ * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
+ * Author: Gustavo Carneiro <gjc@inescporto.pt>
+ */
#ifndef BRIDGE_HELPER_H
#define BRIDGE_HELPER_H
@@ -10,12 +30,42 @@
class Node;
class AttributeValue;
+/**
+ * \brief Add capability to bridge multiple LAN segments (IEEE 802.1D bridging)
+ */
class BridgeHelper
{
public:
BridgeHelper ();
+ /**
+ * \param n1 the name of the attribute to set
+ * \param v1 the value of the attribute to set
+ *
+ * Set an attribute on each ns3::BridgeNetDevice created by
+ * BridgeHelper::Install
+ */
void SetDeviceAttribute (std::string n1, const AttributeValue &v1);
+ /**
+ * This method creates an ns3::BridgeNetDevice with the attributes
+ * configured by BridgeHelper::SetDeviceAttribute, adds the device
+ * to the node, and attaches the given NetDevices as ports of the
+ * bridge.
+ *
+ * \param node The node to install the device in
+ * \param c Container of NetDevices to add as bridge ports
+ * \returns A containter holding the added net device.
+ */
NetDeviceContainer Install (Ptr<Node> node, NetDeviceContainer c);
+ /**
+ * This method creates an ns3::BridgeNetDevice with the attributes
+ * configured by BridgeHelper::SetDeviceAttribute, adds the device
+ * to the node, and attaches the given NetDevices as ports of the
+ * bridge.
+ *
+ * \param nodeName The name of the node to install the device in
+ * \param c Container of NetDevices to add as bridge ports
+ * \returns A containter holding the added net device.
+ */
NetDeviceContainer Install (std::string nodeName, NetDeviceContainer c);
private:
ObjectFactory m_deviceFactory;