A Discrete-Event Network Simulator
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 University of Washington
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
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: Leonard Tracy <lentracy@gmail.com>
19  */
21 #ifndef UAN_NET_DEVICE_H
22 #define UAN_NET_DEVICE_H
24 #include "ns3/net-device.h"
25 #include "ns3/pointer.h"
26 #include "ns3/traced-callback.h"
27 #include "uan-address.h"
28 #include <list>
30 namespace ns3 {
32 class UanChannel;
33 class UanPhy;
34 class UanMac;
35 class UanTransducer;
47 class UanNetDevice : public NetDevice
48 {
49 public:
51  typedef std::list<Ptr<UanPhy> > UanPhyList;
53  typedef std::list<Ptr<UanTransducer> > UanTransducerList;
59  static TypeId GetTypeId (void);
62  UanNetDevice ();
64  virtual ~UanNetDevice ();
71  void SetMac (Ptr<UanMac> mac);
78  void SetPhy (Ptr<UanPhy> phy);
92  Ptr<UanMac> GetMac (void) const;
99  Ptr<UanPhy> GetPhy (void) const;
106  Ptr<UanTransducer> GetTransducer (void) const;
112  void SetTransducer (Ptr<UanTransducer> trans);
115  void Clear (void);
122  void SetSleepMode (bool sleep);
124  // Inherited methods
125  virtual void SetIfIndex (const uint32_t index);
126  virtual uint32_t GetIfIndex (void) const;
127  virtual Ptr<Channel> GetChannel (void) const;
128  virtual Address GetAddress (void) const;
129  virtual bool SetMtu (const uint16_t mtu);
130  virtual uint16_t GetMtu (void) const;
131  virtual bool IsLinkUp (void) const;
132  virtual bool IsBroadcast (void) const;
133  virtual Address GetBroadcast (void) const;
134  virtual bool IsMulticast (void) const;
135  virtual Address GetMulticast (Ipv4Address multicastGroup) const;
136  virtual Address GetMulticast (Ipv6Address addr) const;
137  virtual bool IsBridge (void) const;
138  virtual bool IsPointToPoint (void) const;
139  virtual bool Send (Ptr<Packet> packet, const Address& dest, uint16_t protocolNumber);
140  virtual bool SendFrom (Ptr<Packet> packet, const Address& source, const Address& dest, uint16_t protocolNumber);
141  virtual Ptr<Node> GetNode (void) const;
142  virtual void SetNode (Ptr<Node> node);
143  virtual bool NeedsArp (void) const;
146  virtual bool SupportsSendFrom (void) const;
147  virtual void AddLinkChangeCallback (Callback<void> callback);
148  virtual void SetAddress (Address address);
156  typedef void (* RxTxTracedCallback)
159 private:
166  virtual void ForwardUp (Ptr<Packet> pkt, const UanAddress &src);
169  Ptr<UanChannel> DoGetChannel (void) const;
177  //unused: std::string m_name;
178  uint32_t m_ifIndex;
179  uint16_t m_mtu;
180  bool m_linkup;
190  bool m_cleared;
192 protected:
193  virtual void DoDispose ();
195 }; // class UanNetDevice
197 } // namespace ns3
199 #endif /* UAN_NET_DEVICE_H */
tuple channel
Definition: third.py:85
virtual bool SetMtu(const uint16_t mtu)
virtual bool SendFrom(Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)
void SetSleepMode(bool sleep)
Set the Phy SLEEP mode.
Ptr< UanMac > GetMac(void) const
Get the MAC used by this device.
virtual void SetReceiveCallback(NetDevice::ReceiveCallback cb)
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
void SetMac(Ptr< UanMac > mac)
Set the MAC layer for this device.
virtual void SetAddress(Address address)
Set the address of this interface.
bool m_linkup
The link state, true if up.
Forward calls to a chain of Callback.
virtual void DoDispose()
Destructor implementation.
void SetChannel(Ptr< UanChannel > channel)
Attach a channel.
virtual Address GetMulticast(Ipv4Address multicastGroup) const
Make and return a MAC multicast address using the provided multicast group.
std::list< Ptr< UanPhy > > UanPhyList
List of UanPhy objects.
virtual bool IsPointToPoint(void) const
Return true if the net device is on a point-to-point link.
virtual bool IsMulticast(void) const
virtual bool IsLinkUp(void) const
virtual bool Send(Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)
virtual uint16_t GetMtu(void) const
virtual Ptr< Channel > GetChannel(void) const
Ptr< Node > m_node
The node hosting this device.
Ptr< UanTransducer > m_trans
The Transducer attached to this device.
virtual Address GetBroadcast(void) const
a polymophic address class
Definition: address.h:90
Ptr< UanTransducer > GetTransducer(void) const
Get the transducer associated with this device.
ReceiveCallback m_forwardUp
The receive callback.
uint16_t m_mtu
The device MTU value, in bytes.
virtual void AddLinkChangeCallback(Callback< void > callback)
tuple phy
Definition: third.py:86
virtual uint32_t GetIfIndex(void) const
A class used for addressing UAN MAC's.
Definition: uan-address.h:40
virtual void ForwardUp(Ptr< Packet > pkt, const UanAddress &src)
Forward the packet to a higher level, set with SetReceiveCallback.
TracedCallback m_linkChanges
Callback to invoke when the link state changes to UP.
Ptr< UanPhy > m_phy
The PHY layer attached to this device.
virtual Ptr< Node > GetNode(void) const
TracedCallback< Ptr< const Packet >, UanAddress > m_rxLogger
Trace source triggered when forwarding up received payload from the MAC layer.
Default constructor.
tuple mac
Definition: third.py:92
virtual bool IsBroadcast(void) const
std::list< Ptr< UanTransducer > > UanTransducerList
List of UanTransducer objects.
Ptr< UanMac > m_mac
The MAC layer attached to this device.
static TypeId GetTypeId(void)
Register this type.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual bool SupportsSendFrom(void) const
void(* RxTxTracedCallback)(Ptr< const Packet > packet, UanAddress address)
TracedCallback signature for MAC send/receive events.
TracedCallback< Ptr< const Packet >, UanAddress > m_txLogger
Trace source triggered when sending to the MAC layer.
Net device for UAN models.
Ptr< UanPhy > GetPhy(void) const
Get the Phy used by this device.
virtual Address GetAddress(void) const
virtual void SetPromiscReceiveCallback(PromiscReceiveCallback cb)
void SetPhy(Ptr< UanPhy > phy)
Set the Phy layer for this device.
Describes an IPv6 address.
Definition: ipv6-address.h:48
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:40
bool m_cleared
Flag when we've been cleared.
Network layer to device interface.
Definition: net-device.h:405
virtual bool IsBridge(void) const
Return true if the net device is acting as a bridge.
Ptr< UanChannel > m_channel
The channel attached to this device.
virtual void SetNode(Ptr< Node > node)
void SetTransducer(Ptr< UanTransducer > trans)
Set the transdcuer used by this device.
virtual ~UanNetDevice()
Dummy destructor, DoDispose.
virtual bool NeedsArp(void) const
Ptr< UanChannel > DoGetChannel(void) const
tuple address
Definition: first.py:37
uint32_t m_ifIndex
The interface index of this device.
a unique identifier for an interface.
Definition: type-id.h:58
void Clear(void)
Clear all pointer references.
virtual void SetIfIndex(const uint32_t index)