doc/html/boost_asio/reference/generic__raw_protocol/endpoint.html

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