1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>local::stream_protocol::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="../local__stream_protocol.html" title="local::stream_protocol"> 9<link rel="prev" href="acceptor.html" title="local::stream_protocol::acceptor"> 10<link rel="next" href="family.html" title="local::stream_protocol::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="acceptor.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../local__stream_protocol.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.local__stream_protocol.endpoint"></a><a class="link" href="endpoint.html" title="local::stream_protocol::endpoint">local::stream_protocol::endpoint</a> 28</h4></div></div></div> 29<p> 30 <a class="indexterm" name="boost_asio.indexterm.local__stream_protocol.endpoint"></a> 31The 32 type of a UNIX domain endpoint. 33 </p> 34<pre class="programlisting">typedef basic_endpoint< stream_protocol > endpoint; 35</pre> 36<h6> 37<a name="boost_asio.reference.local__stream_protocol.endpoint.h0"></a> 38 <span class="phrase"><a name="boost_asio.reference.local__stream_protocol.endpoint.types"></a></span><a class="link" href="endpoint.html#boost_asio.reference.local__stream_protocol.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="../local__basic_endpoint/data_type.html" title="local::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="../local__basic_endpoint/protocol_type.html" title="local::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.local__stream_protocol.endpoint.h1"></a> 87 <span class="phrase"><a name="boost_asio.reference.local__stream_protocol.endpoint.member_functions"></a></span><a class="link" href="endpoint.html#boost_asio.reference.local__stream_protocol.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="../local__basic_endpoint/basic_endpoint.html" title="local::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 using 117 the specified path name. <br> <span class="silver"> —</span><br> Copy constructor. 118 </p> 119 </td> 120</tr> 121<tr> 122<td> 123 <p> 124 <a class="link" href="../local__basic_endpoint/capacity.html" title="local::basic_endpoint::capacity"><span class="bold"><strong>capacity</strong></span></a> 125 </p> 126 </td> 127<td> 128 <p> 129 Get the capacity of the endpoint in the native type. 130 </p> 131 </td> 132</tr> 133<tr> 134<td> 135 <p> 136 <a class="link" href="../local__basic_endpoint/data.html" title="local::basic_endpoint::data"><span class="bold"><strong>data</strong></span></a> 137 </p> 138 </td> 139<td> 140 <p> 141 Get the underlying endpoint in the native type. 142 </p> 143 </td> 144</tr> 145<tr> 146<td> 147 <p> 148 <a class="link" href="../local__basic_endpoint/operator_eq_.html" title="local::basic_endpoint::operator="><span class="bold"><strong>operator=</strong></span></a> 149 </p> 150 </td> 151<td> 152 <p> 153 Assign from another endpoint. 154 </p> 155 </td> 156</tr> 157<tr> 158<td> 159 <p> 160 <a class="link" href="../local__basic_endpoint/path.html" title="local::basic_endpoint::path"><span class="bold"><strong>path</strong></span></a> 161 </p> 162 </td> 163<td> 164 <p> 165 Get the path associated with the endpoint. <br> <span class="silver"> —</span><br> Set 166 the path associated with the endpoint. 167 </p> 168 </td> 169</tr> 170<tr> 171<td> 172 <p> 173 <a class="link" href="../local__basic_endpoint/protocol.html" title="local::basic_endpoint::protocol"><span class="bold"><strong>protocol</strong></span></a> 174 </p> 175 </td> 176<td> 177 <p> 178 The protocol associated with the endpoint. 179 </p> 180 </td> 181</tr> 182<tr> 183<td> 184 <p> 185 <a class="link" href="../local__basic_endpoint/resize.html" title="local::basic_endpoint::resize"><span class="bold"><strong>resize</strong></span></a> 186 </p> 187 </td> 188<td> 189 <p> 190 Set the underlying size of the endpoint in the native type. 191 </p> 192 </td> 193</tr> 194<tr> 195<td> 196 <p> 197 <a class="link" href="../local__basic_endpoint/size.html" title="local::basic_endpoint::size"><span class="bold"><strong>size</strong></span></a> 198 </p> 199 </td> 200<td> 201 <p> 202 Get the underlying size of the endpoint in the native type. 203 </p> 204 </td> 205</tr> 206</tbody> 207</table></div> 208<h6> 209<a name="boost_asio.reference.local__stream_protocol.endpoint.h2"></a> 210 <span class="phrase"><a name="boost_asio.reference.local__stream_protocol.endpoint.friends"></a></span><a class="link" href="endpoint.html#boost_asio.reference.local__stream_protocol.endpoint.friends">Friends</a> 211 </h6> 212<div class="informaltable"><table class="table"> 213<colgroup> 214<col> 215<col> 216</colgroup> 217<thead><tr> 218<th> 219 <p> 220 Name 221 </p> 222 </th> 223<th> 224 <p> 225 Description 226 </p> 227 </th> 228</tr></thead> 229<tbody> 230<tr> 231<td> 232 <p> 233 <a class="link" href="../local__basic_endpoint/operator_not__eq_.html" title="local::basic_endpoint::operator!="><span class="bold"><strong>operator!=</strong></span></a> 234 </p> 235 </td> 236<td> 237 <p> 238 Compare two endpoints for inequality. 239 </p> 240 </td> 241</tr> 242<tr> 243<td> 244 <p> 245 <a class="link" href="../local__basic_endpoint/operator_lt_.html" title="local::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="../local__basic_endpoint/operator_lt__eq_.html" title="local::basic_endpoint::operator<="><span class="bold"><strong>operator<=</strong></span></a> 258 </p> 259 </td> 260<td> 261 <p> 262 Compare endpoints for ordering. 263 </p> 264 </td> 265</tr> 266<tr> 267<td> 268 <p> 269 <a class="link" href="../local__basic_endpoint/operator_eq__eq_.html" title="local::basic_endpoint::operator=="><span class="bold"><strong>operator==</strong></span></a> 270 </p> 271 </td> 272<td> 273 <p> 274 Compare two endpoints for equality. 275 </p> 276 </td> 277</tr> 278<tr> 279<td> 280 <p> 281 <a class="link" href="../local__basic_endpoint/operator_gt_.html" title="local::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<tr> 291<td> 292 <p> 293 <a class="link" href="../local__basic_endpoint/operator_gt__eq_.html" title="local::basic_endpoint::operator>="><span class="bold"><strong>operator>=</strong></span></a> 294 </p> 295 </td> 296<td> 297 <p> 298 Compare endpoints for ordering. 299 </p> 300 </td> 301</tr> 302</tbody> 303</table></div> 304<h6> 305<a name="boost_asio.reference.local__stream_protocol.endpoint.h3"></a> 306 <span class="phrase"><a name="boost_asio.reference.local__stream_protocol.endpoint.related_functions"></a></span><a class="link" href="endpoint.html#boost_asio.reference.local__stream_protocol.endpoint.related_functions">Related 307 Functions</a> 308 </h6> 309<div class="informaltable"><table class="table"> 310<colgroup> 311<col> 312<col> 313</colgroup> 314<thead><tr> 315<th> 316 <p> 317 Name 318 </p> 319 </th> 320<th> 321 <p> 322 Description 323 </p> 324 </th> 325</tr></thead> 326<tbody><tr> 327<td> 328 <p> 329 <a class="link" href="../local__basic_endpoint/operator_lt__lt_.html" title="local::basic_endpoint::operator<<"><span class="bold"><strong>operator<<</strong></span></a> 330 </p> 331 </td> 332<td> 333 <p> 334 Output an endpoint as a string. 335 </p> 336 </td> 337</tr></tbody> 338</table></div> 339<p> 340 The <a class="link" href="../local__basic_endpoint.html" title="local::basic_endpoint"><code class="computeroutput">local::basic_endpoint</code></a> 341 class template describes an endpoint that may be associated with a particular 342 UNIX socket. 343 </p> 344<h6> 345<a name="boost_asio.reference.local__stream_protocol.endpoint.h4"></a> 346 <span class="phrase"><a name="boost_asio.reference.local__stream_protocol.endpoint.thread_safety"></a></span><a class="link" href="endpoint.html#boost_asio.reference.local__stream_protocol.endpoint.thread_safety">Thread 347 Safety</a> 348 </h6> 349<p> 350 <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe. 351 </p> 352<p> 353 <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe. 354 </p> 355<h6> 356<a name="boost_asio.reference.local__stream_protocol.endpoint.h5"></a> 357 <span class="phrase"><a name="boost_asio.reference.local__stream_protocol.endpoint.requirements"></a></span><a class="link" href="endpoint.html#boost_asio.reference.local__stream_protocol.endpoint.requirements">Requirements</a> 358 </h6> 359<p> 360 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/local/stream_protocol.hpp</code> 361 </p> 362<p> 363 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> 364 </p> 365</div> 366<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 367<td align="left"></td> 368<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 369 Kohlhoff<p> 370 Distributed under the Boost Software License, Version 1.0. (See accompanying 371 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>) 372 </p> 373</div></td> 374</tr></table> 375<hr> 376<div class="spirit-nav"> 377<a accesskey="p" href="acceptor.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../local__stream_protocol.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> 378</div> 379</body> 380</html> 381
