PageRenderTime 56ms CodeModel.GetById 24ms RepoModel.GetById 0ms app.codeStats 0ms

/doc/html/boost_asio/reference/generic__seq_packet_protocol/socket.html

https://bitbucket.org/bosp/external-boost
HTML | 910 lines | 910 code | 0 blank | 0 comment | 0 complexity | cf0367a96f847abd309993c175c45fce MD5 | raw file
Possible License(s): MIT 
    

  1. <html>
    2. 

  2. <head>
    3. 

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

  4. <title>generic::seq_packet_protocol::socket</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__seq_packet_protocol.html" title="generic::seq_packet_protocol">
    9. 

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

  10. <link rel="next" href="type.html" title="generic::seq_packet_protocol::type">
    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="seq_packet_protocol/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../generic__seq_packet_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="type.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__seq_packet_protocol.socket"></a><a class="link" href="socket.html" title="generic::seq_packet_protocol::socket">generic::seq_packet_protocol::socket</a>
    28. 

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

  29. <p>
    30. 

  30.           <a class="indexterm" name="boost_asio.indexterm.generic__seq_packet_protocol.socket"></a> 
    31. 

  31. The
    32. 

  32.           generic socket type.
    33. 

  33.         </p>
    34. 

  34. <pre class="programlisting">typedef basic_seq_packet_socket&lt; seq_packet_protocol &gt; socket;
    35. 

  35. </pre>
    36. 

  36. <h6>
    37. 

  37. <a name="boost_asio.reference.generic__seq_packet_protocol.socket.h0"></a>
    38. 

  38.           <span class="phrase"><a name="boost_asio.reference.generic__seq_packet_protocol.socket.types"></a></span><a class="link" href="socket.html#boost_asio.reference.generic__seq_packet_protocol.socket.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="../basic_seq_packet_socket__rebind_executor.html" title="basic_seq_packet_socket::rebind_executor"><span class="bold"><strong>rebind_executor</strong></span></a>
    62. 

  62.                   </p>
    63. 

  63.                 </td>
    64. 

  64. <td>
    65. 

  65.                   <p>
    66. 

  66.                     Rebinds the socket type to another executor.
    67. 

  67.                   </p>
    68. 

  68.                 </td>
    69. 

  69. </tr>
    70. 

  70. <tr>
    71. 

  71. <td>
    72. 

  72.                   <p>
    73. 

  73.                     <a class="link" href="../basic_seq_packet_socket/broadcast.html" title="basic_seq_packet_socket::broadcast"><span class="bold"><strong>broadcast</strong></span></a>
    74. 

  74.                   </p>
    75. 

  75.                 </td>
    76. 

  76. <td>
    77. 

  77.                   <p>
    78. 

  78.                     Socket option to permit sending of broadcast messages.
    79. 

  79.                   </p>
    80. 

  80.                 </td>
    81. 

  81. </tr>
    82. 

  82. <tr>
    83. 

  83. <td>
    84. 

  84.                   <p>
    85. 

  85.                     <a class="link" href="../basic_seq_packet_socket/bytes_readable.html" title="basic_seq_packet_socket::bytes_readable"><span class="bold"><strong>bytes_readable</strong></span></a>
    86. 

  86.                   </p>
    87. 

  87.                 </td>
    88. 

  88. <td>
    89. 

  89.                   <p>
    90. 

  90.                     IO control command to get the amount of data that can be read
    91. 

  91.                     without blocking.
    92. 

  92.                   </p>
    93. 

  93.                 </td>
    94. 

  94. </tr>
    95. 

  95. <tr>
    96. 

  96. <td>
    97. 

  97.                   <p>
    98. 

  98.                     <a class="link" href="../basic_seq_packet_socket/debug.html" title="basic_seq_packet_socket::debug"><span class="bold"><strong>debug</strong></span></a>
    99. 

  99.                   </p>
    100. 

  100.                 </td>
    101. 

  101. <td>
    102. 

  102.                   <p>
    103. 

  103.                     Socket option to enable socket-level debugging.
    104. 

  104.                   </p>
    105. 

  105.                 </td>
    106. 

  106. </tr>
    107. 

  107. <tr>
    108. 

  108. <td>
    109. 

  109.                   <p>
    110. 

  110.                     <a class="link" href="../basic_seq_packet_socket/do_not_route.html" title="basic_seq_packet_socket::do_not_route"><span class="bold"><strong>do_not_route</strong></span></a>
    111. 

  111.                   </p>
    112. 

  112.                 </td>
    113. 

  113. <td>
    114. 

  114.                   <p>
    115. 

  115.                     Socket option to prevent routing, use local interfaces only.
    116. 

  116.                   </p>
    117. 

  117.                 </td>
    118. 

  118. </tr>
    119. 

  119. <tr>
    120. 

  120. <td>
    121. 

  121.                   <p>
    122. 

  122.                     <a class="link" href="../basic_seq_packet_socket/enable_connection_aborted.html" title="basic_seq_packet_socket::enable_connection_aborted"><span class="bold"><strong>enable_connection_aborted</strong></span></a>
    123. 

  123.                   </p>
    124. 

  124.                 </td>
    125. 

  125. <td>
    126. 

  126.                   <p>
    127. 

  127.                     Socket option to report aborted connections on accept.
    128. 

  128.                   </p>
    129. 

  129.                 </td>
    130. 

  130. </tr>
    131. 

  131. <tr>
    132. 

  132. <td>
    133. 

  133.                   <p>
    134. 

  134.                     <a class="link" href="../basic_seq_packet_socket/endpoint_type.html" title="basic_seq_packet_socket::endpoint_type"><span class="bold"><strong>endpoint_type</strong></span></a>
    135. 

  135.                   </p>
    136. 

  136.                 </td>
    137. 

  137. <td>
    138. 

  138.                   <p>
    139. 

  139.                     The endpoint type.
    140. 

  140.                   </p>
    141. 

  141.                 </td>
    142. 

  142. </tr>
    143. 

  143. <tr>
    144. 

  144. <td>
    145. 

  145.                   <p>
    146. 

  146.                     <a class="link" href="../basic_seq_packet_socket/executor_type.html" title="basic_seq_packet_socket::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
    147. 

  147.                   </p>
    148. 

  148.                 </td>
    149. 

  149. <td>
    150. 

  150.                   <p>
    151. 

  151.                     The type of the executor associated with the object.
    152. 

  152.                   </p>
    153. 

  153.                 </td>
    154. 

  154. </tr>
    155. 

  155. <tr>
    156. 

  156. <td>
    157. 

  157.                   <p>
    158. 

  158.                     <a class="link" href="../basic_seq_packet_socket/keep_alive.html" title="basic_seq_packet_socket::keep_alive"><span class="bold"><strong>keep_alive</strong></span></a>
    159. 

  159.                   </p>
    160. 

  160.                 </td>
    161. 

  161. <td>
    162. 

  162.                   <p>
    163. 

  163.                     Socket option to send keep-alives.
    164. 

  164.                   </p>
    165. 

  165.                 </td>
    166. 

  166. </tr>
    167. 

  167. <tr>
    168. 

  168. <td>
    169. 

  169.                   <p>
    170. 

  170.                     <a class="link" href="../basic_seq_packet_socket/linger.html" title="basic_seq_packet_socket::linger"><span class="bold"><strong>linger</strong></span></a>
    171. 

  171.                   </p>
    172. 

  172.                 </td>
    173. 

  173. <td>
    174. 

  174.                   <p>
    175. 

  175.                     Socket option to specify whether the socket lingers on close
    176. 

  176.                     if unsent data is present.
    177. 

  177.                   </p>
    178. 

  178.                 </td>
    179. 

  179. </tr>
    180. 

  180. <tr>
    181. 

  181. <td>
    182. 

  182.                   <p>
    183. 

  183.                     <a class="link" href="../basic_seq_packet_socket/lowest_layer_type.html" title="basic_seq_packet_socket::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a>
    184. 

  184.                   </p>
    185. 

  185.                 </td>
    186. 

  186. <td>
    187. 

  187.                   <p>
    188. 

  188.                     A basic_socket is always the lowest layer.
    189. 

  189.                   </p>
    190. 

  190.                 </td>
    191. 

  191. </tr>
    192. 

  192. <tr>
    193. 

  193. <td>
    194. 

  194.                   <p>
    195. 

  195.                     <a class="link" href="../basic_seq_packet_socket/message_flags.html" title="basic_seq_packet_socket::message_flags"><span class="bold"><strong>message_flags</strong></span></a>
    196. 

  196.                   </p>
    197. 

  197.                 </td>
    198. 

  198. <td>
    199. 

  199.                   <p>
    200. 

  200.                     Bitmask type for flags that can be passed to send and receive
    201. 

  201.                     operations.
    202. 

  202.                   </p>
    203. 

  203.                 </td>
    204. 

  204. </tr>
    205. 

  205. <tr>
    206. 

  206. <td>
    207. 

  207.                   <p>
    208. 

  208.                     <a class="link" href="../basic_seq_packet_socket/native_handle_type.html" title="basic_seq_packet_socket::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a>
    209. 

  209.                   </p>
    210. 

  210.                 </td>
    211. 

  211. <td>
    212. 

  212.                   <p>
    213. 

  213.                     The native representation of a socket.
    214. 

  214.                   </p>
    215. 

  215.                 </td>
    216. 

  216. </tr>
    217. 

  217. <tr>
    218. 

  218. <td>
    219. 

  219.                   <p>
    220. 

  220.                     <a class="link" href="../basic_seq_packet_socket/out_of_band_inline.html" title="basic_seq_packet_socket::out_of_band_inline"><span class="bold"><strong>out_of_band_inline</strong></span></a>
    221. 

  221.                   </p>
    222. 

  222.                 </td>
    223. 

  223. <td>
    224. 

  224.                   <p>
    225. 

  225.                     Socket option for putting received out-of-band data inline.
    226. 

  226.                   </p>
    227. 

  227.                 </td>
    228. 

  228. </tr>
    229. 

  229. <tr>
    230. 

  230. <td>
    231. 

  231.                   <p>
    232. 

  232.                     <a class="link" href="../basic_seq_packet_socket/protocol_type.html" title="basic_seq_packet_socket::protocol_type"><span class="bold"><strong>protocol_type</strong></span></a>
    233. 

  233.                   </p>
    234. 

  234.                 </td>
    235. 

  235. <td>
    236. 

  236.                   <p>
    237. 

  237.                     The protocol type.
    238. 

  238.                   </p>
    239. 

  239.                 </td>
    240. 

  240. </tr>
    241. 

  241. <tr>
    242. 

  242. <td>
    243. 

  243.                   <p>
    244. 

  244.                     <a class="link" href="../basic_seq_packet_socket/receive_buffer_size.html" title="basic_seq_packet_socket::receive_buffer_size"><span class="bold"><strong>receive_buffer_size</strong></span></a>
    245. 

  245.                   </p>
    246. 

  246.                 </td>
    247. 

  247. <td>
    248. 

  248.                   <p>
    249. 

  249.                     Socket option for the receive buffer size of a socket.
    250. 

  250.                   </p>
    251. 

  251.                 </td>
    252. 

  252. </tr>
    253. 

  253. <tr>
    254. 

  254. <td>
    255. 

  255.                   <p>
    256. 

  256.                     <a class="link" href="../basic_seq_packet_socket/receive_low_watermark.html" title="basic_seq_packet_socket::receive_low_watermark"><span class="bold"><strong>receive_low_watermark</strong></span></a>
    257. 

  257.                   </p>
    258. 

  258.                 </td>
    259. 

  259. <td>
    260. 

  260.                   <p>
    261. 

  261.                     Socket option for the receive low watermark.
    262. 

  262.                   </p>
    263. 

  263.                 </td>
    264. 

  264. </tr>
    265. 

  265. <tr>
    266. 

  266. <td>
    267. 

  267.                   <p>
    268. 

  268.                     <a class="link" href="../basic_seq_packet_socket/reuse_address.html" title="basic_seq_packet_socket::reuse_address"><span class="bold"><strong>reuse_address</strong></span></a>
    269. 

  269.                   </p>
    270. 

  270.                 </td>
    271. 

  271. <td>
    272. 

  272.                   <p>
    273. 

  273.                     Socket option to allow the socket to be bound to an address that
    274. 

  274.                     is already in use.
    275. 

  275.                   </p>
    276. 

  276.                 </td>
    277. 

  277. </tr>
    278. 

  278. <tr>
    279. 

  279. <td>
    280. 

  280.                   <p>
    281. 

  281.                     <a class="link" href="../basic_seq_packet_socket/send_buffer_size.html" title="basic_seq_packet_socket::send_buffer_size"><span class="bold"><strong>send_buffer_size</strong></span></a>
    282. 

  282.                   </p>
    283. 

  283.                 </td>
    284. 

  284. <td>
    285. 

  285.                   <p>
    286. 

  286.                     Socket option for the send buffer size of a socket.
    287. 

  287.                   </p>
    288. 

  288.                 </td>
    289. 

  289. </tr>
    290. 

  290. <tr>
    291. 

  291. <td>
    292. 

  292.                   <p>
    293. 

  293.                     <a class="link" href="../basic_seq_packet_socket/send_low_watermark.html" title="basic_seq_packet_socket::send_low_watermark"><span class="bold"><strong>send_low_watermark</strong></span></a>
    294. 

  294.                   </p>
    295. 

  295.                 </td>
    296. 

  296. <td>
    297. 

  297.                   <p>
    298. 

  298.                     Socket option for the send low watermark.
    299. 

  299.                   </p>
    300. 

  300.                 </td>
    301. 

  301. </tr>
    302. 

  302. <tr>
    303. 

  303. <td>
    304. 

  304.                   <p>
    305. 

  305.                     <a class="link" href="../basic_seq_packet_socket/shutdown_type.html" title="basic_seq_packet_socket::shutdown_type"><span class="bold"><strong>shutdown_type</strong></span></a>
    306. 

  306.                   </p>
    307. 

  307.                 </td>
    308. 

  308. <td>
    309. 

  309.                   <p>
    310. 

  310.                     Different ways a socket may be shutdown.
    311. 

  311.                   </p>
    312. 

  312.                 </td>
    313. 

  313. </tr>
    314. 

  314. <tr>
    315. 

  315. <td>
    316. 

  316.                   <p>
    317. 

  317.                     <a class="link" href="../basic_seq_packet_socket/wait_type.html" title="basic_seq_packet_socket::wait_type"><span class="bold"><strong>wait_type</strong></span></a>
    318. 

  318.                   </p>
    319. 

  319.                 </td>
    320. 

  320. <td>
    321. 

  321.                   <p>
    322. 

  322.                     Wait types.
    323. 

  323.                   </p>
    324. 

  324.                 </td>
    325. 

  325. </tr>
    326. 

  326. </tbody>
    327. 

  327. </table></div>
    328. 

  328. <h6>
    329. 

  329. <a name="boost_asio.reference.generic__seq_packet_protocol.socket.h1"></a>
    330. 

  330.           <span class="phrase"><a name="boost_asio.reference.generic__seq_packet_protocol.socket.member_functions"></a></span><a class="link" href="socket.html#boost_asio.reference.generic__seq_packet_protocol.socket.member_functions">Member
    331. 

  331.           Functions</a>
    332. 

  332.         </h6>
    333. 

  333. <div class="informaltable"><table class="table">
    334. 

  334. <colgroup>
    335. 

  335. <col>
    336. 

  336. <col>
    337. 

  337. </colgroup>
    338. 

  338. <thead><tr>
    339. 

  339. <th>
    340. 

  340.                   <p>
    341. 

  341.                     Name
    342. 

  342.                   </p>
    343. 

  343.                 </th>
    344. 

  344. <th>
    345. 

  345.                   <p>
    346. 

  346.                     Description
    347. 

  347.                   </p>
    348. 

  348.                 </th>
    349. 

  349. </tr></thead>
    350. 

  350. <tbody>
    351. 

  351. <tr>
    352. 

  352. <td>
    353. 

  353.                   <p>
    354. 

  354.                     <a class="link" href="../basic_seq_packet_socket/assign.html" title="basic_seq_packet_socket::assign"><span class="bold"><strong>assign</strong></span></a>
    355. 

  355.                   </p>
    356. 

  356.                 </td>
    357. 

  357. <td>
    358. 

  358.                   <p>
    359. 

  359.                     Assign an existing native socket to the socket.
    360. 

  360.                   </p>
    361. 

  361.                 </td>
    362. 

  362. </tr>
    363. 

  363. <tr>
    364. 

  364. <td>
    365. 

  365.                   <p>
    366. 

  366.                     <a class="link" href="../basic_seq_packet_socket/async_connect.html" title="basic_seq_packet_socket::async_connect"><span class="bold"><strong>async_connect</strong></span></a>
    367. 

  367.                   </p>
    368. 

  368.                 </td>
    369. 

  369. <td>
    370. 

  370.                   <p>
    371. 

  371.                     Start an asynchronous connect.
    372. 

  372.                   </p>
    373. 

  373.                 </td>
    374. 

  374. </tr>
    375. 

  375. <tr>
    376. 

  376. <td>
    377. 

  377.                   <p>
    378. 

  378.                     <a class="link" href="../basic_seq_packet_socket/async_receive.html" title="basic_seq_packet_socket::async_receive"><span class="bold"><strong>async_receive</strong></span></a>
    379. 

  379.                   </p>
    380. 

  380.                 </td>
    381. 

  381. <td>
    382. 

  382.                   <p>
    383. 

  383.                     Start an asynchronous receive.
    384. 

  384.                   </p>
    385. 

  385.                 </td>
    386. 

  386. </tr>
    387. 

  387. <tr>
    388. 

  388. <td>
    389. 

  389.                   <p>
    390. 

  390.                     <a class="link" href="../basic_seq_packet_socket/async_send.html" title="basic_seq_packet_socket::async_send"><span class="bold"><strong>async_send</strong></span></a>
    391. 

  391.                   </p>
    392. 

  392.                 </td>
    393. 

  393. <td>
    394. 

  394.                   <p>
    395. 

  395.                     Start an asynchronous send.
    396. 

  396.                   </p>
    397. 

  397.                 </td>
    398. 

  398. </tr>
    399. 

  399. <tr>
    400. 

  400. <td>
    401. 

  401.                   <p>
    402. 

  402.                     <a class="link" href="../basic_seq_packet_socket/async_wait.html" title="basic_seq_packet_socket::async_wait"><span class="bold"><strong>async_wait</strong></span></a>
    403. 

  403.                   </p>
    404. 

  404.                 </td>
    405. 

  405. <td>
    406. 

  406.                   <p>
    407. 

  407.                     Asynchronously wait for the socket to become ready to read, ready
    408. 

  408.                     to write, or to have pending error conditions.
    409. 

  409.                   </p>
    410. 

  410.                 </td>
    411. 

  411. </tr>
    412. 

  412. <tr>
    413. 

  413. <td>
    414. 

  414.                   <p>
    415. 

  415.                     <a class="link" href="../basic_seq_packet_socket/at_mark.html" title="basic_seq_packet_socket::at_mark"><span class="bold"><strong>at_mark</strong></span></a>
    416. 

  416.                   </p>
    417. 

  417.                 </td>
    418. 

  418. <td>
    419. 

  419.                   <p>
    420. 

  420.                     Determine whether the socket is at the out-of-band data mark.
    421. 

  421.                   </p>
    422. 

  422.                 </td>
    423. 

  423. </tr>
    424. 

  424. <tr>
    425. 

  425. <td>
    426. 

  426.                   <p>
    427. 

  427.                     <a class="link" href="../basic_seq_packet_socket/available.html" title="basic_seq_packet_socket::available"><span class="bold"><strong>available</strong></span></a>
    428. 

  428.                   </p>
    429. 

  429.                 </td>
    430. 

  430. <td>
    431. 

  431.                   <p>
    432. 

  432.                     Determine the number of bytes available for reading.
    433. 

  433.                   </p>
    434. 

  434.                 </td>
    435. 

  435. </tr>
    436. 

  436. <tr>
    437. 

  437. <td>
    438. 

  438.                   <p>
    439. 

  439.                     <a class="link" href="../basic_seq_packet_socket/basic_seq_packet_socket.html" title="basic_seq_packet_socket::basic_seq_packet_socket"><span class="bold"><strong>basic_seq_packet_socket</strong></span></a>
    440. 

  440.                   </p>
    441. 

  441.                 </td>
    442. 

  442. <td>
    443. 

  443.                   <p>
    444. 

  444.                     Construct a basic_seq_packet_socket without opening it. <br>
    445. 

  445.                     <span class="silver"> &#8212;</span><br> Construct and open a basic_seq_packet_socket. <br> <span class="silver"> &#8212;</span>
    446. 

  446.                     <br> Construct a basic_seq_packet_socket, opening it and binding
    447. 

  447.                     it to the given local endpoint. <br> <span class="silver"> &#8212;</span><br> Construct a basic_seq_packet_socket
    448. 

  448.                     on an existing native socket. <br> <span class="silver"> &#8212;</span><br> Move-construct a
    449. 

  449.                     basic_seq_packet_socket from another. <br> <span class="silver"> &#8212;</span><br> Move-construct
    450. 

  450.                     a basic_seq_packet_socket from a socket of another protocol type.
    451. 

  451.                   </p>
    452. 

  452.                 </td>
    453. 

  453. </tr>
    454. 

  454. <tr>
    455. 

  455. <td>
    456. 

  456.                   <p>
    457. 

  457.                     <a class="link" href="../basic_seq_packet_socket/bind.html" title="basic_seq_packet_socket::bind"><span class="bold"><strong>bind</strong></span></a>
    458. 

  458.                   </p>
    459. 

  459.                 </td>
    460. 

  460. <td>
    461. 

  461.                   <p>
    462. 

  462.                     Bind the socket to the given local endpoint.
    463. 

  463.                   </p>
    464. 

  464.                 </td>
    465. 

  465. </tr>
    466. 

  466. <tr>
    467. 

  467. <td>
    468. 

  468.                   <p>
    469. 

  469.                     <a class="link" href="../basic_seq_packet_socket/cancel.html" title="basic_seq_packet_socket::cancel"><span class="bold"><strong>cancel</strong></span></a>
    470. 

  470.                   </p>
    471. 

  471.                 </td>
    472. 

  472. <td>
    473. 

  473.                   <p>
    474. 

  474.                     Cancel all asynchronous operations associated with the socket.
    475. 

  475.                   </p>
    476. 

  476.                 </td>
    477. 

  477. </tr>
    478. 

  478. <tr>
    479. 

  479. <td>
    480. 

  480.                   <p>
    481. 

  481.                     <a class="link" href="../basic_seq_packet_socket/close.html" title="basic_seq_packet_socket::close"><span class="bold"><strong>close</strong></span></a>
    482. 

  482.                   </p>
    483. 

  483.                 </td>
    484. 

  484. <td>
    485. 

  485.                   <p>
    486. 

  486.                     Close the socket.
    487. 

  487.                   </p>
    488. 

  488.                 </td>
    489. 

  489. </tr>
    490. 

  490. <tr>
    491. 

  491. <td>
    492. 

  492.                   <p>
    493. 

  493.                     <a class="link" href="../basic_seq_packet_socket/connect.html" title="basic_seq_packet_socket::connect"><span class="bold"><strong>connect</strong></span></a>
    494. 

  494.                   </p>
    495. 

  495.                 </td>
    496. 

  496. <td>
    497. 

  497.                   <p>
    498. 

  498.                     Connect the socket to the specified endpoint.
    499. 

  499.                   </p>
    500. 

  500.                 </td>
    501. 

  501. </tr>
    502. 

  502. <tr>
    503. 

  503. <td>
    504. 

  504.                   <p>
    505. 

  505.                     <a class="link" href="../basic_seq_packet_socket/get_executor.html" title="basic_seq_packet_socket::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
    506. 

  506.                   </p>
    507. 

  507.                 </td>
    508. 

  508. <td>
    509. 

  509.                   <p>
    510. 

  510.                     Get the executor associated with the object.
    511. 

  511.                   </p>
    512. 

  512.                 </td>
    513. 

  513. </tr>
    514. 

  514. <tr>
    515. 

  515. <td>
    516. 

  516.                   <p>
    517. 

  517.                     <a class="link" href="../basic_seq_packet_socket/get_option.html" title="basic_seq_packet_socket::get_option"><span class="bold"><strong>get_option</strong></span></a>
    518. 

  518.                   </p>
    519. 

  519.                 </td>
    520. 

  520. <td>
    521. 

  521.                   <p>
    522. 

  522.                     Get an option from the socket.
    523. 

  523.                   </p>
    524. 

  524.                 </td>
    525. 

  525. </tr>
    526. 

  526. <tr>
    527. 

  527. <td>
    528. 

  528.                   <p>
    529. 

  529.                     <a class="link" href="../basic_seq_packet_socket/io_control.html" title="basic_seq_packet_socket::io_control"><span class="bold"><strong>io_control</strong></span></a>
    530. 

  530.                   </p>
    531. 

  531.                 </td>
    532. 

  532. <td>
    533. 

  533.                   <p>
    534. 

  534.                     Perform an IO control command on the socket.
    535. 

  535.                   </p>
    536. 

  536.                 </td>
    537. 

  537. </tr>
    538. 

  538. <tr>
    539. 

  539. <td>
    540. 

  540.                   <p>
    541. 

  541.                     <a class="link" href="../basic_seq_packet_socket/is_open.html" title="basic_seq_packet_socket::is_open"><span class="bold"><strong>is_open</strong></span></a>
    542. 

  542.                   </p>
    543. 

  543.                 </td>
    544. 

  544. <td>
    545. 

  545.                   <p>
    546. 

  546.                     Determine whether the socket is open.
    547. 

  547.                   </p>
    548. 

  548.                 </td>
    549. 

  549. </tr>
    550. 

  550. <tr>
    551. 

  551. <td>
    552. 

  552.                   <p>
    553. 

  553.                     <a class="link" href="../basic_seq_packet_socket/local_endpoint.html" title="basic_seq_packet_socket::local_endpoint"><span class="bold"><strong>local_endpoint</strong></span></a>
    554. 

  554.                   </p>
    555. 

  555.                 </td>
    556. 

  556. <td>
    557. 

  557.                   <p>
    558. 

  558.                     Get the local endpoint of the socket.
    559. 

  559.                   </p>
    560. 

  560.                 </td>
    561. 

  561. </tr>
    562. 

  562. <tr>
    563. 

  563. <td>
    564. 

  564.                   <p>
    565. 

  565.                     <a class="link" href="../basic_seq_packet_socket/lowest_layer.html" title="basic_seq_packet_socket::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a>
    566. 

  566.                   </p>
    567. 

  567.                 </td>
    568. 

  568. <td>
    569. 

  569.                   <p>
    570. 

  570.                     Get a reference to the lowest layer. <br> <span class="silver"> &#8212;</span><br> Get a const
    571. 

  571.                     reference to the lowest layer.
    572. 

  572.                   </p>
    573. 

  573.                 </td>
    574. 

  574. </tr>
    575. 

  575. <tr>
    576. 

  576. <td>
    577. 

  577.                   <p>
    578. 

  578.                     <a class="link" href="../basic_seq_packet_socket/native_handle.html" title="basic_seq_packet_socket::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
    579. 

  579.                   </p>
    580. 

  580.                 </td>
    581. 

  581. <td>
    582. 

  582.                   <p>
    583. 

  583.                     Get the native socket representation.
    584. 

  584.                   </p>
    585. 

  585.                 </td>
    586. 

  586. </tr>
    587. 

  587. <tr>
    588. 

  588. <td>
    589. 

  589.                   <p>
    590. 

  590.                     <a class="link" href="../basic_seq_packet_socket/native_non_blocking.html" title="basic_seq_packet_socket::native_non_blocking"><span class="bold"><strong>native_non_blocking</strong></span></a>
    591. 

  591.                   </p>
    592. 

  592.                 </td>
    593. 

  593. <td>
    594. 

  594.                   <p>
    595. 

  595.                     Gets the non-blocking mode of the native socket implementation.
    596. 

  596.                     <br> <span class="silver"> &#8212;</span><br> Sets the non-blocking mode of the native socket
    597. 

  597.                     implementation.
    598. 

  598.                   </p>
    599. 

  599.                 </td>
    600. 

  600. </tr>
    601. 

  601. <tr>
    602. 

  602. <td>
    603. 

  603.                   <p>
    604. 

  604.                     <a class="link" href="../basic_seq_packet_socket/non_blocking.html" title="basic_seq_packet_socket::non_blocking"><span class="bold"><strong>non_blocking</strong></span></a>
    605. 

  605.                   </p>
    606. 

  606.                 </td>
    607. 

  607. <td>
    608. 

  608.                   <p>
    609. 

  609.                     Gets the non-blocking mode of the socket. <br> <span class="silver"> &#8212;</span><br> Sets
    610. 

  610.                     the non-blocking mode of the socket.
    611. 

  611.                   </p>
    612. 

  612.                 </td>
    613. 

  613. </tr>
    614. 

  614. <tr>
    615. 

  615. <td>
    616. 

  616.                   <p>
    617. 

  617.                     <a class="link" href="../basic_seq_packet_socket/open.html" title="basic_seq_packet_socket::open"><span class="bold"><strong>open</strong></span></a>
    618. 

  618.                   </p>
    619. 

  619.                 </td>
    620. 

  620. <td>
    621. 

  621.                   <p>
    622. 

  622.                     Open the socket using the specified protocol.
    623. 

  623.                   </p>
    624. 

  624.                 </td>
    625. 

  625. </tr>
    626. 

  626. <tr>
    627. 

  627. <td>
    628. 

  628.                   <p>
    629. 

  629.                     <a class="link" href="../basic_seq_packet_socket/operator_eq_.html" title="basic_seq_packet_socket::operator="><span class="bold"><strong>operator=</strong></span></a>
    630. 

  630.                   </p>
    631. 

  631.                 </td>
    632. 

  632. <td>
    633. 

  633.                   <p>
    634. 

  634.                     Move-assign a basic_seq_packet_socket from another. <br> <span class="silver"> &#8212;</span><br>
    635. 

  635.                     Move-assign a basic_seq_packet_socket from a socket of another
    636. 

  636.                     protocol type.
    637. 

  637.                   </p>
    638. 

  638.                 </td>
    639. 

  639. </tr>
    640. 

  640. <tr>
    641. 

  641. <td>
    642. 

  642.                   <p>
    643. 

  643.                     <a class="link" href="../basic_seq_packet_socket/receive.html" title="basic_seq_packet_socket::receive"><span class="bold"><strong>receive</strong></span></a>
    644. 

  644.                   </p>
    645. 

  645.                 </td>
    646. 

  646. <td>
    647. 

  647.                   <p>
    648. 

  648.                     Receive some data on the socket. <br> <span class="silver"> &#8212;</span><br> Receive some data
    649. 

  649.                     on a connected socket.
    650. 

  650.                   </p>
    651. 

  651.                 </td>
    652. 

  652. </tr>
    653. 

  653. <tr>
    654. 

  654. <td>
    655. 

  655.                   <p>
    656. 

  656.                     <a class="link" href="../basic_seq_packet_socket/release.html" title="basic_seq_packet_socket::release"><span class="bold"><strong>release</strong></span></a>
    657. 

  657.                   </p>
    658. 

  658.                 </td>
    659. 

  659. <td>
    660. 

  660.                   <p>
    661. 

  661.                     Release ownership of the underlying native socket.
    662. 

  662.                   </p>
    663. 

  663.                 </td>
    664. 

  664. </tr>
    665. 

  665. <tr>
    666. 

  666. <td>
    667. 

  667.                   <p>
    668. 

  668.                     <a class="link" href="../basic_seq_packet_socket/remote_endpoint.html" title="basic_seq_packet_socket::remote_endpoint"><span class="bold"><strong>remote_endpoint</strong></span></a>
    669. 

  669.                   </p>
    670. 

  670.                 </td>
    671. 

  671. <td>
    672. 

  672.                   <p>
    673. 

  673.                     Get the remote endpoint of the socket.
    674. 

  674.                   </p>
    675. 

  675.                 </td>
    676. 

  676. </tr>
    677. 

  677. <tr>
    678. 

  678. <td>
    679. 

  679.                   <p>
    680. 

  680.                     <a class="link" href="../basic_seq_packet_socket/send.html" title="basic_seq_packet_socket::send"><span class="bold"><strong>send</strong></span></a>
    681. 

  681.                   </p>
    682. 

  682.                 </td>
    683. 

  683. <td>
    684. 

  684.                   <p>
    685. 

  685.                     Send some data on the socket.
    686. 

  686.                   </p>
    687. 

  687.                 </td>
    688. 

  688. </tr>
    689. 

  689. <tr>
    690. 

  690. <td>
    691. 

  691.                   <p>
    692. 

  692.                     <a class="link" href="../basic_seq_packet_socket/set_option.html" title="basic_seq_packet_socket::set_option"><span class="bold"><strong>set_option</strong></span></a>
    693. 

  693.                   </p>
    694. 

  694.                 </td>
    695. 

  695. <td>
    696. 

  696.                   <p>
    697. 

  697.                     Set an option on the socket.
    698. 

  698.                   </p>
    699. 

  699.                 </td>
    700. 

  700. </tr>
    701. 

  701. <tr>
    702. 

  702. <td>
    703. 

  703.                   <p>
    704. 

  704.                     <a class="link" href="../basic_seq_packet_socket/shutdown.html" title="basic_seq_packet_socket::shutdown"><span class="bold"><strong>shutdown</strong></span></a>
    705. 

  705.                   </p>
    706. 

  706.                 </td>
    707. 

  707. <td>
    708. 

  708.                   <p>
    709. 

  709.                     Disable sends or receives on the socket.
    710. 

  710.                   </p>
    711. 

  711.                 </td>
    712. 

  712. </tr>
    713. 

  713. <tr>
    714. 

  714. <td>
    715. 

  715.                   <p>
    716. 

  716.                     <a class="link" href="../basic_seq_packet_socket/wait.html" title="basic_seq_packet_socket::wait"><span class="bold"><strong>wait</strong></span></a>
    717. 

  717.                   </p>
    718. 

  718.                 </td>
    719. 

  719. <td>
    720. 

  720.                   <p>
    721. 

  721.                     Wait for the socket to become ready to read, ready to write,
    722. 

  722.                     or to have pending error conditions.
    723. 

  723.                   </p>
    724. 

  724.                 </td>
    725. 

  725. </tr>
    726. 

  726. <tr>
    727. 

  727. <td>
    728. 

  728.                   <p>
    729. 

  729.                     <a class="link" href="../basic_seq_packet_socket/_basic_seq_packet_socket.html" title="basic_seq_packet_socket::~basic_seq_packet_socket"><span class="bold"><strong>~basic_seq_packet_socket</strong></span></a>
    730. 

  730.                   </p>
    731. 

  731.                 </td>
    732. 

  732. <td>
    733. 

  733.                   <p>
    734. 

  734.                     Destroys the socket.
    735. 

  735.                   </p>
    736. 

  736.                 </td>
    737. 

  737. </tr>
    738. 

  738. </tbody>
    739. 

  739. </table></div>
    740. 

  740. <h6>
    741. 

  741. <a name="boost_asio.reference.generic__seq_packet_protocol.socket.h2"></a>
    742. 

  742.           <span class="phrase"><a name="boost_asio.reference.generic__seq_packet_protocol.socket.data_members"></a></span><a class="link" href="socket.html#boost_asio.reference.generic__seq_packet_protocol.socket.data_members">Data
    743. 

  743.           Members</a>
    744. 

  744.         </h6>
    745. 

  745. <div class="informaltable"><table class="table">
    746. 

  746. <colgroup>
    747. 

  747. <col>
    748. 

  748. <col>
    749. 

  749. </colgroup>
    750. 

  750. <thead><tr>
    751. 

  751. <th>
    752. 

  752.                   <p>
    753. 

  753.                     Name
    754. 

  754.                   </p>
    755. 

  755.                 </th>
    756. 

  756. <th>
    757. 

  757.                   <p>
    758. 

  758.                     Description
    759. 

  759.                   </p>
    760. 

  760.                 </th>
    761. 

  761. </tr></thead>
    762. 

  762. <tbody>
    763. 

  763. <tr>
    764. 

  764. <td>
    765. 

  765.                   <p>
    766. 

  766.                     <a class="link" href="../basic_seq_packet_socket/max_connections.html" title="basic_seq_packet_socket::max_connections"><span class="bold"><strong>max_connections</strong></span></a>
    767. 

  767.                   </p>
    768. 

  768.                 </td>
    769. 

  769. <td>
    770. 

  770.                   <p>
    771. 

  771.                     (Deprecated: Use max_listen_connections.) The maximum length
    772. 

  772.                     of the queue of pending incoming connections.
    773. 

  773.                   </p>
    774. 

  774.                 </td>
    775. 

  775. </tr>
    776. 

  776. <tr>
    777. 

  777. <td>
    778. 

  778.                   <p>
    779. 

  779.                     <a class="link" href="../basic_seq_packet_socket/max_listen_connections.html" title="basic_seq_packet_socket::max_listen_connections"><span class="bold"><strong>max_listen_connections</strong></span></a>
    780. 

  780.                   </p>
    781. 

  781.                 </td>
    782. 

  782. <td>
    783. 

  783.                   <p>
    784. 

  784.                     The maximum length of the queue of pending incoming connections.
    785. 

  785.                   </p>
    786. 

  786.                 </td>
    787. 

  787. </tr>
    788. 

  788. <tr>
    789. 

  789. <td>
    790. 

  790.                   <p>
    791. 

  791.                     <a class="link" href="../basic_seq_packet_socket/message_do_not_route.html" title="basic_seq_packet_socket::message_do_not_route"><span class="bold"><strong>message_do_not_route</strong></span></a>
    792. 

  792.                   </p>
    793. 

  793.                 </td>
    794. 

  794. <td>
    795. 

  795.                   <p>
    796. 

  796.                     Specify that the data should not be subject to routing.
    797. 

  797.                   </p>
    798. 

  798.                 </td>
    799. 

  799. </tr>
    800. 

  800. <tr>
    801. 

  801. <td>
    802. 

  802.                   <p>
    803. 

  803.                     <a class="link" href="../basic_seq_packet_socket/message_end_of_record.html" title="basic_seq_packet_socket::message_end_of_record"><span class="bold"><strong>message_end_of_record</strong></span></a>
    804. 

  804.                   </p>
    805. 

  805.                 </td>
    806. 

  806. <td>
    807. 

  807.                   <p>
    808. 

  808.                     Specifies that the data marks the end of a record.
    809. 

  809.                   </p>
    810. 

  810.                 </td>
    811. 

  811. </tr>
    812. 

  812. <tr>
    813. 

  813. <td>
    814. 

  814.                   <p>
    815. 

  815.                     <a class="link" href="../basic_seq_packet_socket/message_out_of_band.html" title="basic_seq_packet_socket::message_out_of_band"><span class="bold"><strong>message_out_of_band</strong></span></a>
    816. 

  816.                   </p>
    817. 

  817.                 </td>
    818. 

  818. <td>
    819. 

  819.                   <p>
    820. 

  820.                     Process out-of-band data.
    821. 

  821.                   </p>
    822. 

  822.                 </td>
    823. 

  823. </tr>
    824. 

  824. <tr>
    825. 

  825. <td>
    826. 

  826.                   <p>
    827. 

  827.                     <a class="link" href="../basic_seq_packet_socket/message_peek.html" title="basic_seq_packet_socket::message_peek"><span class="bold"><strong>message_peek</strong></span></a>
    828. 

  828.                   </p>
    829. 

  829.                 </td>
    830. 

  830. <td>
    831. 

  831.                   <p>
    832. 

  832.                     Peek at incoming data without removing it from the input queue.
    833. 

  833.                   </p>
    834. 

  834.                 </td>
    835. 

  835. </tr>
    836. 

  836. </tbody>
    837. 

  837. </table></div>
    838. 

  838. <h6>
    839. 

  839. <a name="boost_asio.reference.generic__seq_packet_protocol.socket.h3"></a>
    840. 

  840.           <span class="phrase"><a name="boost_asio.reference.generic__seq_packet_protocol.socket.protected_data_members"></a></span><a class="link" href="socket.html#boost_asio.reference.generic__seq_packet_protocol.socket.protected_data_members">Protected
    841. 

  841.           Data Members</a>
    842. 

  842.         </h6>
    843. 

  843. <div class="informaltable"><table class="table">
    844. 

  844. <colgroup>
    845. 

  845. <col>
    846. 

  846. <col>
    847. 

  847. </colgroup>
    848. 

  848. <thead><tr>
    849. 

  849. <th>
    850. 

  850.                   <p>
    851. 

  851.                     Name
    852. 

  852.                   </p>
    853. 

  853.                 </th>
    854. 

  854. <th>
    855. 

  855.                   <p>
    856. 

  856.                     Description
    857. 

  857.                   </p>
    858. 

  858.                 </th>
    859. 

  859. </tr></thead>
    860. 

  860. <tbody><tr>
    861. 

  861. <td>
    862. 

  862.                   <p>
    863. 

  863.                     <a class="link" href="../basic_seq_packet_socket/impl_.html" title="basic_seq_packet_socket::impl_"><span class="bold"><strong>impl_</strong></span></a>
    864. 

  864.                   </p>
    865. 

  865.                 </td>
    866. 

  866. <td>
    867. 

  867.                 </td>
    868. 

  868. </tr></tbody>
    869. 

  869. </table></div>
    870. 

  870. <p>
    871. 

  871.           The <a class="link" href="../basic_seq_packet_socket.html" title="basic_seq_packet_socket"><code class="computeroutput">basic_seq_packet_socket</code></a>
    872. 

  872.           class template provides asynchronous and blocking sequenced packet socket
    873. 

  873.           functionality.
    874. 

  874.         </p>
    875. 

  875. <h6>
    876. 

  876. <a name="boost_asio.reference.generic__seq_packet_protocol.socket.h4"></a>
    877. 

  877.           <span class="phrase"><a name="boost_asio.reference.generic__seq_packet_protocol.socket.thread_safety"></a></span><a class="link" href="socket.html#boost_asio.reference.generic__seq_packet_protocol.socket.thread_safety">Thread
    878. 

  878.           Safety</a>
    879. 

  879.         </h6>
    880. 

  880. <p>
    881. 

  881.           <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
    882. 

  882.         </p>
    883. 

  883. <p>
    884. 

  884.           <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
    885. 

  885.         </p>
    886. 

  886. <h6>
    887. 

  887. <a name="boost_asio.reference.generic__seq_packet_protocol.socket.h5"></a>
    888. 

  888.           <span class="phrase"><a name="boost_asio.reference.generic__seq_packet_protocol.socket.requirements"></a></span><a class="link" href="socket.html#boost_asio.reference.generic__seq_packet_protocol.socket.requirements">Requirements</a>
    889. 

  889.         </h6>
    890. 

  890. <p>
    891. 

  891.           <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/generic/seq_packet_protocol.hpp</code>
    892. 

  892.         </p>
    893. 

  893. <p>
    894. 

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

  895.         </p>
    896. 

  896. </div>
    897. 

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

  898. <td align="left"></td>
    899. 

  899. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
    900. 

  900.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    901. 

  901.         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>)
    902. 

  902.       </p>
    903. 

  903. </div></td>
    904. 

  904. </tr></table>
    905. 

  905. <hr>
    906. 

  906. <div class="spirit-nav">
    907. 

  907. <a accesskey="p" href="seq_packet_protocol/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../generic__seq_packet_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="type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
    908. 

  908. </div>
    909. 

  909. </body>
    910. 

  910. </html>
    911. 

  911.