A Discrete-Event Network Simulator
API
netmap-net-device-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2017 Universita' degli Studi di Napoli Federico II
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: Pasquale Imputato <p.imputato@gmail.com>
19  */
20 
21 #ifndef NETMAP_NET_DEVICE_HELPER_H
22 #define NETMAP_NET_DEVICE_HELPER_H
23 
24 #include <string>
25 
26 #include "ns3/attribute.h"
27 #include "ns3/fd-net-device.h"
28 #include "ns3/fd-net-device-helper.h"
29 #include "ns3/object-factory.h"
30 #include "ns3/net-device-container.h"
31 #include "ns3/node-container.h"
32 #include "ns3/netmap-net-device.h"
33 
34 namespace ns3 {
35 
36 class NetmapNetDevice;
37 
44 class NetmapNetDeviceHelper : public FdNetDeviceHelper
45 {
46 public:
47 
48  NetmapNetDeviceHelper ();
49  virtual ~NetmapNetDeviceHelper ()
50  {}
51 
56  std::string GetDeviceName (void);
57 
62  void SetDeviceName (std::string deviceName);
63 
64 protected:
65 
72  Ptr<NetDevice> InstallPriv (Ptr<Node> node) const;
73 
78  virtual void SetDeviceAttributes (Ptr<FdNetDevice> device) const;
79 
85  virtual int CreateFileDescriptor (void) const;
86 
92  void SwitchInNetmapMode (int fd, Ptr<NetmapNetDevice> device) const;
93 
94  std::string m_deviceName;
95 };
96 
97 } // namespace ns3
98 
99 #endif /* NETMAP_NET_DEVICE_HELPER_H */
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
ns3::FdNetDeviceHelper
build a set of FdNetDevice objects Normally we eschew multiple inheritance, however, the classes PcapUserHelperForDevice and AsciiTraceUserHelperForDevice are treated as "mixins".
Definition: fd-net-device-helper.h:45
ns3::NetmapNetDeviceHelper::GetDeviceName
std::string GetDeviceName(void)
Get the device name of this device.
Definition: netmap-net-device-helper.cc:74
ns3::NetmapNetDeviceHelper::SwitchInNetmapMode
void SwitchInNetmapMode(int fd, Ptr< NetmapNetDevice > device) const
Switch the fd in netmap mode.
Definition: netmap-net-device-helper.cc:422
ns3::NetmapNetDeviceHelper::m_deviceName
std::string m_deviceName
The unix/linux name of the underlying device (e.g., eth0)
Definition: netmap-net-device-helper.h:94
ns3::NetmapNetDeviceHelper::CreateFileDescriptor
virtual int CreateFileDescriptor(void) const
Call out to a separate process running as suid root in order to get a raw socket. ...
Definition: netmap-net-device-helper.cc:199
ns3::NetmapNetDeviceHelper::SetDeviceAttributes
virtual void SetDeviceAttributes(Ptr< FdNetDevice > device) const
Sets device flags and MTU.
Definition: netmap-net-device-helper.cc:109
ns3::NetmapNetDeviceHelper
build a set of FdNetDevice objects attached to a physical network interface
Definition: netmap-net-device-helper.h:44
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::NetmapNetDeviceHelper::SetDeviceName
void SetDeviceName(std::string deviceName)
Set the device name of this device.
Definition: netmap-net-device-helper.cc:80
ns3::NetmapNetDeviceHelper::InstallPriv
Ptr< NetDevice > InstallPriv(Ptr< Node > node) const
This method creates an ns3::FdNetDevice attached to a physical network interface. ...
Definition: netmap-net-device-helper.cc:86