A Discrete-Event Network Simulator
API
aloha-noack-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) 2010
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: Nicola Baldo <nbaldo@cttc.es>
19 */
20
21#ifndef ALOHA_NOACK_NET_DEVICE_H
22#define ALOHA_NOACK_NET_DEVICE_H
23
24#include <cstring>
25#include <ns3/node.h>
26#include <ns3/address.h>
27#include <ns3/net-device.h>
28#include <ns3/callback.h>
29#include <ns3/packet.h>
30#include <ns3/traced-callback.h>
31#include <ns3/nstime.h>
32#include <ns3/ptr.h>
33#include <ns3/mac48-address.h>
34#include <ns3/generic-phy.h>
35#include "ns3/queue-fwd.h"
36
37namespace ns3 {
38
39
40class SpectrumChannel;
41class Channel;
42class SpectrumErrorModel;
43
44
45
60{
61public:
65 enum State
66 {
69 RX
70 };
71
76 static TypeId GetTypeId (void);
77
79 virtual ~AlohaNoackNetDevice ();
80
81
87 virtual void SetQueue (Ptr<Queue<Packet> > queue);
88
89
95
100 void NotifyReceptionStart ();
101
102
108
115
116
126 void SetChannel (Ptr<Channel> c);
127
128
135
136
137
149 void SetPhy (Ptr<Object> phy);
150
154 Ptr<Object> GetPhy () const;
155
156
157
158 // inherited from NetDevice
159 virtual void SetIfIndex (const uint32_t index);
160 virtual uint32_t GetIfIndex (void) const;
161 virtual Ptr<Channel> GetChannel (void) const;
162 virtual bool SetMtu (const uint16_t mtu);
163 virtual uint16_t GetMtu (void) const;
164 virtual void SetAddress (Address address);
165 virtual Address GetAddress (void) const;
166 virtual bool IsLinkUp (void) const;
167 virtual void AddLinkChangeCallback (Callback<void> callback);
168 virtual bool IsBroadcast (void) const;
169 virtual Address GetBroadcast (void) const;
170 virtual bool IsMulticast (void) const;
171 virtual bool IsPointToPoint (void) const;
172 virtual bool IsBridge (void) const;
173 virtual bool Send (Ptr<Packet> packet, const Address& dest,
174 uint16_t protocolNumber);
175 virtual bool SendFrom (Ptr<Packet> packet, const Address& source, const Address& dest,
176 uint16_t protocolNumber);
177 virtual Ptr<Node> GetNode (void) const;
178 virtual void SetNode (Ptr<Node> node);
179 virtual bool NeedsArp (void) const;
181 virtual Address GetMulticast (Ipv4Address addr) const;
182 virtual Address GetMulticast (Ipv6Address addr) const;
184 virtual bool SupportsSendFrom (void) const;
185
186private:
191 virtual void DoDispose (void);
192
196 void StartTransmission ();
197
198
200
205
208
210
213
215
220
221
223 mutable uint32_t m_mtu;
224 bool m_linkUp;
225
229};
230
231
232} // namespace ns3
233
234#endif /* ALOHA_NOACK_NET_DEVICE_H */
a polymophic address class
Definition: address.h:91
This devices implements the following features:
TracedCallback m_linkChangeCallbacks
List of callbacks to fire if the link changes state (up or down).
void NotifyReceptionEndError()
Notify the MAC that the PHY finished a reception with an error.
TracedCallback< Ptr< const Packet > > m_macRxTrace
Rx trace.
Ptr< Queue< Packet > > m_queue
packet queue
virtual void SetQueue(Ptr< Queue< Packet > > queue)
set the queue which is going to be used by this device
Mac48Address m_address
MAC address.
bool m_linkUp
true if the link is up
NetDevice::ReceiveCallback m_rxCallback
Rx callback.
virtual uint32_t GetIfIndex(void) const
void StartTransmission()
start the transmission of a packet by contacting the PHY layer
NetDevice::PromiscReceiveCallback m_promiscRxCallback
Promiscuous Rx callback.
void NotifyReceptionStart()
Notify the MAC that the PHY has started a reception.
virtual void SetAddress(Address address)
Set the address of this interface.
Ptr< Object > m_phy
PHY object.
virtual void DoDispose(void)
Destructor implementation.
virtual bool IsPointToPoint(void) const
Return true if the net device is on a point-to-point link.
virtual void SetNode(Ptr< Node > node)
Ptr< Packet > m_currentPkt
Current packet.
Ptr< Channel > m_channel
Channel.
TracedCallback< Ptr< const Packet > > m_macPromiscRxTrace
Promiscuous Rx trace.
void NotifyGuardIntervalEnd()
Notification of Guard Interval end.
Ptr< Node > m_node
Node owning this NetDevice.
void SetGenericPhyTxStartCallback(GenericPhyTxStartCallback c)
set the callback used to instruct the lower layer to start a TX
virtual uint16_t GetMtu(void) const
virtual void SetPromiscReceiveCallback(PromiscReceiveCallback cb)
GenericPhyTxStartCallback m_phyMacTxStartCallback
Tx Start callback.
static TypeId GetTypeId(void)
Get the type ID.
virtual bool IsBroadcast(void) const
virtual bool IsBridge(void) const
Return true if the net device is acting as a bridge.
void NotifyTransmissionEnd(Ptr< const Packet >)
Notify the MAC that the PHY has finished a previously started transmission.
void SetChannel(Ptr< Channel > c)
This class doesn't talk directly with the underlying channel (a dedicated PHY class is expected to do...
virtual Address GetAddress(void) const
State m_state
State of the NetDevice.
virtual Address GetMulticast(Ipv4Address addr) const
Make and return a MAC multicast address using the provided multicast group.
virtual bool Send(Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)
virtual void SetIfIndex(const uint32_t index)
virtual Ptr< Channel > GetChannel(void) const
virtual Address GetBroadcast(void) const
virtual bool SupportsSendFrom(void) const
virtual bool NeedsArp(void) const
uint32_t m_ifIndex
Interface index.
uint32_t m_mtu
NetDevice MTU.
void SetPhy(Ptr< Object > phy)
Set the Phy object which is attached to this device.
TracedCallback< Ptr< const Packet > > m_macTxTrace
Tx trace.
virtual Ptr< Node > GetNode(void) const
void NotifyReceptionEndOk(Ptr< Packet > p)
Notify the MAC that the PHY finished a reception successfully.
virtual bool SendFrom(Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)
TracedCallback< Ptr< const Packet > > m_macTxDropTrace
Tx Drop trace.
State
State of the NetDevice.
virtual bool IsLinkUp(void) const
virtual bool SetMtu(const uint16_t mtu)
virtual void SetReceiveCallback(NetDevice::ReceiveCallback cb)
virtual bool IsMulticast(void) const
virtual void AddLinkChangeCallback(Callback< void > callback)
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
Describes an IPv6 address.
Definition: ipv6-address.h:50
an EUI-48 address
Definition: mac48-address.h:44
Network layer to device interface.
Definition: net-device.h:96
Callback< bool, Ptr< NetDevice >, Ptr< const Packet >, uint16_t, const Address &, const Address &, enum PacketType > PromiscReceiveCallback
Definition: net-device.h:343
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:74
Forward calls to a chain of Callback.
a unique identifier for an interface.
Definition: type-id.h:59
address
Definition: first.py:40
Every class exported by the ns3 library is enclosed in the ns3 namespace.
phy
Definition: third.py:84