A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
csma-net-device.h
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007 Emmanuelle Laprise
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: Emmanuelle Laprise <emmanuelle.laprise@bluekazoo.ca
19  */
20 
21 #ifndef CSMA_NET_DEVICE_H
22 #define CSMA_NET_DEVICE_H
23 
24 #include <cstring>
25 #include "ns3/node.h"
26 #include "ns3/backoff.h"
27 #include "ns3/address.h"
28 #include "ns3/net-device.h"
29 #include "ns3/callback.h"
30 #include "ns3/packet.h"
31 #include "ns3/traced-callback.h"
32 #include "ns3/nstime.h"
33 #include "ns3/data-rate.h"
34 #include "ns3/ptr.h"
35 #include "ns3/mac48-address.h"
36 
37 namespace ns3 {
38 
39 class Queue;
40 class CsmaChannel;
41 class ErrorModel;
42 
58 class CsmaNetDevice : public NetDevice
59 {
60 public:
61  static TypeId GetTypeId (void);
62 
68  DIX,
69  LLC,
70  };
71 
77  CsmaNetDevice ();
78 
84  virtual ~CsmaNetDevice ();
85 
93  void SetInterframeGap (Time t);
94 
106  void SetBackoffParams (Time slotTime, uint32_t minSlots, uint32_t maxSlots,
107  uint32_t maxRetries, uint32_t ceiling);
108 
118  bool Attach (Ptr<CsmaChannel> ch);
119 
131  void SetQueue (Ptr<Queue> queue);
132 
138  Ptr<Queue> GetQueue (void) const;
139 
150 
163  void Receive (Ptr<Packet> p, Ptr<CsmaNetDevice> sender);
164 
170  bool IsSendEnabled (void);
171 
177  void SetSendEnable (bool enable);
178 
184  bool IsReceiveEnabled (void);
185 
191  void SetReceiveEnable (bool enable);
192 
200 
207 
208  //
209  // The following methods are inherited from NetDevice base class.
210  //
211  virtual void SetIfIndex (const uint32_t index);
212  virtual uint32_t GetIfIndex (void) const;
213  virtual Ptr<Channel> GetChannel (void) const;
214  virtual bool SetMtu (const uint16_t mtu);
215  virtual uint16_t GetMtu (void) const;
216  virtual void SetAddress (Address address);
217  virtual Address GetAddress (void) const;
218  virtual bool IsLinkUp (void) const;
219  virtual void AddLinkChangeCallback (Callback<void> callback);
220  virtual bool IsBroadcast (void) const;
221  virtual Address GetBroadcast (void) const;
222  virtual bool IsMulticast (void) const;
223 
246  virtual Address GetMulticast (Ipv4Address multicastGroup) const;
247 
252  virtual bool IsPointToPoint (void) const;
253 
258  virtual bool IsBridge (void) const;
259 
267  virtual bool Send (Ptr<Packet> packet, const Address& dest,
268  uint16_t protocolNumber);
269 
278  virtual bool SendFrom (Ptr<Packet> packet, const Address& source, const Address& dest,
279  uint16_t protocolNumber);
280 
286  virtual Ptr<Node> GetNode (void) const;
287 
293  virtual void SetNode (Ptr<Node> node);
294 
301  virtual bool NeedsArp (void) const;
302 
310 
318  virtual Address GetMulticast (Ipv6Address addr) const;
319 
320 
322  virtual bool SupportsSendFrom (void) const;
323 
332  int64_t AssignStreams (int64_t stream);
333 
334 protected:
339  virtual void DoDispose (void);
340 
351  void AddHeader (Ptr<Packet> p, Mac48Address source, Mac48Address dest, uint16_t protocolNumber);
352 
353 private:
354 
361 
367  CsmaNetDevice (const CsmaNetDevice &o);
368 
374  void Init (bool sendEnable, bool receiveEnable);
375 
393  void TransmitStart ();
394 
411  void TransmitCompleteEvent (void);
412 
427  void TransmitReadyEvent (void);
428 
436  void TransmitAbort (void);
437 
441  void NotifyLinkUp (void);
442 
448  uint32_t m_deviceId;
449 
454 
459 
464  {
467  GAP,
469  };
470 
476 
483 
490 
497 
504 
511 
518 
527 
534 
542 
550 
559 
568 
577 
586 
594 
602 
610 
618 
626 
633 
653 
673 
678 
683 
688 
693 
698  uint32_t m_ifIndex;
699 
704  bool m_linkUp;
705 
710 
711  static const uint16_t DEFAULT_MTU = 1500;
712 
719  uint32_t m_mtu;
720 };
721 
722 } // namespace ns3
723 
724 #endif /* CSMA_NET_DEVICE_H */
TracedCallback< Ptr< const Packet > > m_phyRxBeginTrace
keep track of time unit.
Definition: nstime.h:149
Ptr< Queue > m_queue
TracedCallback< Ptr< const Packet > > m_phyTxBeginTrace
smart pointer class similar to boost::intrusive_ptr
Definition: ptr.h:59
TxMachineState m_txMachineState
void SetReceiveEnable(bool enable)
void SetEncapsulationMode(CsmaNetDevice::EncapsulationMode mode)
CsmaNetDevice::EncapsulationMode GetEncapsulationMode(void)
void TransmitReadyEvent(void)
void AddHeader(Ptr< Packet > p, Mac48Address source, Mac48Address dest, uint16_t protocolNumber)
TracedCallback< Ptr< const Packet > > m_macPromiscRxTrace
TracedCallback< Ptr< const Packet > > m_phyTxEndTrace
void Receive(Ptr< Packet > p, Ptr< CsmaNetDevice > sender)
forward calls to a chain of CallbackAn ns3::TracedCallback has almost exactly the same API as a norma...
TracedCallback< Ptr< const Packet > > m_macRxTrace
TracedCallback< Ptr< const Packet > > m_phyRxEndTrace
Ptr< Packet > m_currentPkt
void SetReceiveErrorModel(Ptr< ErrorModel > em)
virtual bool SendFrom(Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)
TracedCallback< Ptr< const Packet > > m_macRxDropTrace
virtual Address GetBroadcast(void) const
virtual void SetIfIndex(const uint32_t index)
virtual bool NeedsArp(void) const
TracedCallback< Ptr< const Packet > > m_promiscSnifferTrace
a polymophic address class
Definition: address.h:86
The backoff class is used for calculating backoff times when many net devices can write to the same c...
Definition: backoff.h:37
Class for representing data rates.
Definition: data-rate.h:71
TracedCallback m_linkChangeCallbacks
TracedCallback< Ptr< const Packet > > m_macTxBackoffTrace
virtual bool IsLinkUp(void) const
void SetQueue(Ptr< Queue > queue)
TracedCallback< Ptr< const Packet > > m_snifferTrace
void TransmitCompleteEvent(void)
bool IsReceiveEnabled(void)
virtual Ptr< Node > GetNode(void) const
Ptr< Queue > GetQueue(void) const
void SetInterframeGap(Time t)
virtual Address GetAddress(void) const
virtual uint32_t GetIfIndex(void) const
virtual uint16_t GetMtu(void) const
virtual void SetPromiscReceiveCallback(PromiscReceiveCallback cb)
TracedCallback< Ptr< const Packet > > m_phyTxDropTrace
Callback< bool, Ptr< NetDevice >, Ptr< const Packet >, uint16_t, const Address &, const Address &, enum PacketType > PromiscReceiveCallback
Definition: net-device.h:315
A Device for a Csma Network Link.
Ptr< ErrorModel > m_receiveErrorModel
Ptr< CsmaChannel > m_channel
an EUI-48 address
Definition: mac48-address.h:41
virtual Ptr< Channel > GetChannel(void) const
virtual bool IsBridge(void) const
virtual bool SetMtu(const uint16_t mtu)
virtual bool SupportsSendFrom(void) const
CsmaNetDevice & operator=(const CsmaNetDevice &o)
void Init(bool sendEnable, bool receiveEnable)
Mac48Address m_address
Describes an IPv6 address.
Definition: ipv6-address.h:44
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:38
EncapsulationMode m_encapMode
NetDevice::ReceiveCallback m_rxCallback
void SetBackoffParams(Time slotTime, uint32_t minSlots, uint32_t maxSlots, uint32_t maxRetries, uint32_t ceiling)
TracedCallback< Ptr< const Packet > > m_macTxDropTrace
Network layer to device interface.
Definition: net-device.h:75
void SetSendEnable(bool enable)
virtual void SetReceiveCallback(NetDevice::ReceiveCallback cb)
int64_t AssignStreams(int64_t stream)
NetDevice::PromiscReceiveCallback m_promiscRxCallback
virtual void SetAddress(Address address)
virtual void AddLinkChangeCallback(Callback< void > callback)
bool Attach(Ptr< CsmaChannel > ch)
virtual void SetNode(Ptr< Node > node)
TracedCallback< Ptr< const Packet > > m_phyRxDropTrace
virtual bool Send(Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)
virtual bool IsMulticast(void) const
virtual Address GetMulticast(Ipv4Address multicastGroup) const
Make and return a MAC multicast address using the provided multicast group.
virtual void DoDispose(void)
a unique identifier for an interface.
Definition: type-id.h:44
virtual bool IsBroadcast(void) const
virtual bool IsPointToPoint(void) const
TracedCallback< Ptr< const Packet > > m_macTxTrace