A Discrete-Event Network Simulator
API
simple-net-device.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #ifndef SIMPLE_NET_DEVICE_H
21 #define SIMPLE_NET_DEVICE_H
22 
23 #include <stdint.h>
24 #include <string>
25 
26 #include "ns3/traced-callback.h"
27 #include "ns3/net-device.h"
28 #include "ns3/data-rate.h"
29 #include "ns3/event-id.h"
30 
31 #include "mac48-address.h"
32 
33 namespace ns3 {
34 
35 template <typename Item> class Queue;
36 class SimpleChannel;
37 class Node;
38 class ErrorModel;
39 
54 class SimpleNetDevice : public NetDevice
55 {
56 public:
61  static TypeId GetTypeId (void);
62  SimpleNetDevice ();
63 
74  void Receive (Ptr<Packet> packet, uint16_t protocol, Mac48Address to, Mac48Address from);
75 
84 
90  void SetQueue (Ptr<Queue<Packet> > queue);
91 
97  Ptr<Queue<Packet> > GetQueue (void) const;
98 
109 
110  // inherited from NetDevice base class.
111  virtual void SetIfIndex (const uint32_t index);
112  virtual uint32_t GetIfIndex (void) const;
113  virtual Ptr<Channel> GetChannel (void) const;
114  virtual void SetAddress (Address address);
115  virtual Address GetAddress (void) const;
116  virtual bool SetMtu (const uint16_t mtu);
117  virtual uint16_t GetMtu (void) const;
118  virtual bool IsLinkUp (void) const;
119  virtual void AddLinkChangeCallback (Callback<void> callback);
120  virtual bool IsBroadcast (void) const;
121  virtual Address GetBroadcast (void) const;
122  virtual bool IsMulticast (void) const;
123  virtual Address GetMulticast (Ipv4Address multicastGroup) const;
124  virtual bool IsPointToPoint (void) const;
125  virtual bool IsBridge (void) const;
126  virtual bool Send (Ptr<Packet> packet, const Address& dest, uint16_t protocolNumber);
127  virtual bool SendFrom (Ptr<Packet> packet, const Address& source, const Address& dest, uint16_t protocolNumber);
128  virtual Ptr<Node> GetNode (void) const;
129  virtual void SetNode (Ptr<Node> node);
130  virtual bool NeedsArp (void) const;
132 
133  virtual Address GetMulticast (Ipv6Address addr) const;
134 
136  virtual bool SupportsSendFrom (void) const;
137 
138 protected:
139  virtual void DoDispose (void);
140 
141 private:
146  uint16_t m_mtu;
147  uint32_t m_ifIndex;
150 
160 
165  void TransmitComplete (void);
166 
167  bool m_linkUp;
168 
174 
178 
183 };
184 
185 } // namespace ns3
186 
187 #endif /* SIMPLE_NET_DEVICE_H */
virtual bool Send(Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)
EventId TransmitCompleteEvent
the Tx Complete event
Ptr< Node > m_node
Node this netDevice is associated to.
TracedCallback m_linkChangeCallbacks
List of callbacks to fire if the link changes state (up or down).
Forward calls to a chain of Callback.
void Receive(Ptr< Packet > packet, uint16_t protocol, Mac48Address to, Mac48Address from)
Receive a packet from a connected SimpleChannel.
virtual void SetIfIndex(const uint32_t index)
virtual bool IsLinkUp(void) const
bool m_pointToPointMode
Flag indicating whether or not the NetDevice is a Point to Point model.
a polymophic address class
Definition: address.h:90
bool m_linkUp
Flag indicating whether or not the link is up.
channel
Definition: third.py:92
Class for representing data rates.
Definition: data-rate.h:88
virtual void SetNode(Ptr< Node > node)
virtual bool IsMulticast(void) const
virtual bool SupportsSendFrom(void) const
virtual void SetPromiscReceiveCallback(PromiscReceiveCallback cb)
virtual bool SetMtu(const uint16_t mtu)
virtual bool NeedsArp(void) const
This device assumes 48-bit mac addressing; there is also the possibility to add an ErrorModel if you ...
Mac48Address m_address
MAC address.
virtual bool IsBridge(void) const
Return true if the net device is acting as a bridge.
virtual Address GetAddress(void) const
virtual Address GetMulticast(Ipv4Address multicastGroup) const
Make and return a MAC multicast address using the provided multicast group.
Ptr< Queue< Packet > > m_queue
The Queue for outgoing packets.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
address
Definition: first.py:37
virtual void SetReceiveCallback(NetDevice::ReceiveCallback cb)
an EUI-48 address
Definition: mac48-address.h:43
void SetReceiveErrorModel(Ptr< ErrorModel > em)
Attach a receive ErrorModel to the SimpleNetDevice.
NetDevice::PromiscReceiveCallback m_promiscCallback
Promiscuous receive callback.
virtual Ptr< Node > GetNode(void) const
Describes an IPv6 address.
Definition: ipv6-address.h:49
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:40
TracedCallback< Ptr< const Packet > > m_phyRxDropTrace
The trace source fired when the phy layer drops a packet it has received due to the error model being...
An identifier for simulation events.
Definition: event-id.h:53
Network layer to device interface.
Definition: net-device.h:95
virtual void AddLinkChangeCallback(Callback< void > callback)
void SetQueue(Ptr< Queue< Packet > > queue)
Attach a queue to the SimpleNetDevice.
virtual void SetAddress(Address address)
Set the address of this interface.
Ptr< ErrorModel > m_receiveErrorModel
Receive error model.
virtual void DoDispose(void)
Destructor implementation.
virtual bool SendFrom(Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)
virtual uint16_t GetMtu(void) const
NetDevice::ReceiveCallback m_rxCallback
Receive callback.
virtual Address GetBroadcast(void) const
Ptr< SimpleChannel > m_channel
the channel the device is connected to
virtual uint32_t GetIfIndex(void) const
void TransmitComplete(void)
The TransmitComplete method is used internally to finish the process of sending a packet out on the c...
virtual Ptr< Channel > GetChannel(void) const
void SetChannel(Ptr< SimpleChannel > channel)
Attach a channel to this net device.
Ptr< Queue< Packet > > GetQueue(void) const
Get a copy of the attached Queue.
DataRate m_bps
The device nominal Data rate.
virtual bool IsBroadcast(void) const
a unique identifier for an interface.
Definition: type-id.h:58
static TypeId GetTypeId(void)
Get the type ID.
virtual bool IsPointToPoint(void) const
Return true if the net device is on a point-to-point link.
uint32_t m_ifIndex
Interface index.