A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
point-to-point-net-device.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2007, 2008 University of Washington
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 */
17
18#ifndef POINT_TO_POINT_NET_DEVICE_H
19#define POINT_TO_POINT_NET_DEVICE_H
20
21#include "ns3/address.h"
22#include "ns3/callback.h"
23#include "ns3/data-rate.h"
24#include "ns3/mac48-address.h"
25#include "ns3/net-device.h"
26#include "ns3/node.h"
27#include "ns3/nstime.h"
28#include "ns3/packet.h"
29#include "ns3/ptr.h"
30#include "ns3/queue-fwd.h"
31#include "ns3/traced-callback.h"
32
33#include <cstring>
34
35namespace ns3
36{
37
38class PointToPointChannel;
39class ErrorModel;
40
64{
65 public:
71 static TypeId GetTypeId();
72
81
87 ~PointToPointNetDevice() override;
88
89 // Delete copy constructor and assignment operator to avoid misuse
92
100 void SetDataRate(DataRate bps);
101
108 void SetInterframeGap(Time t);
109
117
126 void SetQueue(Ptr<Queue<Packet>> queue);
127
134
144
155 void Receive(Ptr<Packet> p);
156
157 // The remaining methods are documented in ns3::NetDevice*
158
159 void SetIfIndex(const uint32_t index) override;
160 uint32_t GetIfIndex() const override;
161
162 Ptr<Channel> GetChannel() const override;
163
164 void SetAddress(Address address) override;
165 Address GetAddress() const override;
166
167 bool SetMtu(const uint16_t mtu) override;
168 uint16_t GetMtu() const override;
169
170 bool IsLinkUp() const override;
171
172 void AddLinkChangeCallback(Callback<void> callback) override;
173
174 bool IsBroadcast() const override;
175 Address GetBroadcast() const override;
176
177 bool IsMulticast() const override;
178 Address GetMulticast(Ipv4Address multicastGroup) const override;
179
180 bool IsPointToPoint() const override;
181 bool IsBridge() const override;
182
183 bool Send(Ptr<Packet> packet, const Address& dest, uint16_t protocolNumber) override;
184 bool SendFrom(Ptr<Packet> packet,
185 const Address& source,
186 const Address& dest,
187 uint16_t protocolNumber) override;
188
189 Ptr<Node> GetNode() const override;
190 void SetNode(Ptr<Node> node) override;
191
192 bool NeedsArp() const override;
193
195
196 Address GetMulticast(Ipv6Address addr) const override;
197
199 bool SupportsSendFrom() const override;
200
201 protected:
208
209 private:
213 void DoDispose() override;
214
219 Address GetRemote() const;
220
227 void AddHeader(Ptr<Packet> p, uint16_t protocolNumber);
228
237 bool ProcessHeader(Ptr<Packet> p, uint16_t& param);
238
255
262 void TransmitComplete();
263
269 void NotifyLinkUp();
270
275 {
277 BUSY
278 };
279
284
290
296
302
310
315
321
327
335
343
350
356
362
368
374
380
387
405
423
428 // (promisc data)
430 bool m_linkUp;
432
433 static const uint16_t DEFAULT_MTU = 1500;
434
444
446
452 static uint16_t PppToEther(uint16_t protocol);
453
459 static uint16_t EtherToPpp(uint16_t protocol);
460};
461
462} // namespace ns3
463
464#endif /* POINT_TO_POINT_NET_DEVICE_H */
a polymophic address class
Definition: address.h:100
Callback template class.
Definition: callback.h:438
Class for representing data rates.
Definition: data-rate.h:89
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:42
Describes an IPv6 address.
Definition: ipv6-address.h:49
an EUI-48 address
Definition: mac48-address.h:46
Network layer to device interface.
Definition: net-device.h:98
A Device for a Point to Point Network Link.
void AddHeader(Ptr< Packet > p, uint16_t protocolNumber)
Adds the necessary headers and trailers to a packet of data in order to respect the protocol implemen...
static const uint16_t DEFAULT_MTU
Default MTU.
Ptr< Node > GetNode() const override
TracedCallback< Ptr< const Packet > > m_phyRxEndTrace
The trace source fired when a packet ends the reception process from the medium.
Address GetMulticast(Ipv4Address multicastGroup) const override
Make and return a MAC multicast address using the provided multicast group.
Address GetBroadcast() const override
TracedCallback< Ptr< const Packet > > m_macPromiscRxTrace
The trace source fired for packets successfully received by the device immediately before being forwa...
PointToPointNetDevice()
Construct a PointToPointNetDevice.
Ptr< PointToPointChannel > m_channel
The PointToPointChannel to which this PointToPointNetDevice has been attached.
DataRate m_bps
The data rate that the Net Device uses to simulate packet transmission timing.
bool TransmitStart(Ptr< Packet > p)
Start Sending a Packet Down the Wire.
TracedCallback< Ptr< const Packet > > m_macRxTrace
The trace source fired for packets successfully received by the device immediately before being forwa...
TracedCallback< Ptr< const Packet > > m_macRxDropTrace
The trace source fired for packets successfully received by the device but are dropped before being f...
TracedCallback m_linkChangeCallbacks
Callback for the link change event.
TracedCallback< Ptr< const Packet > > m_macTxTrace
The trace source fired when packets come into the "top" of the device at the L3/L2 transition,...
bool SendFrom(Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber) override
void SetNode(Ptr< Node > node) override
void SetQueue(Ptr< Queue< Packet > > queue)
Attach a queue to the PointToPointNetDevice.
void SetIfIndex(const uint32_t index) override
void AddLinkChangeCallback(Callback< void > callback) override
bool Send(Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber) override
bool IsPointToPoint() const override
Return true if the net device is on a point-to-point link.
bool Attach(Ptr< PointToPointChannel > ch)
Attach the device to a channel.
static uint16_t EtherToPpp(uint16_t protocol)
Ethernet to PPP protocol number mapping.
void SetReceiveErrorModel(Ptr< ErrorModel > em)
Attach a receive ErrorModel to the PointToPointNetDevice.
TracedCallback< Ptr< const Packet > > m_phyTxDropTrace
The trace source fired when the phy layer drops a packet before it tries to transmit it.
Ptr< ErrorModel > m_receiveErrorModel
Error model for receive packet events.
void SetInterframeGap(Time t)
Set the interframe gap used to separate packets.
void SetReceiveCallback(NetDevice::ReceiveCallback cb) override
bool m_linkUp
Identify if the link is up or not.
PointToPointNetDevice(const PointToPointNetDevice &)=delete
uint16_t GetMtu() const override
TracedCallback< Ptr< const Packet > > m_phyRxDropTrace
The trace source fired when the phy layer drops a packet it has received.
void NotifyLinkUp()
Make the link up and running.
Ptr< Queue< Packet > > GetQueue() const
Get a copy of the attached Queue.
TxMachineState
Enumeration of the states of the transmit machine of the net device.
@ READY
The transmitter is ready to begin transmission of a packet.
@ BUSY
The transmitter is busy transmitting a packet.
static uint16_t PppToEther(uint16_t protocol)
PPP to Ethernet protocol number mapping.
Address GetAddress() const override
bool IsBridge() const override
Return true if the net device is acting as a bridge.
Ptr< Channel > GetChannel() const override
TracedCallback< Ptr< const Packet > > m_phyTxBeginTrace
The trace source fired when a packet begins the transmission process on the medium.
void DoDispose() override
Dispose of the object.
void SetAddress(Address address) override
Set the address of this interface.
void TransmitComplete()
Stop Sending a Packet Down the Wire and Begin the Interframe Gap.
~PointToPointNetDevice() override
Destroy a PointToPointNetDevice.
static TypeId GetTypeId()
Get the TypeId.
Mac48Address m_address
Mac48Address of this NetDevice.
uint32_t GetIfIndex() const override
Time m_tInterframeGap
The interframe gap that the Net Device uses to throttle packet transmission.
Ptr< Packet > m_currentPkt
Current packet processed.
bool ProcessHeader(Ptr< Packet > p, uint16_t &param)
Removes, from a packet of data, all headers and trailers that relate to the protocol implemented by t...
void Receive(Ptr< Packet > p)
Receive a packet from a connected PointToPointChannel.
TracedCallback< Ptr< const Packet > > m_phyRxBeginTrace
The trace source fired when a packet begins the reception process from the medium – when the simulate...
Ptr< Queue< Packet > > m_queue
The Queue which this PointToPointNetDevice uses as a packet source.
PointToPointNetDevice & operator=(const PointToPointNetDevice &)=delete
TracedCallback< Ptr< const Packet > > m_promiscSnifferTrace
A trace source that emulates a promiscuous mode protocol sniffer connected to the device.
TracedCallback< Ptr< const Packet > > m_phyTxEndTrace
The trace source fired when a packet ends the transmission process on the medium.
TxMachineState m_txMachineState
The state of the Net Device transmit state machine.
void DoMpiReceive(Ptr< Packet > p)
Handler for MPI receive event.
void SetDataRate(DataRate bps)
Set the Data Rate used for transmission of packets.
uint32_t m_mtu
The Maximum Transmission Unit.
Ptr< Node > m_node
Node owning this NetDevice.
TracedCallback< Ptr< const Packet > > m_snifferTrace
A trace source that emulates a non-promiscuous protocol sniffer connected to the device.
bool SetMtu(const uint16_t mtu) override
TracedCallback< Ptr< const Packet > > m_macTxDropTrace
The trace source fired when packets coming into the "top" of the device at the L3/L2 transition are d...
NetDevice::PromiscReceiveCallback m_promiscCallback
Receive callback.
NetDevice::ReceiveCallback m_rxCallback
Receive callback.
void SetPromiscReceiveCallback(PromiscReceiveCallback cb) override
uint32_t m_ifIndex
Index of the interface.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:78
Template class for packet Queues.
Definition: queue.h:267
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
Forward calls to a chain of Callback.
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.