1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>ip::icmp::endpoint</title> 5<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../ip__icmp.html" title="ip::icmp"> 9<link rel="prev" href="../ip__icmp.html" title="ip::icmp"> 10<link rel="next" href="family.html" title="ip::icmp::family"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="../ip__icmp.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ip__icmp.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="family.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<a name="boost_asio.reference.ip__icmp.endpoint"></a><a class="link" href="endpoint.html" title="ip::icmp::endpoint">ip::icmp::endpoint</a> 28</h4></div></div></div> 29<p> 30 <a class="indexterm" name="boost_asio.indexterm.ip__icmp.endpoint"></a> 31The type of a ICMP 32 endpoint. 33 </p> 34<pre class="programlisting">typedef basic_endpoint< icmp > endpoint; 35</pre> 36<h6> 37<a name="boost_asio.reference.ip__icmp.endpoint.h0"></a> 38 <span class="phrase"><a name="boost_asio.reference.ip__icmp.endpoint.types"></a></span><a class="link" href="endpoint.html#boost_asio.reference.ip__icmp.endpoint.types">Types</a> 39 </h6> 40<div class="informaltable"><table class="table"> 41<colgroup> 42<col> 43<col> 44</colgroup> 45<thead><tr> 46<th> 47 <p> 48 Name 49 </p> 50 </th> 51<th> 52 <p> 53 Description 54 </p> 55 </th> 56</tr></thead> 57<tbody> 58<tr> 59<td> 60 <p> 61 <a class="link" href="../ip__basic_endpoint/data_type.html" title="ip::basic_endpoint::data_type"><span class="bold"><strong>data_type</strong></span></a> 62 </p> 63 </td> 64<td> 65 <p> 66 The type of the endpoint structure. This type is dependent on 67 the underlying implementation of the socket layer. 68 </p> 69 </td> 70</tr> 71<tr> 72<td> 73 <p> 74 <a class="link" href="../ip__basic_endpoint/protocol_type.html" title="ip::basic_endpoint::protocol_type"><span class="bold"><strong>protocol_type</strong></span></a> 75 </p> 76 </td> 77<td> 78 <p> 79 The protocol type associated with the endpoint. 80 </p> 81 </td> 82</tr> 83</tbody> 84</table></div> 85<h6> 86<a name="boost_asio.reference.ip__icmp.endpoint.h1"></a> 87 <span class="phrase"><a name="boost_asio.reference.ip__icmp.endpoint.member_functions"></a></span><a class="link" href="endpoint.html#boost_asio.reference.ip__icmp.endpoint.member_functions">Member 88 Functions</a> 89 </h6> 90<div class="informaltable"><table class="table"> 91<colgroup> 92<col> 93<col> 94</colgroup> 95<thead><tr> 96<th> 97 <p> 98 Name 99 </p> 100 </th> 101<th> 102 <p> 103 Description 104 </p> 105 </th> 106</tr></thead> 107<tbody> 108<tr> 109<td> 110 <p> 111 <a class="link" href="../ip__basic_endpoint/address.html" title="ip::basic_endpoint::address"><span class="bold"><strong>address</strong></span></a> 112 </p> 113 </td> 114<td> 115 <p> 116 Get the IP address associated with the endpoint. <br> <span class="silver"> —</span><br> 117 Set the IP address associated with the endpoint. 118 </p> 119 </td> 120</tr> 121<tr> 122<td> 123 <p> 124 <a class="link" href="../ip__basic_endpoint/basic_endpoint.html" title="ip::basic_endpoint::basic_endpoint"><span class="bold"><strong>basic_endpoint</strong></span></a> <span class="silver">[constructor]</span> 125 </p> 126 </td> 127<td> 128 <p> 129 Default constructor. <br> <span class="silver"> —</span><br> Construct an endpoint using 130 a port number, specified in the host's byte order. The IP address 131 will be the any address (i.e. INADDR_ANY or in6addr_any). This 132 constructor would typically be used for accepting new connections. 133 <br> <span class="silver"> —</span><br> Construct an endpoint using a port number and an 134 IP address. This constructor may be used for accepting connections 135 on a specific interface or for making a connection to a remote 136 endpoint. <br> <span class="silver"> —</span><br> Copy constructor. <br> <span class="silver"> —</span><br> Move 137 constructor. 138 </p> 139 </td> 140</tr> 141<tr> 142<td> 143 <p> 144 <a class="link" href="../ip__basic_endpoint/capacity.html" title="ip::basic_endpoint::capacity"><span class="bold"><strong>capacity</strong></span></a> 145 </p> 146 </td> 147<td> 148 <p> 149 Get the capacity of the endpoint in the native type. 150 </p> 151 </td> 152</tr> 153<tr> 154<td> 155 <p> 156 <a class="link" href="../ip__basic_endpoint/data.html" title="ip::basic_endpoint::data"><span class="bold"><strong>data</strong></span></a> 157 </p> 158 </td> 159<td> 160 <p> 161 Get the underlying endpoint in the native type. 162 </p> 163 </td> 164</tr> 165<tr> 166<td> 167 <p> 168 <a class="link" href="../ip__basic_endpoint/operator_eq_.html" title="ip::basic_endpoint::operator="><span class="bold"><strong>operator=</strong></span></a> 169 </p> 170 </td> 171<td> 172 <p> 173 Assign from another endpoint. <br> <span class="silver"> —</span><br> Move-assign from 174 another endpoint. 175 </p> 176 </td> 177</tr> 178<tr> 179<td> 180 <p> 181 <a class="link" href="../ip__basic_endpoint/port.html" title="ip::basic_endpoint::port"><span class="bold"><strong>port</strong></span></a> 182 </p> 183 </td> 184<td> 185 <p> 186 Get the port associated with the endpoint. The port number is 187 always in the host's byte order. <br> <span class="silver"> —</span><br> Set the port associated 188 with the endpoint. The port number is always in the host's byte 189 order. 190 </p> 191 </td> 192</tr> 193<tr> 194<td> 195 <p> 196 <a class="link" href="../ip__basic_endpoint/protocol.html" title="ip::basic_endpoint::protocol"><span class="bold"><strong>protocol</strong></span></a> 197 </p> 198 </td> 199<td> 200 <p> 201 The protocol associated with the endpoint. 202 </p> 203 </td> 204</tr> 205<tr> 206<td> 207 <p> 208 <a class="link" href="../ip__basic_endpoint/resize.html" title="ip::basic_endpoint::resize"><span class="bold"><strong>resize</strong></span></a> 209 </p> 210 </td> 211<td> 212 <p> 213 Set the underlying size of the endpoint in the native type. 214 </p> 215 </td> 216</tr> 217<tr> 218<td> 219 <p> 220 <a class="link" href="../ip__basic_endpoint/size.html" title="ip::basic_endpoint::size"><span class="bold"><strong>size</strong></span></a> 221 </p> 222 </td> 223<td> 224 <p> 225 Get the underlying size of the endpoint in the native type. 226 </p> 227 </td> 228</tr> 229</tbody> 230</table></div> 231<h6> 232<a name="boost_asio.reference.ip__icmp.endpoint.h2"></a> 233 <span class="phrase"><a name="boost_asio.reference.ip__icmp.endpoint.friends"></a></span><a class="link" href="endpoint.html#boost_asio.reference.ip__icmp.endpoint.friends">Friends</a> 234 </h6> 235<div class="informaltable"><table class="table"> 236<colgroup> 237<col> 238<col> 239</colgroup> 240<thead><tr> 241<th> 242 <p> 243 Name 244 </p> 245 </th> 246<th> 247 <p> 248 Description 249 </p> 250 </th> 251</tr></thead> 252<tbody> 253<tr> 254<td> 255 <p> 256 <a class="link" href="../ip__basic_endpoint/operator_not__eq_.html" title="ip::basic_endpoint::operator!="><span class="bold"><strong>operator!=</strong></span></a> 257 </p> 258 </td> 259<td> 260 <p> 261 Compare two endpoints for inequality. 262 </p> 263 </td> 264</tr> 265<tr> 266<td> 267 <p> 268 <a class="link" href="../ip__basic_endpoint/operator_lt_.html" title="ip::basic_endpoint::operator<"><span class="bold"><strong>operator<</strong></span></a> 269 </p> 270 </td> 271<td> 272 <p> 273 Compare endpoints for ordering. 274 </p> 275 </td> 276</tr> 277<tr> 278<td> 279 <p> 280 <a class="link" href="../ip__basic_endpoint/operator_lt__eq_.html" title="ip::basic_endpoint::operator<="><span class="bold"><strong>operator<=</strong></span></a> 281 </p> 282 </td> 283<td> 284 <p> 285 Compare endpoints for ordering. 286 </p> 287 </td> 288</tr> 289<tr> 290<td> 291 <p> 292 <a class="link" href="../ip__basic_endpoint/operator_eq__eq_.html" title="ip::basic_endpoint::operator=="><span class="bold"><strong>operator==</strong></span></a> 293 </p> 294 </td> 295<td> 296 <p> 297 Compare two endpoints for equality. 298 </p> 299 </td> 300</tr> 301<tr> 302<td> 303 <p> 304 <a class="link" href="../ip__basic_endpoint/operator_gt_.html" title="ip::basic_endpoint::operator>"><span class="bold"><strong>operator></strong></span></a> 305 </p> 306 </td> 307<td> 308 <p> 309 Compare endpoints for ordering. 310 </p> 311 </td> 312</tr> 313<tr> 314<td> 315 <p> 316 <a class="link" href="../ip__basic_endpoint/operator_gt__eq_.html" title="ip::basic_endpoint::operator>="><span class="bold"><strong>operator>=</strong></span></a> 317 </p> 318 </td> 319<td> 320 <p> 321 Compare endpoints for ordering. 322 </p> 323 </td> 324</tr> 325</tbody> 326</table></div> 327<h6> 328<a name="boost_asio.reference.ip__icmp.endpoint.h3"></a> 329 <span class="phrase"><a name="boost_asio.reference.ip__icmp.endpoint.related_functions"></a></span><a class="link" href="endpoint.html#boost_asio.reference.ip__icmp.endpoint.related_functions">Related 330 Functions</a> 331 </h6> 332<div class="informaltable"><table class="table"> 333<colgroup> 334<col> 335<col> 336</colgroup> 337<thead><tr> 338<th> 339 <p> 340 Name 341 </p> 342 </th> 343<th> 344 <p> 345 Description 346 </p> 347 </th> 348</tr></thead> 349<tbody><tr> 350<td> 351 <p> 352 <a class="link" href="../ip__basic_endpoint/operator_lt__lt_.html" title="ip::basic_endpoint::operator<<"><span class="bold"><strong>operator<<</strong></span></a> 353 </p> 354 </td> 355<td> 356 <p> 357 Output an endpoint as a string. 358 </p> 359 </td> 360</tr></tbody> 361</table></div> 362<p> 363 The <a class="link" href="../ip__basic_endpoint.html" title="ip::basic_endpoint"><code class="computeroutput">ip::basic_endpoint</code></a> 364 class template describes an endpoint that may be associated with a particular 365 socket. 366 </p> 367<h6> 368<a name="boost_asio.reference.ip__icmp.endpoint.h4"></a> 369 <span class="phrase"><a name="boost_asio.reference.ip__icmp.endpoint.thread_safety"></a></span><a class="link" href="endpoint.html#boost_asio.reference.ip__icmp.endpoint.thread_safety">Thread Safety</a> 370 </h6> 371<p> 372 <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe. 373 </p> 374<p> 375 <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe. 376 </p> 377<h6> 378<a name="boost_asio.reference.ip__icmp.endpoint.h5"></a> 379 <span class="phrase"><a name="boost_asio.reference.ip__icmp.endpoint.requirements"></a></span><a class="link" href="endpoint.html#boost_asio.reference.ip__icmp.endpoint.requirements">Requirements</a> 380 </h6> 381<p> 382 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/ip/icmp.hpp</code> 383 </p> 384<p> 385 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> 386 </p> 387</div> 388<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 389<td align="left"></td> 390<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 391 Kohlhoff<p> 392 Distributed under the Boost Software License, Version 1.0. (See accompanying 393 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 394 </p> 395</div></td> 396</tr></table> 397<hr> 398<div class="spirit-nav"> 399<a accesskey="p" href="../ip__icmp.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ip__icmp.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="family.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 400</div> 401</body> 402</html> 403
