A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
tap-fd-net-device-helper.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2012 INRIA, 2012 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
19
#ifndef TAP_FD_NET_DEVICE_HELPER_H
20
#define TAP_FD_NET_DEVICE_HELPER_H
21
22
#include "
emu-fd-net-device-helper.h
"
23
24
#include "ns3/attribute.h"
25
#include "ns3/fd-net-device.h"
26
#include "ns3/mac48-address.h"
27
#include "ns3/net-device-container.h"
28
#include "ns3/node-container.h"
29
#include "ns3/object-factory.h"
30
31
#include <string>
32
33
namespace
ns3
34
{
35
36
/**
37
* \ingroup fd-net-device
38
* \brief build a set of FdNetDevice objects attached to a virtual TAP network
39
* interface
40
*
41
*/
42
class
TapFdNetDeviceHelper
:
public
EmuFdNetDeviceHelper
43
{
44
public
:
45
/**
46
* Construct a TapFdNetDeviceHelper.
47
*/
48
TapFdNetDeviceHelper
();
49
50
~TapFdNetDeviceHelper
()
override
51
{
52
}
53
54
/**
55
* Set flag IFF_NO_PI on the device.
56
*
57
* \param pi Set the IFF_NO_PI flag if pi is false.
58
*/
59
void
SetModePi
(
bool
pi);
60
61
/**
62
* Set the device IPv4 address.
63
*
64
* \param address The IPv4 address for the TAP device.
65
*/
66
void
SetTapIpv4Address
(
Ipv4Address
address);
67
68
/**
69
* Set the IPv4 network mask for the TAP device.
70
*
71
* \param mask The IPv4 network mask for the TAP device.
72
*/
73
void
SetTapIpv4Mask
(
Ipv4Mask
mask);
74
75
/**
76
* Set the device IPv6 address.
77
*
78
* \param address The IPv6 address for the TAP device.
79
*/
80
void
SetTapIpv6Address
(
Ipv6Address
address);
81
82
/**
83
* Set the IPv6 network mask for the TAP device.
84
*
85
* \param prefix The IPv6 network prefix for the TAP device.
86
*/
87
void
SetTapIpv6Prefix
(
int
prefix);
88
89
/**
90
* Set the MAC address for the TAP device.
91
*
92
* \param mac The MAC address the TAP device.
93
*/
94
void
SetTapMacAddress
(
Mac48Address
mac);
95
96
protected
:
97
/**
98
* This method creates an ns3::FdNetDevice attached to a virtual TAP network
99
* interface
100
*
101
* \param node The node to install the device in
102
* \returns A container holding the added net device.
103
*/
104
Ptr<NetDevice>
InstallPriv
(
Ptr<Node>
node)
const override
;
105
106
/**
107
* Sets a file descriptor on the FileDescriptorNetDevice.
108
* \param device the device to install the file descriptor in
109
*/
110
void
SetFileDescriptor
(
Ptr<FdNetDevice>
device)
const override
;
111
112
/**
113
* Call out to a separate process running as suid root in order to create a
114
* TAP device and obtain the file descriptor associated to it.
115
* \returns The file descriptor associated with the TAP device.
116
*/
117
int
CreateFileDescriptor
()
const override
;
118
119
/**
120
* The TAP device flag IFF_NO_PI.
121
*/
122
bool
m_modePi
;
123
124
/**
125
* The IPv4 address for the TAP device.
126
*/
127
Ipv4Address
m_tapIp4
;
128
129
/**
130
* The IPv6 address for the TAP device.
131
*/
132
Ipv6Address
m_tapIp6
;
133
134
/**
135
* The network mask IPv4 for the TAP device.
136
*/
137
Ipv4Mask
m_tapMask4
;
138
139
/**
140
* The network prefix IPv6 for the TAP device.
141
*/
142
int
m_tapPrefix6
;
143
144
/**
145
* The TAP device MAC address.
146
*/
147
Mac48Address
m_tapMac
;
148
};
149
150
}
// namespace ns3
151
152
#endif
/* TAP_FD_NET_DEVICE_HELPER_H */
ns3::EmuFdNetDeviceHelper
build a set of FdNetDevice objects attached to a physical network interface
Definition:
emu-fd-net-device-helper.h:42
ns3::Ipv4Address
Ipv4 addresses are stored in host order in this class.
Definition:
ipv4-address.h:42
ns3::Ipv4Mask
a class to represent an Ipv4 address mask
Definition:
ipv4-address.h:257
ns3::Ipv6Address
Describes an IPv6 address.
Definition:
ipv6-address.h:49
ns3::Mac48Address
an EUI-48 address
Definition:
mac48-address.h:46
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:77
ns3::TapFdNetDeviceHelper
build a set of FdNetDevice objects attached to a virtual TAP network interface
Definition:
tap-fd-net-device-helper.h:43
ns3::TapFdNetDeviceHelper::CreateFileDescriptor
int CreateFileDescriptor() const override
Call out to a separate process running as suid root in order to create a TAP device and obtain the fi...
Definition:
tap-fd-net-device-helper.cc:142
ns3::TapFdNetDeviceHelper::SetTapMacAddress
void SetTapMacAddress(Mac48Address mac)
Set the MAC address for the TAP device.
Definition:
tap-fd-net-device-helper.cc:102
ns3::TapFdNetDeviceHelper::m_modePi
bool m_modePi
The TAP device flag IFF_NO_PI.
Definition:
tap-fd-net-device-helper.h:122
ns3::TapFdNetDeviceHelper::SetTapIpv6Prefix
void SetTapIpv6Prefix(int prefix)
Set the IPv6 network mask for the TAP device.
Definition:
tap-fd-net-device-helper.cc:96
ns3::TapFdNetDeviceHelper::m_tapIp6
Ipv6Address m_tapIp6
The IPv6 address for the TAP device.
Definition:
tap-fd-net-device-helper.h:132
ns3::TapFdNetDeviceHelper::InstallPriv
Ptr< NetDevice > InstallPriv(Ptr< Node > node) const override
This method creates an ns3::FdNetDevice attached to a virtual TAP network interface.
Definition:
tap-fd-net-device-helper.cc:108
ns3::TapFdNetDeviceHelper::SetTapIpv4Mask
void SetTapIpv4Mask(Ipv4Mask mask)
Set the IPv4 network mask for the TAP device.
Definition:
tap-fd-net-device-helper.cc:84
ns3::TapFdNetDeviceHelper::m_tapMask4
Ipv4Mask m_tapMask4
The network mask IPv4 for the TAP device.
Definition:
tap-fd-net-device-helper.h:137
ns3::TapFdNetDeviceHelper::m_tapIp4
Ipv4Address m_tapIp4
The IPv4 address for the TAP device.
Definition:
tap-fd-net-device-helper.h:127
ns3::TapFdNetDeviceHelper::TapFdNetDeviceHelper
TapFdNetDeviceHelper()
Construct a TapFdNetDeviceHelper.
Definition:
tap-fd-net-device-helper.cc:60
ns3::TapFdNetDeviceHelper::m_tapMac
Mac48Address m_tapMac
The TAP device MAC address.
Definition:
tap-fd-net-device-helper.h:147
ns3::TapFdNetDeviceHelper::m_tapPrefix6
int m_tapPrefix6
The network prefix IPv6 for the TAP device.
Definition:
tap-fd-net-device-helper.h:142
ns3::TapFdNetDeviceHelper::SetTapIpv4Address
void SetTapIpv4Address(Ipv4Address address)
Set the device IPv4 address.
Definition:
tap-fd-net-device-helper.cc:78
ns3::TapFdNetDeviceHelper::SetModePi
void SetModePi(bool pi)
Set flag IFF_NO_PI on the device.
Definition:
tap-fd-net-device-helper.cc:72
ns3::TapFdNetDeviceHelper::SetTapIpv6Address
void SetTapIpv6Address(Ipv6Address address)
Set the device IPv6 address.
Definition:
tap-fd-net-device-helper.cc:90
ns3::TapFdNetDeviceHelper::~TapFdNetDeviceHelper
~TapFdNetDeviceHelper() override
Definition:
tap-fd-net-device-helper.h:50
ns3::TapFdNetDeviceHelper::SetFileDescriptor
void SetFileDescriptor(Ptr< FdNetDevice > device) const override
Sets a file descriptor on the FileDescriptorNetDevice.
Definition:
tap-fd-net-device-helper.cc:129
emu-fd-net-device-helper.h
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
fd-net-device
helper
tap-fd-net-device-helper.h
Generated on Tue May 28 2024 23:35:23 for ns-3 by
1.9.6