PageRenderTime 52ms CodeModel.GetById 23ms RepoModel.GetById 0ms app.codeStats 0ms

/doc/html/boost_asio/reference/generic__stream_protocol/endpoint.html

https://gitlab.com/boostdoc-qch/doc
HTML | 344 lines | 344 code | 0 blank | 0 comment | 0 complexity | aa7ea4338b870a295dec3cc3946886c7 MD5 | raw file
    

  1. <html>
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
    4. 

  4. <title>generic::stream_protocol::endpoint</title>
    5. 

  5. <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
    7. 

  7. <link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
    8. 

  8. <link rel="up" href="../generic__stream_protocol.html" title="generic::stream_protocol">
    9. 

  9. <link rel="prev" href="../generic__stream_protocol.html" title="generic::stream_protocol">
    10. 

  10. <link rel="next" href="family.html" title="generic::stream_protocol::family">
    11. 

  11. </head>
    12. 

  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    13. 

  13. <table cellpadding="2" width="100%"><tr>
    14. 

  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
    15. 

  15. <td align="center"><a href="../../../../../index.html">Home</a></td>
    16. 

  16. <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
    17. 

  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
    18. 

  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
    19. 

  19. <td align="center"><a href="../../../../../more/index.htm">More</a></td>
    20. 

  20. </tr></table>
    21. 

  21. <hr>
    22. 

  22. <div class="spirit-nav">
    23. 

  23. <a accesskey="p" href="../generic__stream_protocol.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../generic__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. 

  24. </div>
    25. 

  25. <div class="section">
    26. 

  26. <div class="titlepage"><div><div><h4 class="title">
    27. 

  27. <a name="boost_asio.reference.generic__stream_protocol.endpoint"></a><a class="link" href="endpoint.html" title="generic::stream_protocol::endpoint">generic::stream_protocol::endpoint</a>
    28. 

  28. </h4></div></div></div>
    29. 

  29. <p>
    30. 

  30.           <a class="indexterm" name="idp59900864"></a> 
    31. 

  31. The type of an endpoint.
    32. 

  32.         </p>
    33. 

  33. <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_endpoint</span><span class="special">&lt;</span> <span class="identifier">stream_protocol</span> <span class="special">&gt;</span> <span class="identifier">endpoint</span><span class="special">;</span>
    34. 

  34. </pre>
    35. 

  35. <h6>
    36. 

  36. <a name="boost_asio.reference.generic__stream_protocol.endpoint.h0"></a>
    37. 

  37.           <span class="phrase"><a name="boost_asio.reference.generic__stream_protocol.endpoint.types"></a></span><a class="link" href="endpoint.html#boost_asio.reference.generic__stream_protocol.endpoint.types">Types</a>
    38. 

  38.         </h6>
    39. 

  39. <div class="informaltable"><table class="table">
    40. 

  40. <colgroup>
    41. 

  41. <col>
    42. 

  42. <col>
    43. 

  43. </colgroup>
    44. 

  44. <thead><tr>
    45. 

  45. <th>
    46. 

  46.                   <p>
    47. 

  47.                     Name
    48. 

  48.                   </p>
    49. 

  49.                 </th>
    50. 

  50. <th>
    51. 

  51.                   <p>
    52. 

  52.                     Description
    53. 

  53.                   </p>
    54. 

  54.                 </th>
    55. 

  55. </tr></thead>
    56. 

  56. <tbody>
    57. 

  57. <tr>
    58. 

  58. <td>
    59. 

  59.                   <p>
    60. 

  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. 

  61.                   </p>
    62. 

  62.                 </td>
    63. 

  63. <td>
    64. 

  64.                   <p>
    65. 

  65.                     The type of the endpoint structure. This type is dependent on
    66. 

  66.                     the underlying implementation of the socket layer.
    67. 

  67.                   </p>
    68. 

  68.                 </td>
    69. 

  69. </tr>
    70. 

  70. <tr>
    71. 

  71. <td>
    72. 

  72.                   <p>
    73. 

  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. 

  74.                   </p>
    75. 

  75.                 </td>
    76. 

  76. <td>
    77. 

  77.                   <p>
    78. 

  78.                     The protocol type associated with the endpoint.
    79. 

  79.                   </p>
    80. 

  80.                 </td>
    81. 

  81. </tr>
    82. 

  82. </tbody>
    83. 

  83. </table></div>
    84. 

  84. <h6>
    85. 

  85. <a name="boost_asio.reference.generic__stream_protocol.endpoint.h1"></a>
    86. 

  86.           <span class="phrase"><a name="boost_asio.reference.generic__stream_protocol.endpoint.member_functions"></a></span><a class="link" href="endpoint.html#boost_asio.reference.generic__stream_protocol.endpoint.member_functions">Member
    87. 

  87.           Functions</a>
    88. 

  88.         </h6>
    89. 

  89. <div class="informaltable"><table class="table">
    90. 

  90. <colgroup>
    91. 

  91. <col>
    92. 

  92. <col>
    93. 

  93. </colgroup>
    94. 

  94. <thead><tr>
    95. 

  95. <th>
    96. 

  96.                   <p>
    97. 

  97.                     Name
    98. 

  98.                   </p>
    99. 

  99.                 </th>
    100. 

  100. <th>
    101. 

  101.                   <p>
    102. 

  102.                     Description
    103. 

  103.                   </p>
    104. 

  104.                 </th>
    105. 

  105. </tr></thead>
    106. 

  106. <tbody>
    107. 

  107. <tr>
    108. 

  108. <td>
    109. 

  109.                   <p>
    110. 

  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. 

  111.                   </p>
    112. 

  112.                 </td>
    113. 

  113. <td>
    114. 

  114.                   <p>
    115. 

  115.                     Default constructor.
    116. 

  116.                   </p>
    117. 

  117.                   <p>
    118. 

  118.                     Construct an endpoint from the specified socket address.
    119. 

  119.                   </p>
    120. 

  120.                   <p>
    121. 

  121.                     Construct an endpoint from the specific endpoint type.
    122. 

  122.                   </p>
    123. 

  123.                   <p>
    124. 

  124.                     Copy constructor.
    125. 

  125.                   </p>
    126. 

  126.                 </td>
    127. 

  127. </tr>
    128. 

  128. <tr>
    129. 

  129. <td>
    130. 

  130.                   <p>
    131. 

  131.                     <a class="link" href="../generic__basic_endpoint/capacity.html" title="generic::basic_endpoint::capacity"><span class="bold"><strong>capacity</strong></span></a>
    132. 

  132.                   </p>
    133. 

  133.                 </td>
    134. 

  134. <td>
    135. 

  135.                   <p>
    136. 

  136.                     Get the capacity of the endpoint in the native type.
    137. 

  137.                   </p>
    138. 

  138.                 </td>
    139. 

  139. </tr>
    140. 

  140. <tr>
    141. 

  141. <td>
    142. 

  142.                   <p>
    143. 

  143.                     <a class="link" href="../generic__basic_endpoint/data.html" title="generic::basic_endpoint::data"><span class="bold"><strong>data</strong></span></a>
    144. 

  144.                   </p>
    145. 

  145.                 </td>
    146. 

  146. <td>
    147. 

  147.                   <p>
    148. 

  148.                     Get the underlying endpoint in the native type.
    149. 

  149.                   </p>
    150. 

  150.                 </td>
    151. 

  151. </tr>
    152. 

  152. <tr>
    153. 

  153. <td>
    154. 

  154.                   <p>
    155. 

  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. 

  156.                   </p>
    157. 

  157.                 </td>
    158. 

  158. <td>
    159. 

  159.                   <p>
    160. 

  160.                     Assign from another endpoint.
    161. 

  161.                   </p>
    162. 

  162.                 </td>
    163. 

  163. </tr>
    164. 

  164. <tr>
    165. 

  165. <td>
    166. 

  166.                   <p>
    167. 

  167.                     <a class="link" href="../generic__basic_endpoint/protocol.html" title="generic::basic_endpoint::protocol"><span class="bold"><strong>protocol</strong></span></a>
    168. 

  168.                   </p>
    169. 

  169.                 </td>
    170. 

  170. <td>
    171. 

  171.                   <p>
    172. 

  172.                     The protocol associated with the endpoint.
    173. 

  173.                   </p>
    174. 

  174.                 </td>
    175. 

  175. </tr>
    176. 

  176. <tr>
    177. 

  177. <td>
    178. 

  178.                   <p>
    179. 

  179.                     <a class="link" href="../generic__basic_endpoint/resize.html" title="generic::basic_endpoint::resize"><span class="bold"><strong>resize</strong></span></a>
    180. 

  180.                   </p>
    181. 

  181.                 </td>
    182. 

  182. <td>
    183. 

  183.                   <p>
    184. 

  184.                     Set the underlying size of the endpoint in the native type.
    185. 

  185.                   </p>
    186. 

  186.                 </td>
    187. 

  187. </tr>
    188. 

  188. <tr>
    189. 

  189. <td>
    190. 

  190.                   <p>
    191. 

  191.                     <a class="link" href="../generic__basic_endpoint/size.html" title="generic::basic_endpoint::size"><span class="bold"><strong>size</strong></span></a>
    192. 

  192.                   </p>
    193. 

  193.                 </td>
    194. 

  194. <td>
    195. 

  195.                   <p>
    196. 

  196.                     Get the underlying size of the endpoint in the native type.
    197. 

  197.                   </p>
    198. 

  198.                 </td>
    199. 

  199. </tr>
    200. 

  200. </tbody>
    201. 

  201. </table></div>
    202. 

  202. <h6>
    203. 

  203. <a name="boost_asio.reference.generic__stream_protocol.endpoint.h2"></a>
    204. 

  204.           <span class="phrase"><a name="boost_asio.reference.generic__stream_protocol.endpoint.friends"></a></span><a class="link" href="endpoint.html#boost_asio.reference.generic__stream_protocol.endpoint.friends">Friends</a>
    205. 

  205.         </h6>
    206. 

  206. <div class="informaltable"><table class="table">
    207. 

  207. <colgroup>
    208. 

  208. <col>
    209. 

  209. <col>
    210. 

  210. </colgroup>
    211. 

  211. <thead><tr>
    212. 

  212. <th>
    213. 

  213.                   <p>
    214. 

  214.                     Name
    215. 

  215.                   </p>
    216. 

  216.                 </th>
    217. 

  217. <th>
    218. 

  218.                   <p>
    219. 

  219.                     Description
    220. 

  220.                   </p>
    221. 

  221.                 </th>
    222. 

  222. </tr></thead>
    223. 

  223. <tbody>
    224. 

  224. <tr>
    225. 

  225. <td>
    226. 

  226.                   <p>
    227. 

  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. 

  228.                   </p>
    229. 

  229.                 </td>
    230. 

  230. <td>
    231. 

  231.                   <p>
    232. 

  232.                     Compare two endpoints for inequality.
    233. 

  233.                   </p>
    234. 

  234.                 </td>
    235. 

  235. </tr>
    236. 

  236. <tr>
    237. 

  237. <td>
    238. 

  238.                   <p>
    239. 

  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. 

  240.                   </p>
    241. 

  241.                 </td>
    242. 

  242. <td>
    243. 

  243.                   <p>
    244. 

  244.                     Compare endpoints for ordering.
    245. 

  245.                   </p>
    246. 

  246.                 </td>
    247. 

  247. </tr>
    248. 

  248. <tr>
    249. 

  249. <td>
    250. 

  250.                   <p>
    251. 

  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. 

  252.                   </p>
    253. 

  253.                 </td>
    254. 

  254. <td>
    255. 

  255.                   <p>
    256. 

  256.                     Compare endpoints for ordering.
    257. 

  257.                   </p>
    258. 

  258.                 </td>
    259. 

  259. </tr>
    260. 

  260. <tr>
    261. 

  261. <td>
    262. 

  262.                   <p>
    263. 

  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. 

  264.                   </p>
    265. 

  265.                 </td>
    266. 

  266. <td>
    267. 

  267.                   <p>
    268. 

  268.                     Compare two endpoints for equality.
    269. 

  269.                   </p>
    270. 

  270.                 </td>
    271. 

  271. </tr>
    272. 

  272. <tr>
    273. 

  273. <td>
    274. 

  274.                   <p>
    275. 

  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. 

  276.                   </p>
    277. 

  277.                 </td>
    278. 

  278. <td>
    279. 

  279.                   <p>
    280. 

  280.                     Compare endpoints for ordering.
    281. 

  281.                   </p>
    282. 

  282.                 </td>
    283. 

  283. </tr>
    284. 

  284. <tr>
    285. 

  285. <td>
    286. 

  286.                   <p>
    287. 

  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. 

  288.                   </p>
    289. 

  289.                 </td>
    290. 

  290. <td>
    291. 

  291.                   <p>
    292. 

  292.                     Compare endpoints for ordering.
    293. 

  293.                   </p>
    294. 

  294.                 </td>
    295. 

  295. </tr>
    296. 

  296. </tbody>
    297. 

  297. </table></div>
    298. 

  298. <p>
    299. 

  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. 

  300.           describes an endpoint that may be associated with any socket type.
    301. 

  301.         </p>
    302. 

  302. <h6>
    303. 

  303. <a name="boost_asio.reference.generic__stream_protocol.endpoint.h3"></a>
    304. 

  304.           <span class="phrase"><a name="boost_asio.reference.generic__stream_protocol.endpoint.remarks"></a></span><a class="link" href="endpoint.html#boost_asio.reference.generic__stream_protocol.endpoint.remarks">Remarks</a>
    305. 

  305.         </h6>
    306. 

  306. <p>
    307. 

  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. 

  308.         </p>
    309. 

  309. <h6>
    310. 

  310. <a name="boost_asio.reference.generic__stream_protocol.endpoint.h4"></a>
    311. 

  311.           <span class="phrase"><a name="boost_asio.reference.generic__stream_protocol.endpoint.thread_safety"></a></span><a class="link" href="endpoint.html#boost_asio.reference.generic__stream_protocol.endpoint.thread_safety">Thread
    312. 

  312.           Safety</a>
    313. 

  313.         </h6>
    314. 

  314. <p>
    315. 

  315.           <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
    316. 

  316.         </p>
    317. 

  317. <p>
    318. 

  318.           <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
    319. 

  319.         </p>
    320. 

  320. <h6>
    321. 

  321. <a name="boost_asio.reference.generic__stream_protocol.endpoint.h5"></a>
    322. 

  322.           <span class="phrase"><a name="boost_asio.reference.generic__stream_protocol.endpoint.requirements"></a></span><a class="link" href="endpoint.html#boost_asio.reference.generic__stream_protocol.endpoint.requirements">Requirements</a>
    323. 

  323.         </h6>
    324. 

  324. <p>
    325. 

  325.           <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/generic/stream_protocol.hpp</code>
    326. 

  326.         </p>
    327. 

  327. <p>
    328. 

  328.           <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
    329. 

  329.         </p>
    330. 

  330. </div>
    331. 

  331. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    332. 

  332. <td align="left"></td>
    333. 

  333. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2013 Christopher M. Kohlhoff<p>
    334. 

  334.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    335. 

  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. 

  336.       </p>
    337. 

  337. </div></td>
    338. 

  338. </tr></table>
    339. 

  339. <hr>
    340. 

  340. <div class="spirit-nav">
    341. 

  341. <a accesskey="p" href="../generic__stream_protocol.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../generic__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>
    342. 

  342. </div>
    343. 

  343. </body>
    344. 

  344. </html>
    345. 

  345.