PageRenderTime 72ms CodeModel.GetById 21ms RepoModel.GetById 1ms app.codeStats 0ms

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

https://bitbucket.org/Tank_Master/fs-boost
HTML | 947 lines | 947 code | 0 blank | 0 comment | 0 complexity | 8be5d636ea5b18704227a84866b18657 MD5 | raw file
Possible License(s): MIT
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>generic::seq_packet_protocol::socket</title>
  5. <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
  7. <link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
  8. <link rel="up" href="../generic__seq_packet_protocol.html" title="generic::seq_packet_protocol">
  9. <link rel="prev" href="seq_packet_protocol/overload2.html" title="generic::seq_packet_protocol::seq_packet_protocol (2 of 2 overloads)">
  10. <link rel="next" href="type.html" title="generic::seq_packet_protocol::type">
  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="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. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h4 class="title">
  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. </h4></div></div></div>
  29. <p>
  30. <a class="indexterm" name="idp83881016"></a>
  31. The generic socket type.
  32. </p>
  33. <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_seq_packet_socket</span><span class="special">&lt;</span> <span class="identifier">seq_packet_protocol</span> <span class="special">&gt;</span> <span class="identifier">socket</span><span class="special">;</span>
  34. </pre>
  35. <h6>
  36. <a name="boost_asio.reference.generic__seq_packet_protocol.socket.h0"></a>
  37. <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>
  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="../basic_seq_packet_socket/broadcast.html" title="basic_seq_packet_socket::broadcast"><span class="bold"><strong>broadcast</strong></span></a>
  61. </p>
  62. </td>
  63. <td>
  64. <p>
  65. Socket option to permit sending of broadcast messages.
  66. </p>
  67. </td>
  68. </tr>
  69. <tr>
  70. <td>
  71. <p>
  72. <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>
  73. </p>
  74. </td>
  75. <td>
  76. <p>
  77. IO control command to get the amount of data that can be read
  78. without blocking.
  79. </p>
  80. </td>
  81. </tr>
  82. <tr>
  83. <td>
  84. <p>
  85. <a class="link" href="../basic_seq_packet_socket/debug.html" title="basic_seq_packet_socket::debug"><span class="bold"><strong>debug</strong></span></a>
  86. </p>
  87. </td>
  88. <td>
  89. <p>
  90. Socket option to enable socket-level debugging.
  91. </p>
  92. </td>
  93. </tr>
  94. <tr>
  95. <td>
  96. <p>
  97. <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>
  98. </p>
  99. </td>
  100. <td>
  101. <p>
  102. Socket option to prevent routing, use local interfaces only.
  103. </p>
  104. </td>
  105. </tr>
  106. <tr>
  107. <td>
  108. <p>
  109. <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>
  110. </p>
  111. </td>
  112. <td>
  113. <p>
  114. Socket option to report aborted connections on accept.
  115. </p>
  116. </td>
  117. </tr>
  118. <tr>
  119. <td>
  120. <p>
  121. <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>
  122. </p>
  123. </td>
  124. <td>
  125. <p>
  126. The endpoint type.
  127. </p>
  128. </td>
  129. </tr>
  130. <tr>
  131. <td>
  132. <p>
  133. <a class="link" href="../basic_seq_packet_socket/implementation_type.html" title="basic_seq_packet_socket::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a>
  134. </p>
  135. </td>
  136. <td>
  137. <p>
  138. The underlying implementation type of I/O object.
  139. </p>
  140. </td>
  141. </tr>
  142. <tr>
  143. <td>
  144. <p>
  145. <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>
  146. </p>
  147. </td>
  148. <td>
  149. <p>
  150. Socket option to send keep-alives.
  151. </p>
  152. </td>
  153. </tr>
  154. <tr>
  155. <td>
  156. <p>
  157. <a class="link" href="../basic_seq_packet_socket/linger.html" title="basic_seq_packet_socket::linger"><span class="bold"><strong>linger</strong></span></a>
  158. </p>
  159. </td>
  160. <td>
  161. <p>
  162. Socket option to specify whether the socket lingers on close
  163. if unsent data is present.
  164. </p>
  165. </td>
  166. </tr>
  167. <tr>
  168. <td>
  169. <p>
  170. <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>
  171. </p>
  172. </td>
  173. <td>
  174. <p>
  175. A basic_socket is always the lowest layer.
  176. </p>
  177. </td>
  178. </tr>
  179. <tr>
  180. <td>
  181. <p>
  182. <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>
  183. </p>
  184. </td>
  185. <td>
  186. <p>
  187. Bitmask type for flags that can be passed to send and receive
  188. operations.
  189. </p>
  190. </td>
  191. </tr>
  192. <tr>
  193. <td>
  194. <p>
  195. <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>
  196. </p>
  197. </td>
  198. <td>
  199. <p>
  200. The native representation of a socket.
  201. </p>
  202. </td>
  203. </tr>
  204. <tr>
  205. <td>
  206. <p>
  207. <a class="link" href="../basic_seq_packet_socket/native_type.html" title="basic_seq_packet_socket::native_type"><span class="bold"><strong>native_type</strong></span></a>
  208. </p>
  209. </td>
  210. <td>
  211. <p>
  212. (Deprecated: Use native_handle_type.) The native representation
  213. of a socket.
  214. </p>
  215. </td>
  216. </tr>
  217. <tr>
  218. <td>
  219. <p>
  220. <a class="link" href="../basic_seq_packet_socket/non_blocking_io.html" title="basic_seq_packet_socket::non_blocking_io"><span class="bold"><strong>non_blocking_io</strong></span></a>
  221. </p>
  222. </td>
  223. <td>
  224. <p>
  225. (Deprecated: Use non_blocking().) IO control command to set the
  226. blocking mode of the socket.
  227. </p>
  228. </td>
  229. </tr>
  230. <tr>
  231. <td>
  232. <p>
  233. <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>
  234. </p>
  235. </td>
  236. <td>
  237. <p>
  238. The protocol type.
  239. </p>
  240. </td>
  241. </tr>
  242. <tr>
  243. <td>
  244. <p>
  245. <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>
  246. </p>
  247. </td>
  248. <td>
  249. <p>
  250. Socket option for the receive buffer size of a socket.
  251. </p>
  252. </td>
  253. </tr>
  254. <tr>
  255. <td>
  256. <p>
  257. <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>
  258. </p>
  259. </td>
  260. <td>
  261. <p>
  262. Socket option for the receive low watermark.
  263. </p>
  264. </td>
  265. </tr>
  266. <tr>
  267. <td>
  268. <p>
  269. <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>
  270. </p>
  271. </td>
  272. <td>
  273. <p>
  274. Socket option to allow the socket to be bound to an address that
  275. is already in use.
  276. </p>
  277. </td>
  278. </tr>
  279. <tr>
  280. <td>
  281. <p>
  282. <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>
  283. </p>
  284. </td>
  285. <td>
  286. <p>
  287. Socket option for the send buffer size of a socket.
  288. </p>
  289. </td>
  290. </tr>
  291. <tr>
  292. <td>
  293. <p>
  294. <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>
  295. </p>
  296. </td>
  297. <td>
  298. <p>
  299. Socket option for the send low watermark.
  300. </p>
  301. </td>
  302. </tr>
  303. <tr>
  304. <td>
  305. <p>
  306. <a class="link" href="../basic_seq_packet_socket/service_type.html" title="basic_seq_packet_socket::service_type"><span class="bold"><strong>service_type</strong></span></a>
  307. </p>
  308. </td>
  309. <td>
  310. <p>
  311. The type of the service that will be used to provide I/O operations.
  312. </p>
  313. </td>
  314. </tr>
  315. <tr>
  316. <td>
  317. <p>
  318. <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>
  319. </p>
  320. </td>
  321. <td>
  322. <p>
  323. Different ways a socket may be shutdown.
  324. </p>
  325. </td>
  326. </tr>
  327. </tbody>
  328. </table></div>
  329. <h6>
  330. <a name="boost_asio.reference.generic__seq_packet_protocol.socket.h1"></a>
  331. <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
  332. Functions</a>
  333. </h6>
  334. <div class="informaltable"><table class="table">
  335. <colgroup>
  336. <col>
  337. <col>
  338. </colgroup>
  339. <thead><tr>
  340. <th>
  341. <p>
  342. Name
  343. </p>
  344. </th>
  345. <th>
  346. <p>
  347. Description
  348. </p>
  349. </th>
  350. </tr></thead>
  351. <tbody>
  352. <tr>
  353. <td>
  354. <p>
  355. <a class="link" href="../basic_seq_packet_socket/assign.html" title="basic_seq_packet_socket::assign"><span class="bold"><strong>assign</strong></span></a>
  356. </p>
  357. </td>
  358. <td>
  359. <p>
  360. Assign an existing native socket to the socket.
  361. </p>
  362. </td>
  363. </tr>
  364. <tr>
  365. <td>
  366. <p>
  367. <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>
  368. </p>
  369. </td>
  370. <td>
  371. <p>
  372. Start an asynchronous connect.
  373. </p>
  374. </td>
  375. </tr>
  376. <tr>
  377. <td>
  378. <p>
  379. <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>
  380. </p>
  381. </td>
  382. <td>
  383. <p>
  384. Start an asynchronous receive.
  385. </p>
  386. </td>
  387. </tr>
  388. <tr>
  389. <td>
  390. <p>
  391. <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>
  392. </p>
  393. </td>
  394. <td>
  395. <p>
  396. Start an asynchronous send.
  397. </p>
  398. </td>
  399. </tr>
  400. <tr>
  401. <td>
  402. <p>
  403. <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>
  404. </p>
  405. </td>
  406. <td>
  407. <p>
  408. Determine whether the socket is at the out-of-band data mark.
  409. </p>
  410. </td>
  411. </tr>
  412. <tr>
  413. <td>
  414. <p>
  415. <a class="link" href="../basic_seq_packet_socket/available.html" title="basic_seq_packet_socket::available"><span class="bold"><strong>available</strong></span></a>
  416. </p>
  417. </td>
  418. <td>
  419. <p>
  420. Determine the number of bytes available for reading.
  421. </p>
  422. </td>
  423. </tr>
  424. <tr>
  425. <td>
  426. <p>
  427. <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>
  428. </p>
  429. </td>
  430. <td>
  431. <p>
  432. Construct a basic_seq_packet_socket without opening it.
  433. </p>
  434. <p>
  435. Construct and open a basic_seq_packet_socket.
  436. </p>
  437. <p>
  438. Construct a basic_seq_packet_socket, opening it and binding it
  439. to the given local endpoint.
  440. </p>
  441. <p>
  442. Construct a basic_seq_packet_socket on an existing native socket.
  443. </p>
  444. <p>
  445. Move-construct a basic_seq_packet_socket from another.
  446. </p>
  447. <p>
  448. Move-construct a basic_seq_packet_socket from a socket of another
  449. protocol type.
  450. </p>
  451. </td>
  452. </tr>
  453. <tr>
  454. <td>
  455. <p>
  456. <a class="link" href="../basic_seq_packet_socket/bind.html" title="basic_seq_packet_socket::bind"><span class="bold"><strong>bind</strong></span></a>
  457. </p>
  458. </td>
  459. <td>
  460. <p>
  461. Bind the socket to the given local endpoint.
  462. </p>
  463. </td>
  464. </tr>
  465. <tr>
  466. <td>
  467. <p>
  468. <a class="link" href="../basic_seq_packet_socket/cancel.html" title="basic_seq_packet_socket::cancel"><span class="bold"><strong>cancel</strong></span></a>
  469. </p>
  470. </td>
  471. <td>
  472. <p>
  473. Cancel all asynchronous operations associated with the socket.
  474. </p>
  475. </td>
  476. </tr>
  477. <tr>
  478. <td>
  479. <p>
  480. <a class="link" href="../basic_seq_packet_socket/close.html" title="basic_seq_packet_socket::close"><span class="bold"><strong>close</strong></span></a>
  481. </p>
  482. </td>
  483. <td>
  484. <p>
  485. Close the socket.
  486. </p>
  487. </td>
  488. </tr>
  489. <tr>
  490. <td>
  491. <p>
  492. <a class="link" href="../basic_seq_packet_socket/connect.html" title="basic_seq_packet_socket::connect"><span class="bold"><strong>connect</strong></span></a>
  493. </p>
  494. </td>
  495. <td>
  496. <p>
  497. Connect the socket to the specified endpoint.
  498. </p>
  499. </td>
  500. </tr>
  501. <tr>
  502. <td>
  503. <p>
  504. <a class="link" href="../basic_seq_packet_socket/get_io_service.html" title="basic_seq_packet_socket::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
  505. </p>
  506. </td>
  507. <td>
  508. <p>
  509. Get the io_service associated with the object.
  510. </p>
  511. </td>
  512. </tr>
  513. <tr>
  514. <td>
  515. <p>
  516. <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>
  517. </p>
  518. </td>
  519. <td>
  520. <p>
  521. Get an option from the socket.
  522. </p>
  523. </td>
  524. </tr>
  525. <tr>
  526. <td>
  527. <p>
  528. <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>
  529. </p>
  530. </td>
  531. <td>
  532. <p>
  533. Perform an IO control command on the socket.
  534. </p>
  535. </td>
  536. </tr>
  537. <tr>
  538. <td>
  539. <p>
  540. <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>
  541. </p>
  542. </td>
  543. <td>
  544. <p>
  545. Determine whether the socket is open.
  546. </p>
  547. </td>
  548. </tr>
  549. <tr>
  550. <td>
  551. <p>
  552. <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>
  553. </p>
  554. </td>
  555. <td>
  556. <p>
  557. Get the local endpoint of the socket.
  558. </p>
  559. </td>
  560. </tr>
  561. <tr>
  562. <td>
  563. <p>
  564. <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>
  565. </p>
  566. </td>
  567. <td>
  568. <p>
  569. Get a reference to the lowest layer.
  570. </p>
  571. <p>
  572. Get a const reference to the lowest layer.
  573. </p>
  574. </td>
  575. </tr>
  576. <tr>
  577. <td>
  578. <p>
  579. <a class="link" href="../basic_seq_packet_socket/native.html" title="basic_seq_packet_socket::native"><span class="bold"><strong>native</strong></span></a>
  580. </p>
  581. </td>
  582. <td>
  583. <p>
  584. (Deprecated: Use native_handle().) Get the native socket representation.
  585. </p>
  586. </td>
  587. </tr>
  588. <tr>
  589. <td>
  590. <p>
  591. <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>
  592. </p>
  593. </td>
  594. <td>
  595. <p>
  596. Get the native socket representation.
  597. </p>
  598. </td>
  599. </tr>
  600. <tr>
  601. <td>
  602. <p>
  603. <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>
  604. </p>
  605. </td>
  606. <td>
  607. <p>
  608. Gets the non-blocking mode of the native socket implementation.
  609. </p>
  610. <p>
  611. Sets the non-blocking mode of the native socket implementation.
  612. </p>
  613. </td>
  614. </tr>
  615. <tr>
  616. <td>
  617. <p>
  618. <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>
  619. </p>
  620. </td>
  621. <td>
  622. <p>
  623. Gets the non-blocking mode of the socket.
  624. </p>
  625. <p>
  626. Sets the non-blocking mode of the socket.
  627. </p>
  628. </td>
  629. </tr>
  630. <tr>
  631. <td>
  632. <p>
  633. <a class="link" href="../basic_seq_packet_socket/open.html" title="basic_seq_packet_socket::open"><span class="bold"><strong>open</strong></span></a>
  634. </p>
  635. </td>
  636. <td>
  637. <p>
  638. Open the socket using the specified protocol.
  639. </p>
  640. </td>
  641. </tr>
  642. <tr>
  643. <td>
  644. <p>
  645. <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>
  646. </p>
  647. </td>
  648. <td>
  649. <p>
  650. Move-assign a basic_seq_packet_socket from another.
  651. </p>
  652. <p>
  653. Move-assign a basic_seq_packet_socket from a socket of another
  654. protocol type.
  655. </p>
  656. </td>
  657. </tr>
  658. <tr>
  659. <td>
  660. <p>
  661. <a class="link" href="../basic_seq_packet_socket/receive.html" title="basic_seq_packet_socket::receive"><span class="bold"><strong>receive</strong></span></a>
  662. </p>
  663. </td>
  664. <td>
  665. <p>
  666. Receive some data on the socket.
  667. </p>
  668. <p>
  669. Receive some data on a connected socket.
  670. </p>
  671. </td>
  672. </tr>
  673. <tr>
  674. <td>
  675. <p>
  676. <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>
  677. </p>
  678. </td>
  679. <td>
  680. <p>
  681. Get the remote endpoint of the socket.
  682. </p>
  683. </td>
  684. </tr>
  685. <tr>
  686. <td>
  687. <p>
  688. <a class="link" href="../basic_seq_packet_socket/send.html" title="basic_seq_packet_socket::send"><span class="bold"><strong>send</strong></span></a>
  689. </p>
  690. </td>
  691. <td>
  692. <p>
  693. Send some data on the socket.
  694. </p>
  695. </td>
  696. </tr>
  697. <tr>
  698. <td>
  699. <p>
  700. <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>
  701. </p>
  702. </td>
  703. <td>
  704. <p>
  705. Set an option on the socket.
  706. </p>
  707. </td>
  708. </tr>
  709. <tr>
  710. <td>
  711. <p>
  712. <a class="link" href="../basic_seq_packet_socket/shutdown.html" title="basic_seq_packet_socket::shutdown"><span class="bold"><strong>shutdown</strong></span></a>
  713. </p>
  714. </td>
  715. <td>
  716. <p>
  717. Disable sends or receives on the socket.
  718. </p>
  719. </td>
  720. </tr>
  721. </tbody>
  722. </table></div>
  723. <h6>
  724. <a name="boost_asio.reference.generic__seq_packet_protocol.socket.h2"></a>
  725. <span class="phrase"><a name="boost_asio.reference.generic__seq_packet_protocol.socket.protected_member_functions"></a></span><a class="link" href="socket.html#boost_asio.reference.generic__seq_packet_protocol.socket.protected_member_functions">Protected
  726. Member Functions</a>
  727. </h6>
  728. <div class="informaltable"><table class="table">
  729. <colgroup>
  730. <col>
  731. <col>
  732. </colgroup>
  733. <thead><tr>
  734. <th>
  735. <p>
  736. Name
  737. </p>
  738. </th>
  739. <th>
  740. <p>
  741. Description
  742. </p>
  743. </th>
  744. </tr></thead>
  745. <tbody>
  746. <tr>
  747. <td>
  748. <p>
  749. <a class="link" href="../basic_seq_packet_socket/get_implementation.html" title="basic_seq_packet_socket::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a>
  750. </p>
  751. </td>
  752. <td>
  753. <p>
  754. Get the underlying implementation of the I/O object.
  755. </p>
  756. </td>
  757. </tr>
  758. <tr>
  759. <td>
  760. <p>
  761. <a class="link" href="../basic_seq_packet_socket/get_service.html" title="basic_seq_packet_socket::get_service"><span class="bold"><strong>get_service</strong></span></a>
  762. </p>
  763. </td>
  764. <td>
  765. <p>
  766. Get the service associated with the I/O object.
  767. </p>
  768. </td>
  769. </tr>
  770. </tbody>
  771. </table></div>
  772. <h6>
  773. <a name="boost_asio.reference.generic__seq_packet_protocol.socket.h3"></a>
  774. <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
  775. Members</a>
  776. </h6>
  777. <div class="informaltable"><table class="table">
  778. <colgroup>
  779. <col>
  780. <col>
  781. </colgroup>
  782. <thead><tr>
  783. <th>
  784. <p>
  785. Name
  786. </p>
  787. </th>
  788. <th>
  789. <p>
  790. Description
  791. </p>
  792. </th>
  793. </tr></thead>
  794. <tbody>
  795. <tr>
  796. <td>
  797. <p>
  798. <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>
  799. </p>
  800. </td>
  801. <td>
  802. <p>
  803. The maximum length of the queue of pending incoming connections.
  804. </p>
  805. </td>
  806. </tr>
  807. <tr>
  808. <td>
  809. <p>
  810. <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>
  811. </p>
  812. </td>
  813. <td>
  814. <p>
  815. Specify that the data should not be subject to routing.
  816. </p>
  817. </td>
  818. </tr>
  819. <tr>
  820. <td>
  821. <p>
  822. <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>
  823. </p>
  824. </td>
  825. <td>
  826. <p>
  827. Specifies that the data marks the end of a record.
  828. </p>
  829. </td>
  830. </tr>
  831. <tr>
  832. <td>
  833. <p>
  834. <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>
  835. </p>
  836. </td>
  837. <td>
  838. <p>
  839. Process out-of-band data.
  840. </p>
  841. </td>
  842. </tr>
  843. <tr>
  844. <td>
  845. <p>
  846. <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>
  847. </p>
  848. </td>
  849. <td>
  850. <p>
  851. Peek at incoming data without removing it from the input queue.
  852. </p>
  853. </td>
  854. </tr>
  855. </tbody>
  856. </table></div>
  857. <h6>
  858. <a name="boost_asio.reference.generic__seq_packet_protocol.socket.h4"></a>
  859. <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
  860. Data Members</a>
  861. </h6>
  862. <div class="informaltable"><table class="table">
  863. <colgroup>
  864. <col>
  865. <col>
  866. </colgroup>
  867. <thead><tr>
  868. <th>
  869. <p>
  870. Name
  871. </p>
  872. </th>
  873. <th>
  874. <p>
  875. Description
  876. </p>
  877. </th>
  878. </tr></thead>
  879. <tbody>
  880. <tr>
  881. <td>
  882. <p>
  883. <a class="link" href="../basic_seq_packet_socket/implementation.html" title="basic_seq_packet_socket::implementation"><span class="bold"><strong>implementation</strong></span></a>
  884. </p>
  885. </td>
  886. <td>
  887. <p>
  888. (Deprecated: Use get_implementation().) The underlying implementation
  889. of the I/O object.
  890. </p>
  891. </td>
  892. </tr>
  893. <tr>
  894. <td>
  895. <p>
  896. <a class="link" href="../basic_seq_packet_socket/service.html" title="basic_seq_packet_socket::service"><span class="bold"><strong>service</strong></span></a>
  897. </p>
  898. </td>
  899. <td>
  900. <p>
  901. (Deprecated: Use get_service().) The service associated with
  902. the I/O object.
  903. </p>
  904. </td>
  905. </tr>
  906. </tbody>
  907. </table></div>
  908. <p>
  909. The <a class="link" href="../basic_seq_packet_socket.html" title="basic_seq_packet_socket"><code class="computeroutput"><span class="identifier">basic_seq_packet_socket</span></code></a> class
  910. template provides asynchronous and blocking sequenced packet socket functionality.
  911. </p>
  912. <h6>
  913. <a name="boost_asio.reference.generic__seq_packet_protocol.socket.h5"></a>
  914. <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
  915. Safety</a>
  916. </h6>
  917. <p>
  918. <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
  919. </p>
  920. <p>
  921. <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
  922. </p>
  923. <h6>
  924. <a name="boost_asio.reference.generic__seq_packet_protocol.socket.h6"></a>
  925. <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>
  926. </h6>
  927. <p>
  928. <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/generic/seq_packet_protocol.hpp</code>
  929. </p>
  930. <p>
  931. <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
  932. </p>
  933. </div>
  934. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  935. <td align="left"></td>
  936. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2013 Christopher M. Kohlhoff<p>
  937. Distributed under the Boost Software License, Version 1.0. (See accompanying
  938. 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>)
  939. </p>
  940. </div></td>
  941. </tr></table>
  942. <hr>
  943. <div class="spirit-nav">
  944. <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>
  945. </div>
  946. </body>
  947. </html>