File: Poco.Net.NetworkInterface.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (169 lines) | stat: -rw-r--r-- 16,072 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Class Poco::Net::NetworkInterface</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.Net.html" class="namespace">Poco::Net</a></h1>
<h1 class="symbol">class NetworkInterface</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Net<br />
<b>Package:</b> Sockets<br />
<b>Header:</b> Poco/Net/NetworkInterface.h</p>
<h2>Description</h2>
<div class="description">
<p>This class represents a network interface. </p>
<p><a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> is used with <a href="Poco.Net.MulticastSocket.html" title="class Poco::Net::MulticastSocket">MulticastSocket</a> to specify multicast interfaces for sending and receiving multicast messages. </p>
</div>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.Net.NetworkInterface.html#14565" title="Poco::Net::NetworkInterface::address()">address</a>, <a href="Poco.Net.NetworkInterface.html#14567" title="Poco::Net::NetworkInterface::broadcastAddress()">broadcastAddress</a>, <a href="Poco.Net.NetworkInterface.html#14564" title="Poco::Net::NetworkInterface::displayName()">displayName</a>, <a href="Poco.Net.NetworkInterface.html#14573" title="Poco::Net::NetworkInterface::forAddress()">forAddress</a>, <a href="Poco.Net.NetworkInterface.html#14575" title="Poco::Net::NetworkInterface::forIndex()">forIndex</a>, <a href="Poco.Net.NetworkInterface.html#14570" title="Poco::Net::NetworkInterface::forName()">forName</a>, <a href="Poco.Net.NetworkInterface.html#14562" title="Poco::Net::NetworkInterface::index()">index</a>, <a href="Poco.Net.NetworkInterface.html#14600" title="Poco::Net::NetworkInterface::interfaceNameToAddress()">interfaceNameToAddress</a>, <a href="Poco.Net.NetworkInterface.html#14602" title="Poco::Net::NetworkInterface::interfaceNameToIndex()">interfaceNameToIndex</a>, <a href="Poco.Net.NetworkInterface.html#14577" title="Poco::Net::NetworkInterface::list()">list</a>, <a href="Poco.Net.NetworkInterface.html#14563" title="Poco::Net::NetworkInterface::name()">name</a>, <a href="Poco.Net.NetworkInterface.html#14558" title="Poco::Net::NetworkInterface::operator =()">operator&nbsp;=</a>, <a href="Poco.Net.NetworkInterface.html#14566" title="Poco::Net::NetworkInterface::subnetMask()">subnetMask</a>, <a href="Poco.Net.NetworkInterface.html#14568" title="Poco::Net::NetworkInterface::supportsIPv4()">supportsIPv4</a>, <a href="Poco.Net.NetworkInterface.html#14569" title="Poco::Net::NetworkInterface::supportsIPv6()">supportsIPv6</a>, <a href="Poco.Net.NetworkInterface.html#14560" title="Poco::Net::NetworkInterface::swap()">swap</a></p>
<h2>Types</h2>
<h3><a name="14553">NetworkInterfaceList</a></h3>
<p class="decl">typedef std::vector &lt; <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> &gt; <a href="Poco.Net.NetworkInterface.html#14553" title="Poco::Net::NetworkInterface::NetworkInterfaceList">NetworkInterfaceList</a>;</p>
<div class="description">
<p></p>
</div>
<h2>Constructors</h2>
<h3><a name="14554">NetworkInterface</a></h3>
<p class="decl"><a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a>();</p>
<div class="description">
<p>Creates a <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> representing the default interface. </p>
<p>The name is empty, the IP address is the wildcard address and the index is zero. </p>
</div>
<h3><a name="14555">NetworkInterface</a></h3>
<p class="decl"><a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> &amp; interfc<br />);</p>
<div class="description">
<p>Creates the <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> by copying another one. </p>
</div>
<h3><a name="14590">NetworkInterface</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Net.IPAddress.html" title="class Poco::Net::IPAddress">IPAddress</a> &amp; address,<br />&nbsp;&nbsp;&nbsp;&nbsp;int index = - 1<br />);</p>
<div class="description">
<p>Creates the <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a>. </p>
</div>
<h3><a name="14578">NetworkInterface</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name,<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; displayName,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Net.IPAddress.html" title="class Poco::Net::IPAddress">IPAddress</a> &amp; address,<br />&nbsp;&nbsp;&nbsp;&nbsp;int index = - 1<br />);</p>
<div class="description">
<p>Creates the <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a>. </p>
</div>
<h3><a name="14594">NetworkInterface</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Net.IPAddress.html" title="class Poco::Net::IPAddress">IPAddress</a> &amp; address,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Net.IPAddress.html" title="class Poco::Net::IPAddress">IPAddress</a> &amp; subnetMask,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Net.IPAddress.html" title="class Poco::Net::IPAddress">IPAddress</a> &amp; broadcastAddress,<br />&nbsp;&nbsp;&nbsp;&nbsp;int index = - 1<br />);</p>
<div class="description">
<p>Creates the <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a>. </p>
</div>
<h3><a name="14583">NetworkInterface</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name,<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; displayName,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Net.IPAddress.html" title="class Poco::Net::IPAddress">IPAddress</a> &amp; address,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Net.IPAddress.html" title="class Poco::Net::IPAddress">IPAddress</a> &amp; subnetMask,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Net.IPAddress.html" title="class Poco::Net::IPAddress">IPAddress</a> &amp; broadcastAddress,<br />&nbsp;&nbsp;&nbsp;&nbsp;int index = - 1<br />);</p>
<div class="description">
<p>Creates the <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a>. </p>
</div>
<h2>Destructor</h2>
<h3><a name="14557">~NetworkInterface</a></h3>
<p class="decl">~<a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="14565">address</a></h3>
<p class="decl">const <a href="Poco.Net.IPAddress.html" title="class Poco::Net::IPAddress">IPAddress</a> &amp; address() const;</p>
<div class="description">
<p>Returns the IP address bound to the interface. </p>
</div>
<h3><a name="14567">broadcastAddress</a></h3>
<p class="decl">const <a href="Poco.Net.IPAddress.html" title="class Poco::Net::IPAddress">IPAddress</a> &amp; broadcastAddress() const;</p>
<div class="description">
<p>Returns the IPv4 broadcast address for this network interface. </p>
</div>
<h3><a name="14564">displayName</a></h3>
<p class="decl">const std::string &amp; displayName() const;</p>
<div class="description">
<p>Returns the interface display name. </p>
<p>On Windows platforms, this is currently the network adapter name. This may change to the &quot;friendly name&quot; of the network connection in a future version, however.  </p>
<p>On other platforms this is the same as <a href="Poco.Net.NetworkInterface.html#14563" title="Poco::Net::NetworkInterface::name()">name</a>(). </p>
</div>
<h3><a name="14573">forAddress</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> forAddress(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Net.IPAddress.html" title="class Poco::Net::IPAddress">IPAddress</a> &amp; address<br />);</p>
<div class="description">
<p>Returns the <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> for the given IP address. </p>
<p>Throws an <a href="Poco.Net.InterfaceNotFoundException.html" title="class Poco::Net::InterfaceNotFoundException">InterfaceNotFoundException</a> if an interface with the give address does not exist. </p>
</div>
<h3><a name="14575">forIndex</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> forIndex(<br />&nbsp;&nbsp;&nbsp;&nbsp;int index<br />);</p>
<div class="description">
<p>Returns the <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> for the given interface index. If an index of 0 is specified, a <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> instance representing the default interface (empty name and wildcard address) is returned. </p>
<p>Throws an <a href="Poco.Net.InterfaceNotFoundException.html" title="class Poco::Net::InterfaceNotFoundException">InterfaceNotFoundException</a> if an interface with the given index does not exist (or IPv6 is not available). </p>
</div>
<h3><a name="14570">forName</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> forName(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name,<br />&nbsp;&nbsp;&nbsp;&nbsp;bool requireIPv6 = false<br />);</p>
<div class="description">
<p>Returns the <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> for the given name. </p>
<p>If requireIPv6 is false, an IPv4 interface is returned. Otherwise, an IPv6 interface is returned. </p>
<p>Throws an <a href="Poco.Net.InterfaceNotFoundException.html" title="class Poco::Net::InterfaceNotFoundException">InterfaceNotFoundException</a> if an interface with the give name does not exist. </p>
</div>
<h3><a name="14562">index</a></h3>
<p class="decl">int index() const;</p>
<div class="description">
<p>Returns the interface index. </p>
<p>Only supported if IPv6 is available. Returns -1 if IPv6 is not available. </p>
</div>
<h3><a name="14577">list</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static <a href="Poco.Net.NetworkInterface.html#14553" title="Poco::Net::NetworkInterface::NetworkInterfaceList">NetworkInterfaceList</a> list();</p>
<div class="description">
<p>Returns a list with all network interfaces on the system. </p>
<p>If there are multiple addresses bound to one interface, multiple <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> instances are created for the same interface. </p>
</div>
<h3><a name="14563">name</a></h3>
<p class="decl">const std::string &amp; name() const;</p>
<div class="description">
<p>Returns the interface name. </p>
</div>
<h3><a name="14558">operator =</a></h3>
<p class="decl"><a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> &amp; operator = (<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> &amp; interfc<br />);</p>
<div class="description">
<p>Assigns another <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a>. </p>
</div>
<h3><a name="14566">subnetMask</a></h3>
<p class="decl">const <a href="Poco.Net.IPAddress.html" title="class Poco::Net::IPAddress">IPAddress</a> &amp; subnetMask() const;</p>
<div class="description">
<p>Returns the IPv4 subnet mask for this network interface. </p>
</div>
<h3><a name="14568">supportsIPv4</a></h3>
<p class="decl">bool supportsIPv4() const;</p>
<div class="description">
<p>Returns true if the interface supports IPv4. </p>
</div>
<h3><a name="14569">supportsIPv6</a></h3>
<p class="decl">bool supportsIPv6() const;</p>
<div class="description">
<p>Returns true if the interface supports IPv6.	 </p>
</div>
<h3><a name="14560">swap</a></h3>
<p class="decl">void swap(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> &amp; other<br />);</p>
<div class="description">
<p>Swaps the <a href="Poco.Net.NetworkInterface.html" title="class Poco::Net::NetworkInterface">NetworkInterface</a> with another one.	 </p>
</div>
<h3><a name="14600">interfaceNameToAddress</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.Net.IPAddress.html" title="class Poco::Net::IPAddress">IPAddress</a> interfaceNameToAddress(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; interfaceName<br />) const;</p>
<div class="description">
<p>Determines the <a href="Poco.Net.IPAddress.html" title="class Poco::Net::IPAddress">IPAddress</a> bound to the interface with the given name. </p>
</div>
<h3><a name="14602">interfaceNameToIndex</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int interfaceNameToIndex(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; interfaceName<br />) const;</p>
<div class="description">
<p>Determines the interface index of the interface with the given name. </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>