1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>generic::basic_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="../reference.html" title="Reference"> 9<link rel="prev" href="executor_work_guard/_executor_work_guard.html" title="executor_work_guard::~executor_work_guard"> 10<link rel="next" href="generic__basic_endpoint/basic_endpoint.html" title="generic::basic_endpoint::basic_endpoint"> 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="executor_work_guard/_executor_work_guard.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="generic__basic_endpoint/basic_endpoint.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h3 class="title"> 27<a name="boost_asio.reference.generic__basic_endpoint"></a><a class="link" href="generic__basic_endpoint.html" title="generic::basic_endpoint">generic::basic_endpoint</a> 28</h3></div></div></div> 29<p> 30 Describes an endpoint for any socket type. 31 </p> 32<pre class="programlisting">template< 33 typename <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a>> 34class basic_endpoint 35</pre> 36<h5> 37<a name="boost_asio.reference.generic__basic_endpoint.h0"></a> 38 <span class="phrase"><a name="boost_asio.reference.generic__basic_endpoint.types"></a></span><a class="link" href="generic__basic_endpoint.html#boost_asio.reference.generic__basic_endpoint.types">Types</a> 39 </h5> 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="generic__basic_endpoint/data_type.html" title="generic::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 the 67 underlying implementation of the socket layer. 68 </p> 69 </td> 70</tr> 71<tr> 72<td> 73 <p> 74 <a class="link" href="generic__basic_endpoint/protocol_type.html" title="generic::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<h5> 86<a name="boost_asio.reference.generic__basic_endpoint.h1"></a> 87 <span class="phrase"><a name="boost_asio.reference.generic__basic_endpoint.member_functions"></a></span><a class="link" href="generic__basic_endpoint.html#boost_asio.reference.generic__basic_endpoint.member_functions">Member 88 Functions</a> 89 </h5> 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="generic__basic_endpoint/basic_endpoint.html" title="generic::basic_endpoint::basic_endpoint"><span class="bold"><strong>basic_endpoint</strong></span></a> <span class="silver">[constructor]</span> 112 </p> 113 </td> 114<td> 115 <p> 116 Default constructor. <br> <span class="silver"> —</span><br> Construct an endpoint from the 117 specified socket address. <br> <span class="silver"> —</span><br> Construct an endpoint from 118 the specific endpoint type. <br> <span class="silver"> —</span><br> Copy constructor. 119 </p> 120 </td> 121</tr> 122<tr> 123<td> 124 <p> 125 <a class="link" href="generic__basic_endpoint/capacity.html" title="generic::basic_endpoint::capacity"><span class="bold"><strong>capacity</strong></span></a> 126 </p> 127 </td> 128<td> 129 <p> 130 Get the capacity of the endpoint in the native type. 131 </p> 132 </td> 133</tr> 134<tr> 135<td> 136 <p> 137 <a class="link" href="generic__basic_endpoint/data.html" title="generic::basic_endpoint::data"><span class="bold"><strong>data</strong></span></a> 138 </p> 139 </td> 140<td> 141 <p> 142 Get the underlying endpoint in the native type. 143 </p> 144 </td> 145</tr> 146<tr> 147<td> 148 <p> 149 <a class="link" href="generic__basic_endpoint/operator_eq_.html" title="generic::basic_endpoint::operator="><span class="bold"><strong>operator=</strong></span></a> 150 </p> 151 </td> 152<td> 153 <p> 154 Assign from another endpoint. 155 </p> 156 </td> 157</tr> 158<tr> 159<td> 160 <p> 161 <a class="link" href="generic__basic_endpoint/protocol.html" title="generic::basic_endpoint::protocol"><span class="bold"><strong>protocol</strong></span></a> 162 </p> 163 </td> 164<td> 165 <p> 166 The protocol associated with the endpoint. 167 </p> 168 </td> 169</tr> 170<tr> 171<td> 172 <p> 173 <a class="link" href="generic__basic_endpoint/resize.html" title="generic::basic_endpoint::resize"><span class="bold"><strong>resize</strong></span></a> 174 </p> 175 </td> 176<td> 177 <p> 178 Set the underlying size of the endpoint in the native type. 179 </p> 180 </td> 181</tr> 182<tr> 183<td> 184 <p> 185 <a class="link" href="generic__basic_endpoint/size.html" title="generic::basic_endpoint::size"><span class="bold"><strong>size</strong></span></a> 186 </p> 187 </td> 188<td> 189 <p> 190 Get the underlying size of the endpoint in the native type. 191 </p> 192 </td> 193</tr> 194</tbody> 195</table></div> 196<h5> 197<a name="boost_asio.reference.generic__basic_endpoint.h2"></a> 198 <span class="phrase"><a name="boost_asio.reference.generic__basic_endpoint.friends"></a></span><a class="link" href="generic__basic_endpoint.html#boost_asio.reference.generic__basic_endpoint.friends">Friends</a> 199 </h5> 200<div class="informaltable"><table class="table"> 201<colgroup> 202<col> 203<col> 204</colgroup> 205<thead><tr> 206<th> 207 <p> 208 Name 209 </p> 210 </th> 211<th> 212 <p> 213 Description 214 </p> 215 </th> 216</tr></thead> 217<tbody> 218<tr> 219<td> 220 <p> 221 <a class="link" href="generic__basic_endpoint/operator_not__eq_.html" title="generic::basic_endpoint::operator!="><span class="bold"><strong>operator!=</strong></span></a> 222 </p> 223 </td> 224<td> 225 <p> 226 Compare two endpoints for inequality. 227 </p> 228 </td> 229</tr> 230<tr> 231<td> 232 <p> 233 <a class="link" href="generic__basic_endpoint/operator_lt_.html" title="generic::basic_endpoint::operator<"><span class="bold"><strong>operator<</strong></span></a> 234 </p> 235 </td> 236<td> 237 <p> 238 Compare endpoints for ordering. 239 </p> 240 </td> 241</tr> 242<tr> 243<td> 244 <p> 245 <a class="link" href="generic__basic_endpoint/operator_lt__eq_.html" title="generic::basic_endpoint::operator<="><span class="bold"><strong>operator<=</strong></span></a> 246 </p> 247 </td> 248<td> 249 <p> 250 Compare endpoints for ordering. 251 </p> 252 </td> 253</tr> 254<tr> 255<td> 256 <p> 257 <a class="link" href="generic__basic_endpoint/operator_eq__eq_.html" title="generic::basic_endpoint::operator=="><span class="bold"><strong>operator==</strong></span></a> 258 </p> 259 </td> 260<td> 261 <p> 262 Compare two endpoints for equality. 263 </p> 264 </td> 265</tr> 266<tr> 267<td> 268 <p> 269 <a class="link" href="generic__basic_endpoint/operator_gt_.html" title="generic::basic_endpoint::operator>"><span class="bold"><strong>operator></strong></span></a> 270 </p> 271 </td> 272<td> 273 <p> 274 Compare endpoints for ordering. 275 </p> 276 </td> 277</tr> 278<tr> 279<td> 280 <p> 281 <a class="link" href="generic__basic_endpoint/operator_gt__eq_.html" title="generic::basic_endpoint::operator>="><span class="bold"><strong>operator>=</strong></span></a> 282 </p> 283 </td> 284<td> 285 <p> 286 Compare endpoints for ordering. 287 </p> 288 </td> 289</tr> 290</tbody> 291</table></div> 292<p> 293 The <a class="link" href="generic__basic_endpoint.html" title="generic::basic_endpoint"><code class="computeroutput">generic::basic_endpoint</code></a> 294 class template describes an endpoint that may be associated with any socket 295 type. 296 </p> 297<h5> 298<a name="boost_asio.reference.generic__basic_endpoint.h3"></a> 299 <span class="phrase"><a name="boost_asio.reference.generic__basic_endpoint.remarks"></a></span><a class="link" href="generic__basic_endpoint.html#boost_asio.reference.generic__basic_endpoint.remarks">Remarks</a> 300 </h5> 301<p> 302 The socket types sockaddr type must be able to fit into a <code class="computeroutput">sockaddr_storage</code> 303 structure. 304 </p> 305<h5> 306<a name="boost_asio.reference.generic__basic_endpoint.h4"></a> 307 <span class="phrase"><a name="boost_asio.reference.generic__basic_endpoint.thread_safety"></a></span><a class="link" href="generic__basic_endpoint.html#boost_asio.reference.generic__basic_endpoint.thread_safety">Thread 308 Safety</a> 309 </h5> 310<p> 311 <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe. 312 </p> 313<p> 314 <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe. 315 </p> 316<h5> 317<a name="boost_asio.reference.generic__basic_endpoint.h5"></a> 318 <span class="phrase"><a name="boost_asio.reference.generic__basic_endpoint.requirements"></a></span><a class="link" href="generic__basic_endpoint.html#boost_asio.reference.generic__basic_endpoint.requirements">Requirements</a> 319 </h5> 320<p> 321 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/generic/basic_endpoint.hpp</code> 322 </p> 323<p> 324 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> 325 </p> 326</div> 327<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 328<td align="left"></td> 329<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 330 Kohlhoff<p> 331 Distributed under the Boost Software License, Version 1.0. (See accompanying 332 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>) 333 </p> 334</div></td> 335</tr></table> 336<hr> 337<div class="spirit-nav"> 338<a accesskey="p" href="executor_work_guard/_executor_work_guard.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="generic__basic_endpoint/basic_endpoint.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 339</div> 340</body> 341</html> 342
