A Discrete-Event Network Simulator
API
bridge-net-device.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * This program is free software; you can redistribute it and/or modify
4  * it under the terms of the GNU General Public License version 2 as
5  * published by the Free Software Foundation;
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software
14  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15  *
16  * Author: Gustavo Carneiro <gjc@inescporto.pt>
17  */
18 #ifndef BRIDGE_NET_DEVICE_H
19 #define BRIDGE_NET_DEVICE_H
20 
21 #include "ns3/net-device.h"
22 #include "ns3/mac48-address.h"
23 #include "ns3/nstime.h"
24 #include "ns3/bridge-channel.h"
25 #include <stdint.h>
26 #include <string>
27 #include <map>
28 
29 namespace ns3 {
30 
31 class Node;
32 
65 class BridgeNetDevice : public NetDevice
66 {
67 public:
72  static TypeId GetTypeId (void);
73  BridgeNetDevice ();
74  virtual ~BridgeNetDevice ();
75 
90  void AddBridgePort (Ptr<NetDevice> bridgePort);
91 
97  uint32_t GetNBridgePorts (void) const;
98 
104  Ptr<NetDevice> GetBridgePort (uint32_t n) const;
105 
106  // inherited from NetDevice base class.
107  virtual void SetIfIndex (const uint32_t index);
108  virtual uint32_t GetIfIndex (void) const;
109  virtual Ptr<Channel> GetChannel (void) const;
110  virtual void SetAddress (Address address);
111  virtual Address GetAddress (void) const;
112  virtual bool SetMtu (const uint16_t mtu);
113  virtual uint16_t GetMtu (void) const;
114  virtual bool IsLinkUp (void) const;
115  virtual void AddLinkChangeCallback (Callback<void> callback);
116  virtual bool IsBroadcast (void) const;
117  virtual Address GetBroadcast (void) const;
118  virtual bool IsMulticast (void) const;
119  virtual Address GetMulticast (Ipv4Address multicastGroup) const;
120  virtual bool IsPointToPoint (void) const;
121  virtual bool IsBridge (void) const;
122  virtual bool Send (Ptr<Packet> packet, const Address& dest, uint16_t protocolNumber);
123  virtual bool SendFrom (Ptr<Packet> packet, const Address& source, const Address& dest, uint16_t protocolNumber);
124  virtual Ptr<Node> GetNode (void) const;
125  virtual void SetNode (Ptr<Node> node);
126  virtual bool NeedsArp (void) const;
129  virtual bool SupportsSendFrom () const;
130  virtual Address GetMulticast (Ipv6Address addr) const;
131 
132 protected:
133  virtual void DoDispose (void);
134 
144  void ReceiveFromDevice (Ptr<NetDevice> device, Ptr<const Packet> packet, uint16_t protocol,
145  Address const &source, Address const &destination, PacketType packetType);
146 
155  void ForwardUnicast (Ptr<NetDevice> incomingPort, Ptr<const Packet> packet,
156  uint16_t protocol, Mac48Address src, Mac48Address dst);
157 
166  void ForwardBroadcast (Ptr<NetDevice> incomingPort, Ptr<const Packet> packet,
167  uint16_t protocol, Mac48Address src, Mac48Address dst);
168 
174  void Learn (Mac48Address source, Ptr<NetDevice> port);
175 
182 
183 private:
190 
198 
201 
204 
210  {
213  };
214  std::map<Mac48Address, LearnedState> m_learnState;
217  std::vector< Ptr<NetDevice> > m_ports;
218  uint32_t m_ifIndex;
219  uint16_t m_mtu;
221 };
222 
223 } // namespace ns3
224 
225 #endif /* BRIDGE_NET_DEVICE_H */
void AddBridgePort(Ptr< NetDevice > bridgePort)
Add a &#39;port&#39; to a bridge device.
virtual bool Send(Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
void Learn(Mac48Address source, Ptr< NetDevice > port)
Learns the port a MAC address is sending from.
virtual bool IsPointToPoint(void) const
Return true if the net device is on a point-to-point link.
Ptr< NetDevice > GetLearnedState(Mac48Address source)
Gets the port associated to a source address.
void ForwardBroadcast(Ptr< NetDevice > incomingPort, Ptr< const Packet > packet, uint16_t protocol, Mac48Address src, Mac48Address dst)
Forwards a broadcast or a multicast packet.
virtual bool IsMulticast(void) const
virtual void SetReceiveCallback(NetDevice::ReceiveCallback cb)
virtual void SetIfIndex(const uint32_t index)
Time expirationTime
time it takes for learned MAC state to expire
virtual bool IsLinkUp(void) const
virtual Ptr< Node > GetNode(void) const
static TypeId GetTypeId(void)
Get the type ID.
virtual bool NeedsArp(void) const
virtual void SetAddress(Address address)
Set the address of this interface.
a virtual net device that bridges multiple LAN segments
virtual bool SendFrom(Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)
virtual Address GetAddress(void) const
uint32_t GetNBridgePorts(void) const
Gets the number of bridged &#39;ports&#39;, i.e., the NetDevices currently bridged.
NetDevice::PromiscReceiveCallback m_promiscRxCallback
promiscuous receive callback
virtual bool IsBridge(void) const
Return true if the net device is acting as a bridge.
virtual void AddLinkChangeCallback(Callback< void > callback)
uint16_t port
Definition: dsdv-manet.cc:45
a polymophic address class
Definition: address.h:90
Ptr< NetDevice > associatedPort
port associated with the address
std::vector< Ptr< NetDevice > > m_ports
bridged ports
virtual bool SetMtu(const uint16_t mtu)
uint32_t m_ifIndex
Interface index.
Ptr< NetDevice > GetBridgePort(uint32_t n) const
Gets the n-th bridged port.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual void SetPromiscReceiveCallback(NetDevice::PromiscReceiveCallback cb)
address
Definition: first.py:37
NetDevice::ReceiveCallback m_rxCallback
receive callback
Mac48Address m_address
MAC address of the NetDevice.
virtual bool IsBroadcast(void) const
an EUI-48 address
Definition: mac48-address.h:43
virtual uint32_t GetIfIndex(void) const
virtual void DoDispose(void)
Destructor implementation.
Ptr< Node > m_node
node owning this NetDevice
virtual Address GetBroadcast(void) const
std::map< Mac48Address, LearnedState > m_learnState
Container for known address statuses.
Structure holding the status of an address.
Describes an IPv6 address.
Definition: ipv6-address.h:49
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:40
virtual Address GetMulticast(Ipv4Address multicastGroup) const
Make and return a MAC multicast address using the provided multicast group.
uint16_t m_mtu
MTU of the bridged NetDevice.
void ForwardUnicast(Ptr< NetDevice > incomingPort, Ptr< const Packet > packet, uint16_t protocol, Mac48Address src, Mac48Address dst)
Forwards a unicast packet.
Network layer to device interface.
Definition: net-device.h:95
bool m_enableLearning
true if the bridge will learn the node status
BridgeNetDevice & operator=(const BridgeNetDevice &)
Copy constructor.
Ptr< BridgeChannel > m_channel
virtual bridged channel
Time m_expirationTime
time it takes for learned MAC state to expire
virtual uint16_t GetMtu(void) const
virtual bool SupportsSendFrom() const
PacketType
Packet types are used as they are in Linux.
Definition: net-device.h:296
virtual void SetNode(Ptr< Node > node)
a unique identifier for an interface.
Definition: type-id.h:58
virtual Ptr< Channel > GetChannel(void) const
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.