A Discrete-Event Network Simulator
API
uan-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) 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
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: Leonard Tracy <lentracy@gmail.com>
19  */
20 
21 #ifndef UAN_NET_DEVICE_H
22 #define UAN_NET_DEVICE_H
23 
24 #include "ns3/net-device.h"
25 #include "ns3/pointer.h"
26 #include "ns3/traced-callback.h"
27 #include "ns3/mac8-address.h"
28 #include <list>
29 
30 namespace ns3 {
31 
32 class UanChannel;
33 class UanPhy;
34 class UanMac;
35 class UanTransducer;
36 
47 class UanNetDevice : public NetDevice
48 {
49 public:
51  typedef std::list<Ptr<UanPhy> > UanPhyList;
53  typedef std::list<Ptr<UanTransducer> > UanTransducerList;
54 
59  static TypeId GetTypeId (void);
60 
62  UanNetDevice ();
64  virtual ~UanNetDevice ();
65 
71  void SetMac (Ptr<UanMac> mac);
72 
78  void SetPhy (Ptr<UanPhy> phy);
79 
86 
92  Ptr<UanMac> GetMac (void) const;
93 
99  Ptr<UanPhy> GetPhy (void) const;
100 
106  Ptr<UanTransducer> GetTransducer (void) const;
112  void SetTransducer (Ptr<UanTransducer> trans);
113 
115  void Clear (void);
116 
122  void SetSleepMode (bool sleep);
123 
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);
149  uint32_t GetTxModeIndex ();
150  void SetTxModeIndex (uint32_t txModeIndex);
151 
158  typedef void (* RxTxTracedCallback)
160 
161 private:
169  virtual void ForwardUp (Ptr<Packet> pkt, uint16_t protocolNumber, const Mac8Address &src);
170 
172  Ptr<UanChannel> DoGetChannel (void) const;
173 
179 
180  //unused: std::string m_name;
181  uint32_t m_ifIndex;
182  uint16_t m_mtu;
183  bool m_linkup;
186 
191 
193  bool m_cleared;
194 
195 protected:
196  virtual void DoDispose (void);
197  virtual void DoInitialize (void);
198 }; // class UanNetDevice
199 
200 } // namespace ns3
201 
202 #endif /* UAN_NET_DEVICE_H */
virtual bool SetMtu(const uint16_t mtu)
virtual Ptr< Node > GetNode(void) const
virtual bool SendFrom(Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)
virtual bool NeedsArp(void) const
void SetSleepMode(bool sleep)
Set the Phy SLEEP mode.
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.
Callback template class.
Definition: callback.h:1176
virtual void SetAddress(Address address)
Set the address of this interface.
bool m_linkup
The link state, true if up.
virtual bool IsMulticast(void) const
Forward calls to a chain of Callback.
void SetChannel(Ptr< UanChannel > channel)
Attach a channel.
void SetTxModeIndex(uint32_t txModeIndex)
std::list< Ptr< UanPhy > > UanPhyList
List of UanPhy objects.
virtual bool Send(Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)
Ptr< Node > m_node
The node hosting this device.
Ptr< UanTransducer > m_trans
The Transducer attached to this device.
TracedCallback< Ptr< const Packet >, Mac8Address > m_txLogger
Trace source triggered when sending to the MAC layer.
Ptr< UanChannel > DoGetChannel(void) const
a polymophic address class
Definition: address.h:90
channel
Definition: third.py:92
ReceiveCallback m_forwardUp
The receive callback.
phy
Definition: third.py:93
virtual bool IsBroadcast(void) const
uint16_t m_mtu
The device MTU value, in bytes.
virtual void AddLinkChangeCallback(Callback< void > callback)
virtual void DoInitialize(void)
Initialize() implementation.
TracedCallback m_linkChanges
Callback to invoke when the link state changes to UP.
Ptr< UanPhy > m_phy
The PHY layer attached to this device.
mac
Definition: third.py:99
virtual Ptr< Channel > GetChannel(void) const
virtual uint32_t GetIfIndex(void) const
A class used for addressing MAC8 MAC&#39;s.
Definition: mac8-address.h:42
virtual Address GetBroadcast(void) const
virtual bool IsBridge(void) const
Return true if the net device is acting as a bridge.
virtual void DoDispose(void)
Destructor implementation.
UanNetDevice()
Default constructor.
virtual bool IsLinkUp(void) const
void(* RxTxTracedCallback)(Ptr< const Packet > packet, Mac8Address address)
TracedCallback signature for MAC send/receive events.
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.
virtual uint16_t GetMtu(void) const
virtual void ForwardUp(Ptr< Packet > pkt, uint16_t protocolNumber, const Mac8Address &src)
Forward the packet to a higher level, set with SetReceiveCallback.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
address
Definition: first.py:37
virtual bool SupportsSendFrom(void) const
virtual Address GetMulticast(Ipv4Address multicastGroup) const
Make and return a MAC multicast address using the provided multicast group.
Ptr< UanMac > GetMac(void) const
Get the MAC used by this device.
Net device for UAN models.
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:49
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
uint32_t GetTxModeIndex()
bool m_cleared
Flag when we&#39;ve been cleared.
virtual Address GetAddress(void) const
Network layer to device interface.
Definition: net-device.h:95
TracedCallback< Ptr< const Packet >, Mac8Address > m_rxLogger
Trace source triggered when forwarding up received payload from the MAC layer.
Ptr< UanTransducer > GetTransducer(void) const
Get the transducer associated with this device.
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.
Ptr< UanPhy > GetPhy(void) const
Get the Phy used by this device.
uint32_t m_ifIndex
The interface index of this device.
virtual bool IsPointToPoint(void) const
Return true if the net device is on a point-to-point link.
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)