--- a/src/tap-bridge/model/tap-bridge.h Fri Oct 31 13:36:46 2014 -0700
+++ b/src/tap-bridge/model/tap-bridge.h Mon Nov 03 12:33:13 2014 -0800
@@ -210,8 +210,6 @@
protected:
/**
- * \internal
- *
* Call out to a separate process running as suid root in order to get our
* tap device created. We do this to avoid having the entire simulation
* running as root. If this method returns, we'll have a socket waiting
@@ -227,8 +225,6 @@
private:
/**
- * \internal
- *
* Call out to a separate process running as suid root in order to get our
* tap device created. We do this to avoid having the entire simulation
* running as root. If this method returns, we'll have a socket waiting
@@ -237,29 +233,21 @@
void CreateTap (void);
/**
- * \internal
- *
* Spin up the device
*/
void StartTapDevice (void);
/**
- * \internal
- *
* Tear down the device
*/
void StopTapDevice (void);
/**
- * \internal
- *
* Callback to process packets that are read
*/
void ReadCallback (uint8_t *buf, ssize_t len);
/*
- * \internal
- *
* Forward a packet received from the tap device to the bridged ns-3
* device
*
@@ -270,8 +258,6 @@
void ForwardToBridgedDevice (uint8_t *buf, ssize_t len);
/**
- * \internal
- *
* The host we are bridged to is in the evil real world. Do some sanity
* checking on a received packet to make sure it isn't too evil for our
* poor naive virginal simulator to handle.
@@ -294,8 +280,6 @@
void NotifyLinkUp (void);
/**
- * \internal
- *
* Callback used to hook the standard packet receive callback of the TapBridge
* ns-3 net device. This is never called, and therefore no packets will ever
* be received forwarded up the IP stack on the ghost node through this device.
@@ -303,8 +287,6 @@
NetDevice::ReceiveCallback m_rxCallback;
/**
- * \internal
- *
* Callback used to hook the promiscuous packet receive callback of the TapBridge
* ns-3 net device. This is never called, and therefore no packets will ever
* be received forwarded up the IP stack on the ghost node through this device.
@@ -316,70 +298,52 @@
NetDevice::PromiscReceiveCallback m_promiscRxCallback;
/**
- * \internal
- *
* Pointer to the (ghost) Node to which we are connected.
*/
Ptr<Node> m_node;
/**
- * \internal
- *
* The ns-3 interface index of this TapBridge net device.
*/
uint32_t m_ifIndex;
/**
- * \internal
- *
* The common mtu to use for the net devices
*/
uint16_t m_mtu;
/**
- * \internal
- *
* The socket (actually interpreted as fd) to use to talk to the Tap device on
* the real internet host.
*/
int m_sock;
/**
- * \internal
- *
* The ID of the ns-3 event used to schedule the start up of the underlying
* host Tap device and ns-3 read thread.
*/
EventId m_startEvent;
/**
- * \internal
- *
* The ID of the ns-3 event used to schedule the tear down of the underlying
* host Tap device and ns-3 read thread.
*/
EventId m_stopEvent;
/**
- * \internal
- *
* Includes the ns-3 read thread used to do blocking reads on the fd
* corresponding to the host device.
*/
Ptr<TapBridgeFdReader> m_fdReader;
/**
- * \internal
- *
* The operating mode of the bridge. Tells basically who creates and
* configures the underlying network tap.
*/
Mode m_mode;
/**
- * \internal
- *
* The (unused) MAC address of the TapBridge net device. Since the TapBridge
* is implemented as a ns-3 net device, it is required to implement certain
* functionality. In this case, the TapBridge is automatically assigned a
@@ -388,43 +352,31 @@
Mac48Address m_address;
/**
- * \internal
- *
* Time to start spinning up the device
*/
Time m_tStart;
/**
- * \internal
- *
* Time to start tearing down the device
*/
Time m_tStop;
/**
- * \internal
- *
* The name of the device to create on the host. If the device name is the
* empty string, we allow the host kernel to choose a name.
*/
std::string m_tapDeviceName;
/**
- * \internal
- *
* The IP address to use as the device default gateway on the host.
*/
Ipv4Address m_tapGateway;
/**
- * \internal
- *
* The IP address to use as the device IP on the host.
*/
Ipv4Address m_tapIp;
/**
- * \internal
- *
* The MAC address to use as the hardware address on the host; only used
* in UseLocal mode. This value comes from the MAC
* address assigned to the bridged ns-3 net device and matches the MAC
@@ -434,21 +386,15 @@
Mac48Address m_tapMac;
/**
- * \internal
- *
* The network mask to assign to the device created on the host.
*/
Ipv4Mask m_tapNetmask;
/**
- * \internal
- *
* The ns-3 net device to which we are bridging.
*/
Ptr<NetDevice> m_bridgedDevice;
/**
- * \internal
- *
* Whether the MAC address of the underlying ns-3 device has already been
* rewritten is stored in this variable (for UseLocal/UseBridge mode only).
*/
@@ -467,8 +413,6 @@
uint32_t m_nodeId;
/**
- * \internal
- *
* Flag indicating whether or not the link is up. In this case,
* whether or not ns-3 is connected to the underlying TAP device
* with a file descriptor.
@@ -476,8 +420,6 @@
bool m_linkUp;
/**
- * \internal
- *
* Callbacks to fire if the link changes state (up or down).
*/
TracedCallback<> m_linkChangeCallbacks;