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

/source/doc/html/boost_asio/reference/generic__datagram_protocol/endpoint.html

https://bitbucket.org/liflg/library-boost
HTML | 340 lines | 340 code | 0 blank | 0 comment | 0 complexity | 5da4da6d67774027e0453f495855fa00 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::datagram_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.79.1">
    7. 

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

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

  9. <link rel="prev" href="datagram_protocol/overload2.html" title="generic::datagram_protocol::datagram_protocol (2 of 2 overloads)">
    10. 

  10. <link rel="next" href="family.html" title="generic::datagram_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="datagram_protocol/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../generic__datagram_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__datagram_protocol.endpoint"></a><a class="link" href="endpoint.html" title="generic::datagram_protocol::endpoint">generic::datagram_protocol::endpoint</a>
    28. 

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

  29. <p>
    30. 

  30.           <a class="indexterm" name="boost_asio.indexterm.generic__datagram_protocol.endpoint"></a> 
    31. 

  31. The
    32. 

  32.           type of an endpoint.
    33. 

  33.         </p>
    34. 

  34. <pre class="programlisting">typedef basic_endpoint&lt; datagram_protocol &gt; endpoint;
    35. 

  35. </pre>
    36. 

  36. <h6>
    37. 

  37. <a name="boost_asio.reference.generic__datagram_protocol.endpoint.h0"></a>
    38. 

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

  39.         </h6>
    40. 

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

  41. <colgroup>
    42. 

  42. <col>
    43. 

  43. <col>
    44. 

  44. </colgroup>
    45. 

  45. <thead><tr>
    46. 

  46. <th>
    47. 

  47.                   <p>
    48. 

  48.                     Name
    49. 

  49.                   </p>
    50. 

  50.                 </th>
    51. 

  51. <th>
    52. 

  52.                   <p>
    53. 

  53.                     Description
    54. 

  54.                   </p>
    55. 

  55.                 </th>
    56. 

  56. </tr></thead>
    57. 

  57. <tbody>
    58. 

  58. <tr>
    59. 

  59. <td>
    60. 

  60.                   <p>
    61. 

  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. 

  62.                   </p>
    63. 

  63.                 </td>
    64. 

  64. <td>
    65. 

  65.                   <p>
    66. 

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

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

  68.                   </p>
    69. 

  69.                 </td>
    70. 

  70. </tr>
    71. 

  71. <tr>
    72. 

  72. <td>
    73. 

  73.                   <p>
    74. 

  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. 

  75.                   </p>
    76. 

  76.                 </td>
    77. 

  77. <td>
    78. 

  78.                   <p>
    79. 

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

  80.                   </p>
    81. 

  81.                 </td>
    82. 

  82. </tr>
    83. 

  83. </tbody>
    84. 

  84. </table></div>
    85. 

  85. <h6>
    86. 

  86. <a name="boost_asio.reference.generic__datagram_protocol.endpoint.h1"></a>
    87. 

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

  88.           Functions</a>
    89. 

  89.         </h6>
    90. 

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

  91. <colgroup>
    92. 

  92. <col>
    93. 

  93. <col>
    94. 

  94. </colgroup>
    95. 

  95. <thead><tr>
    96. 

  96. <th>
    97. 

  97.                   <p>
    98. 

  98.                     Name
    99. 

  99.                   </p>
    100. 

  100.                 </th>
    101. 

  101. <th>
    102. 

  102.                   <p>
    103. 

  103.                     Description
    104. 

  104.                   </p>
    105. 

  105.                 </th>
    106. 

  106. </tr></thead>
    107. 

  107. <tbody>
    108. 

  108. <tr>
    109. 

  109. <td>
    110. 

  110.                   <p>
    111. 

  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>
    112. 

  112.                   </p>
    113. 

  113.                 </td>
    114. 

  114. <td>
    115. 

  115.                   <p>
    116. 

  116.                     Default constructor. <br> <span class="silver"> &#8212;</span><br> Construct an endpoint from
    117. 

  117.                     the specified socket address. <br> <span class="silver"> &#8212;</span><br> Construct an endpoint
    118. 

  118.                     from the specific endpoint type. <br> <span class="silver"> &#8212;</span><br> Copy constructor.
    119. 

  119.                   </p>
    120. 

  120.                 </td>
    121. 

  121. </tr>
    122. 

  122. <tr>
    123. 

  123. <td>
    124. 

  124.                   <p>
    125. 

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

  126.                   </p>
    127. 

  127.                 </td>
    128. 

  128. <td>
    129. 

  129.                   <p>
    130. 

  130.                     Get the capacity of the endpoint in the native type.
    131. 

  131.                   </p>
    132. 

  132.                 </td>
    133. 

  133. </tr>
    134. 

  134. <tr>
    135. 

  135. <td>
    136. 

  136.                   <p>
    137. 

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

  138.                   </p>
    139. 

  139.                 </td>
    140. 

  140. <td>
    141. 

  141.                   <p>
    142. 

  142.                     Get the underlying endpoint in the native type.
    143. 

  143.                   </p>
    144. 

  144.                 </td>
    145. 

  145. </tr>
    146. 

  146. <tr>
    147. 

  147. <td>
    148. 

  148.                   <p>
    149. 

  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. 

  150.                   </p>
    151. 

  151.                 </td>
    152. 

  152. <td>
    153. 

  153.                   <p>
    154. 

  154.                     Assign from another endpoint.
    155. 

  155.                   </p>
    156. 

  156.                 </td>
    157. 

  157. </tr>
    158. 

  158. <tr>
    159. 

  159. <td>
    160. 

  160.                   <p>
    161. 

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

  162.                   </p>
    163. 

  163.                 </td>
    164. 

  164. <td>
    165. 

  165.                   <p>
    166. 

  166.                     The protocol associated with the endpoint.
    167. 

  167.                   </p>
    168. 

  168.                 </td>
    169. 

  169. </tr>
    170. 

  170. <tr>
    171. 

  171. <td>
    172. 

  172.                   <p>
    173. 

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

  174.                   </p>
    175. 

  175.                 </td>
    176. 

  176. <td>
    177. 

  177.                   <p>
    178. 

  178.                     Set the underlying size of the endpoint in the native type.
    179. 

  179.                   </p>
    180. 

  180.                 </td>
    181. 

  181. </tr>
    182. 

  182. <tr>
    183. 

  183. <td>
    184. 

  184.                   <p>
    185. 

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

  186.                   </p>
    187. 

  187.                 </td>
    188. 

  188. <td>
    189. 

  189.                   <p>
    190. 

  190.                     Get the underlying size of the endpoint in the native type.
    191. 

  191.                   </p>
    192. 

  192.                 </td>
    193. 

  193. </tr>
    194. 

  194. </tbody>
    195. 

  195. </table></div>
    196. 

  196. <h6>
    197. 

  197. <a name="boost_asio.reference.generic__datagram_protocol.endpoint.h2"></a>
    198. 

  198.           <span class="phrase"><a name="boost_asio.reference.generic__datagram_protocol.endpoint.friends"></a></span><a class="link" href="endpoint.html#boost_asio.reference.generic__datagram_protocol.endpoint.friends">Friends</a>
    199. 

  199.         </h6>
    200. 

  200. <div class="informaltable"><table class="table">
    201. 

  201. <colgroup>
    202. 

  202. <col>
    203. 

  203. <col>
    204. 

  204. </colgroup>
    205. 

  205. <thead><tr>
    206. 

  206. <th>
    207. 

  207.                   <p>
    208. 

  208.                     Name
    209. 

  209.                   </p>
    210. 

  210.                 </th>
    211. 

  211. <th>
    212. 

  212.                   <p>
    213. 

  213.                     Description
    214. 

  214.                   </p>
    215. 

  215.                 </th>
    216. 

  216. </tr></thead>
    217. 

  217. <tbody>
    218. 

  218. <tr>
    219. 

  219. <td>
    220. 

  220.                   <p>
    221. 

  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. 

  222.                   </p>
    223. 

  223.                 </td>
    224. 

  224. <td>
    225. 

  225.                   <p>
    226. 

  226.                     Compare two endpoints for inequality.
    227. 

  227.                   </p>
    228. 

  228.                 </td>
    229. 

  229. </tr>
    230. 

  230. <tr>
    231. 

  231. <td>
    232. 

  232.                   <p>
    233. 

  233.                     <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>
    234. 

  234.                   </p>
    235. 

  235.                 </td>
    236. 

  236. <td>
    237. 

  237.                   <p>
    238. 

  238.                     Compare endpoints for ordering.
    239. 

  239.                   </p>
    240. 

  240.                 </td>
    241. 

  241. </tr>
    242. 

  242. <tr>
    243. 

  243. <td>
    244. 

  244.                   <p>
    245. 

  245.                     <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>
    246. 

  246.                   </p>
    247. 

  247.                 </td>
    248. 

  248. <td>
    249. 

  249.                   <p>
    250. 

  250.                     Compare endpoints for ordering.
    251. 

  251.                   </p>
    252. 

  252.                 </td>
    253. 

  253. </tr>
    254. 

  254. <tr>
    255. 

  255. <td>
    256. 

  256.                   <p>
    257. 

  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. 

  258.                   </p>
    259. 

  259.                 </td>
    260. 

  260. <td>
    261. 

  261.                   <p>
    262. 

  262.                     Compare two endpoints for equality.
    263. 

  263.                   </p>
    264. 

  264.                 </td>
    265. 

  265. </tr>
    266. 

  266. <tr>
    267. 

  267. <td>
    268. 

  268.                   <p>
    269. 

  269.                     <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>
    270. 

  270.                   </p>
    271. 

  271.                 </td>
    272. 

  272. <td>
    273. 

  273.                   <p>
    274. 

  274.                     Compare endpoints for ordering.
    275. 

  275.                   </p>
    276. 

  276.                 </td>
    277. 

  277. </tr>
    278. 

  278. <tr>
    279. 

  279. <td>
    280. 

  280.                   <p>
    281. 

  281.                     <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>
    282. 

  282.                   </p>
    283. 

  283.                 </td>
    284. 

  284. <td>
    285. 

  285.                   <p>
    286. 

  286.                     Compare endpoints for ordering.
    287. 

  287.                   </p>
    288. 

  288.                 </td>
    289. 

  289. </tr>
    290. 

  290. </tbody>
    291. 

  291. </table></div>
    292. 

  292. <p>
    293. 

  293.           The <a class="link" href="../generic__basic_endpoint.html" title="generic::basic_endpoint"><code class="computeroutput">generic::basic_endpoint</code></a>
    294. 

  294.           class template describes an endpoint that may be associated with any socket
    295. 

  295.           type.
    296. 

  296.         </p>
    297. 

  297. <h6>
    298. 

  298. <a name="boost_asio.reference.generic__datagram_protocol.endpoint.h3"></a>
    299. 

  299.           <span class="phrase"><a name="boost_asio.reference.generic__datagram_protocol.endpoint.remarks"></a></span><a class="link" href="endpoint.html#boost_asio.reference.generic__datagram_protocol.endpoint.remarks">Remarks</a>
    300. 

  300.         </h6>
    301. 

  301. <p>
    302. 

  302.           The socket types sockaddr type must be able to fit into a <code class="computeroutput">sockaddr_storage</code>
    303. 

  303.           structure.
    304. 

  304.         </p>
    305. 

  305. <h6>
    306. 

  306. <a name="boost_asio.reference.generic__datagram_protocol.endpoint.h4"></a>
    307. 

  307.           <span class="phrase"><a name="boost_asio.reference.generic__datagram_protocol.endpoint.thread_safety"></a></span><a class="link" href="endpoint.html#boost_asio.reference.generic__datagram_protocol.endpoint.thread_safety">Thread
    308. 

  308.           Safety</a>
    309. 

  309.         </h6>
    310. 

  310. <p>
    311. 

  311.           <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
    312. 

  312.         </p>
    313. 

  313. <p>
    314. 

  314.           <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
    315. 

  315.         </p>
    316. 

  316. <h6>
    317. 

  317. <a name="boost_asio.reference.generic__datagram_protocol.endpoint.h5"></a>
    318. 

  318.           <span class="phrase"><a name="boost_asio.reference.generic__datagram_protocol.endpoint.requirements"></a></span><a class="link" href="endpoint.html#boost_asio.reference.generic__datagram_protocol.endpoint.requirements">Requirements</a>
    319. 

  319.         </h6>
    320. 

  320. <p>
    321. 

  321.           <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/generic/datagram_protocol.hpp</code>
    322. 

  322.         </p>
    323. 

  323. <p>
    324. 

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

  325.         </p>
    326. 

  326. </div>
    327. 

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

  328. <td align="left"></td>
    329. 

  329. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2018 Christopher M. Kohlhoff<p>
    330. 

  330.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    331. 

  331.         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>)
    332. 

  332.       </p>
    333. 

  333. </div></td>
    334. 

  334. </tr></table>
    335. 

  335. <hr>
    336. 

  336. <div class="spirit-nav">
    337. 

  337. <a accesskey="p" href="datagram_protocol/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../generic__datagram_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>
    338. 

  338. </div>
    339. 

  339. </body>
    340. 

  340. </html>
    341. 

  341.