PageRenderTime 61ms CodeModel.GetById 27ms RepoModel.GetById 1ms app.codeStats 0ms

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

https://bitbucket.org/kokua/3p-boost-64
HTML | 989 lines | 989 code | 0 blank | 0 comment | 0 complexity | 32a42f3956a439913c0514a542e8ba33 MD5 | raw file
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>local::stream_protocol::socket</title>
  5. <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
  7. <link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
  8. <link rel="up" href="../local__stream_protocol.html" title="local::stream_protocol">
  9. <link rel="prev" href="protocol.html" title="local::stream_protocol::protocol">
  10. <link rel="next" href="type.html" title="local::stream_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="protocol.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../local__stream_protocol.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="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.local__stream_protocol.socket"></a><a class="link" href="socket.html" title="local::stream_protocol::socket">local::stream_protocol::socket</a>
  28. </h4></div></div></div>
  29. <p>
  30. <a class="indexterm" name="id1445657"></a>
  31. The UNIX domain socket type.
  32. </p>
  33. <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_stream_socket</span><span class="special">&lt;</span> <span class="identifier">stream_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.local__stream_protocol.socket.h0"></a>
  37. <span><a name="boost_asio.reference.local__stream_protocol.socket.types"></a></span><a class="link" href="socket.html#boost_asio.reference.local__stream_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_stream_socket/broadcast.html" title="basic_stream_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_stream_socket/bytes_readable.html" title="basic_stream_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_stream_socket/debug.html" title="basic_stream_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_stream_socket/do_not_route.html" title="basic_stream_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_stream_socket/enable_connection_aborted.html" title="basic_stream_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_stream_socket/endpoint_type.html" title="basic_stream_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_stream_socket/implementation_type.html" title="basic_stream_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_stream_socket/keep_alive.html" title="basic_stream_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_stream_socket/linger.html" title="basic_stream_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_stream_socket/lowest_layer_type.html" title="basic_stream_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_stream_socket/message_flags.html" title="basic_stream_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_stream_socket/native_handle_type.html" title="basic_stream_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_stream_socket/native_type.html" title="basic_stream_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_stream_socket/non_blocking_io.html" title="basic_stream_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_stream_socket/protocol_type.html" title="basic_stream_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_stream_socket/receive_buffer_size.html" title="basic_stream_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_stream_socket/receive_low_watermark.html" title="basic_stream_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_stream_socket/reuse_address.html" title="basic_stream_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_stream_socket/send_buffer_size.html" title="basic_stream_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_stream_socket/send_low_watermark.html" title="basic_stream_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_stream_socket/service_type.html" title="basic_stream_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_stream_socket/shutdown_type.html" title="basic_stream_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.local__stream_protocol.socket.h1"></a>
  331. <span><a name="boost_asio.reference.local__stream_protocol.socket.member_functions"></a></span><a class="link" href="socket.html#boost_asio.reference.local__stream_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_stream_socket/assign.html" title="basic_stream_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_stream_socket/async_connect.html" title="basic_stream_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_stream_socket/async_read_some.html" title="basic_stream_socket::async_read_some"><span class="bold"><strong>async_read_some</strong></span></a>
  380. </p>
  381. </td>
  382. <td>
  383. <p>
  384. Start an asynchronous read.
  385. </p>
  386. </td>
  387. </tr>
  388. <tr>
  389. <td>
  390. <p>
  391. <a class="link" href="../basic_stream_socket/async_receive.html" title="basic_stream_socket::async_receive"><span class="bold"><strong>async_receive</strong></span></a>
  392. </p>
  393. </td>
  394. <td>
  395. <p>
  396. Start an asynchronous receive.
  397. </p>
  398. </td>
  399. </tr>
  400. <tr>
  401. <td>
  402. <p>
  403. <a class="link" href="../basic_stream_socket/async_send.html" title="basic_stream_socket::async_send"><span class="bold"><strong>async_send</strong></span></a>
  404. </p>
  405. </td>
  406. <td>
  407. <p>
  408. Start an asynchronous send.
  409. </p>
  410. </td>
  411. </tr>
  412. <tr>
  413. <td>
  414. <p>
  415. <a class="link" href="../basic_stream_socket/async_write_some.html" title="basic_stream_socket::async_write_some"><span class="bold"><strong>async_write_some</strong></span></a>
  416. </p>
  417. </td>
  418. <td>
  419. <p>
  420. Start an asynchronous write.
  421. </p>
  422. </td>
  423. </tr>
  424. <tr>
  425. <td>
  426. <p>
  427. <a class="link" href="../basic_stream_socket/at_mark.html" title="basic_stream_socket::at_mark"><span class="bold"><strong>at_mark</strong></span></a>
  428. </p>
  429. </td>
  430. <td>
  431. <p>
  432. Determine whether the socket is at the out-of-band data mark.
  433. </p>
  434. </td>
  435. </tr>
  436. <tr>
  437. <td>
  438. <p>
  439. <a class="link" href="../basic_stream_socket/available.html" title="basic_stream_socket::available"><span class="bold"><strong>available</strong></span></a>
  440. </p>
  441. </td>
  442. <td>
  443. <p>
  444. Determine the number of bytes available for reading.
  445. </p>
  446. </td>
  447. </tr>
  448. <tr>
  449. <td>
  450. <p>
  451. <a class="link" href="../basic_stream_socket/basic_stream_socket.html" title="basic_stream_socket::basic_stream_socket"><span class="bold"><strong>basic_stream_socket</strong></span></a>
  452. </p>
  453. </td>
  454. <td>
  455. <p>
  456. Construct a basic_stream_socket without opening it.
  457. </p>
  458. <p>
  459. Construct and open a basic_stream_socket.
  460. </p>
  461. <p>
  462. Construct a basic_stream_socket, opening it and binding it to
  463. the given local endpoint.
  464. </p>
  465. <p>
  466. Construct a basic_stream_socket on an existing native socket.
  467. </p>
  468. <p>
  469. Move-construct a basic_stream_socket from another.
  470. </p>
  471. </td>
  472. </tr>
  473. <tr>
  474. <td>
  475. <p>
  476. <a class="link" href="../basic_stream_socket/bind.html" title="basic_stream_socket::bind"><span class="bold"><strong>bind</strong></span></a>
  477. </p>
  478. </td>
  479. <td>
  480. <p>
  481. Bind the socket to the given local endpoint.
  482. </p>
  483. </td>
  484. </tr>
  485. <tr>
  486. <td>
  487. <p>
  488. <a class="link" href="../basic_stream_socket/cancel.html" title="basic_stream_socket::cancel"><span class="bold"><strong>cancel</strong></span></a>
  489. </p>
  490. </td>
  491. <td>
  492. <p>
  493. Cancel all asynchronous operations associated with the socket.
  494. </p>
  495. </td>
  496. </tr>
  497. <tr>
  498. <td>
  499. <p>
  500. <a class="link" href="../basic_stream_socket/close.html" title="basic_stream_socket::close"><span class="bold"><strong>close</strong></span></a>
  501. </p>
  502. </td>
  503. <td>
  504. <p>
  505. Close the socket.
  506. </p>
  507. </td>
  508. </tr>
  509. <tr>
  510. <td>
  511. <p>
  512. <a class="link" href="../basic_stream_socket/connect.html" title="basic_stream_socket::connect"><span class="bold"><strong>connect</strong></span></a>
  513. </p>
  514. </td>
  515. <td>
  516. <p>
  517. Connect the socket to the specified endpoint.
  518. </p>
  519. </td>
  520. </tr>
  521. <tr>
  522. <td>
  523. <p>
  524. <a class="link" href="../basic_stream_socket/get_io_service.html" title="basic_stream_socket::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
  525. </p>
  526. </td>
  527. <td>
  528. <p>
  529. Get the io_service associated with the object.
  530. </p>
  531. </td>
  532. </tr>
  533. <tr>
  534. <td>
  535. <p>
  536. <a class="link" href="../basic_stream_socket/get_option.html" title="basic_stream_socket::get_option"><span class="bold"><strong>get_option</strong></span></a>
  537. </p>
  538. </td>
  539. <td>
  540. <p>
  541. Get an option from the socket.
  542. </p>
  543. </td>
  544. </tr>
  545. <tr>
  546. <td>
  547. <p>
  548. <a class="link" href="../basic_stream_socket/io_control.html" title="basic_stream_socket::io_control"><span class="bold"><strong>io_control</strong></span></a>
  549. </p>
  550. </td>
  551. <td>
  552. <p>
  553. Perform an IO control command on the socket.
  554. </p>
  555. </td>
  556. </tr>
  557. <tr>
  558. <td>
  559. <p>
  560. <a class="link" href="../basic_stream_socket/is_open.html" title="basic_stream_socket::is_open"><span class="bold"><strong>is_open</strong></span></a>
  561. </p>
  562. </td>
  563. <td>
  564. <p>
  565. Determine whether the socket is open.
  566. </p>
  567. </td>
  568. </tr>
  569. <tr>
  570. <td>
  571. <p>
  572. <a class="link" href="../basic_stream_socket/local_endpoint.html" title="basic_stream_socket::local_endpoint"><span class="bold"><strong>local_endpoint</strong></span></a>
  573. </p>
  574. </td>
  575. <td>
  576. <p>
  577. Get the local endpoint of the socket.
  578. </p>
  579. </td>
  580. </tr>
  581. <tr>
  582. <td>
  583. <p>
  584. <a class="link" href="../basic_stream_socket/lowest_layer.html" title="basic_stream_socket::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a>
  585. </p>
  586. </td>
  587. <td>
  588. <p>
  589. Get a reference to the lowest layer.
  590. </p>
  591. <p>
  592. Get a const reference to the lowest layer.
  593. </p>
  594. </td>
  595. </tr>
  596. <tr>
  597. <td>
  598. <p>
  599. <a class="link" href="../basic_stream_socket/native.html" title="basic_stream_socket::native"><span class="bold"><strong>native</strong></span></a>
  600. </p>
  601. </td>
  602. <td>
  603. <p>
  604. (Deprecated: Use native_handle().) Get the native socket representation.
  605. </p>
  606. </td>
  607. </tr>
  608. <tr>
  609. <td>
  610. <p>
  611. <a class="link" href="../basic_stream_socket/native_handle.html" title="basic_stream_socket::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
  612. </p>
  613. </td>
  614. <td>
  615. <p>
  616. Get the native socket representation.
  617. </p>
  618. </td>
  619. </tr>
  620. <tr>
  621. <td>
  622. <p>
  623. <a class="link" href="../basic_stream_socket/native_non_blocking.html" title="basic_stream_socket::native_non_blocking"><span class="bold"><strong>native_non_blocking</strong></span></a>
  624. </p>
  625. </td>
  626. <td>
  627. <p>
  628. Gets the non-blocking mode of the native socket implementation.
  629. </p>
  630. <p>
  631. Sets the non-blocking mode of the native socket implementation.
  632. </p>
  633. </td>
  634. </tr>
  635. <tr>
  636. <td>
  637. <p>
  638. <a class="link" href="../basic_stream_socket/non_blocking.html" title="basic_stream_socket::non_blocking"><span class="bold"><strong>non_blocking</strong></span></a>
  639. </p>
  640. </td>
  641. <td>
  642. <p>
  643. Gets the non-blocking mode of the socket.
  644. </p>
  645. <p>
  646. Sets the non-blocking mode of the socket.
  647. </p>
  648. </td>
  649. </tr>
  650. <tr>
  651. <td>
  652. <p>
  653. <a class="link" href="../basic_stream_socket/open.html" title="basic_stream_socket::open"><span class="bold"><strong>open</strong></span></a>
  654. </p>
  655. </td>
  656. <td>
  657. <p>
  658. Open the socket using the specified protocol.
  659. </p>
  660. </td>
  661. </tr>
  662. <tr>
  663. <td>
  664. <p>
  665. <a class="link" href="../basic_stream_socket/operator_eq_.html" title="basic_stream_socket::operator="><span class="bold"><strong>operator=</strong></span></a>
  666. </p>
  667. </td>
  668. <td>
  669. <p>
  670. Move-assign a basic_stream_socket from another.
  671. </p>
  672. </td>
  673. </tr>
  674. <tr>
  675. <td>
  676. <p>
  677. <a class="link" href="../basic_stream_socket/read_some.html" title="basic_stream_socket::read_some"><span class="bold"><strong>read_some</strong></span></a>
  678. </p>
  679. </td>
  680. <td>
  681. <p>
  682. Read some data from the socket.
  683. </p>
  684. </td>
  685. </tr>
  686. <tr>
  687. <td>
  688. <p>
  689. <a class="link" href="../basic_stream_socket/receive.html" title="basic_stream_socket::receive"><span class="bold"><strong>receive</strong></span></a>
  690. </p>
  691. </td>
  692. <td>
  693. <p>
  694. Receive some data on the socket.
  695. </p>
  696. <p>
  697. Receive some data on a connected socket.
  698. </p>
  699. </td>
  700. </tr>
  701. <tr>
  702. <td>
  703. <p>
  704. <a class="link" href="../basic_stream_socket/remote_endpoint.html" title="basic_stream_socket::remote_endpoint"><span class="bold"><strong>remote_endpoint</strong></span></a>
  705. </p>
  706. </td>
  707. <td>
  708. <p>
  709. Get the remote endpoint of the socket.
  710. </p>
  711. </td>
  712. </tr>
  713. <tr>
  714. <td>
  715. <p>
  716. <a class="link" href="../basic_stream_socket/send.html" title="basic_stream_socket::send"><span class="bold"><strong>send</strong></span></a>
  717. </p>
  718. </td>
  719. <td>
  720. <p>
  721. Send some data on the socket.
  722. </p>
  723. </td>
  724. </tr>
  725. <tr>
  726. <td>
  727. <p>
  728. <a class="link" href="../basic_stream_socket/set_option.html" title="basic_stream_socket::set_option"><span class="bold"><strong>set_option</strong></span></a>
  729. </p>
  730. </td>
  731. <td>
  732. <p>
  733. Set an option on the socket.
  734. </p>
  735. </td>
  736. </tr>
  737. <tr>
  738. <td>
  739. <p>
  740. <a class="link" href="../basic_stream_socket/shutdown.html" title="basic_stream_socket::shutdown"><span class="bold"><strong>shutdown</strong></span></a>
  741. </p>
  742. </td>
  743. <td>
  744. <p>
  745. Disable sends or receives on the socket.
  746. </p>
  747. </td>
  748. </tr>
  749. <tr>
  750. <td>
  751. <p>
  752. <a class="link" href="../basic_stream_socket/write_some.html" title="basic_stream_socket::write_some"><span class="bold"><strong>write_some</strong></span></a>
  753. </p>
  754. </td>
  755. <td>
  756. <p>
  757. Write some data to the socket.
  758. </p>
  759. </td>
  760. </tr>
  761. </tbody>
  762. </table></div>
  763. <h6>
  764. <a name="boost_asio.reference.local__stream_protocol.socket.h2"></a>
  765. <span><a name="boost_asio.reference.local__stream_protocol.socket.protected_member_functions"></a></span><a class="link" href="socket.html#boost_asio.reference.local__stream_protocol.socket.protected_member_functions">Protected
  766. Member Functions</a>
  767. </h6>
  768. <div class="informaltable"><table class="table">
  769. <colgroup>
  770. <col>
  771. <col>
  772. </colgroup>
  773. <thead><tr>
  774. <th>
  775. <p>
  776. Name
  777. </p>
  778. </th>
  779. <th>
  780. <p>
  781. Description
  782. </p>
  783. </th>
  784. </tr></thead>
  785. <tbody>
  786. <tr>
  787. <td>
  788. <p>
  789. <a class="link" href="../basic_stream_socket/get_implementation.html" title="basic_stream_socket::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a>
  790. </p>
  791. </td>
  792. <td>
  793. <p>
  794. Get the underlying implementation of the I/O object.
  795. </p>
  796. </td>
  797. </tr>
  798. <tr>
  799. <td>
  800. <p>
  801. <a class="link" href="../basic_stream_socket/get_service.html" title="basic_stream_socket::get_service"><span class="bold"><strong>get_service</strong></span></a>
  802. </p>
  803. </td>
  804. <td>
  805. <p>
  806. Get the service associated with the I/O object.
  807. </p>
  808. </td>
  809. </tr>
  810. </tbody>
  811. </table></div>
  812. <h6>
  813. <a name="boost_asio.reference.local__stream_protocol.socket.h3"></a>
  814. <span><a name="boost_asio.reference.local__stream_protocol.socket.data_members"></a></span><a class="link" href="socket.html#boost_asio.reference.local__stream_protocol.socket.data_members">Data
  815. Members</a>
  816. </h6>
  817. <div class="informaltable"><table class="table">
  818. <colgroup>
  819. <col>
  820. <col>
  821. </colgroup>
  822. <thead><tr>
  823. <th>
  824. <p>
  825. Name
  826. </p>
  827. </th>
  828. <th>
  829. <p>
  830. Description
  831. </p>
  832. </th>
  833. </tr></thead>
  834. <tbody>
  835. <tr>
  836. <td>
  837. <p>
  838. <a class="link" href="../basic_stream_socket/max_connections.html" title="basic_stream_socket::max_connections"><span class="bold"><strong>max_connections</strong></span></a>
  839. </p>
  840. </td>
  841. <td>
  842. <p>
  843. The maximum length of the queue of pending incoming connections.
  844. </p>
  845. </td>
  846. </tr>
  847. <tr>
  848. <td>
  849. <p>
  850. <a class="link" href="../basic_stream_socket/message_do_not_route.html" title="basic_stream_socket::message_do_not_route"><span class="bold"><strong>message_do_not_route</strong></span></a>
  851. </p>
  852. </td>
  853. <td>
  854. <p>
  855. Specify that the data should not be subject to routing.
  856. </p>
  857. </td>
  858. </tr>
  859. <tr>
  860. <td>
  861. <p>
  862. <a class="link" href="../basic_stream_socket/message_end_of_record.html" title="basic_stream_socket::message_end_of_record"><span class="bold"><strong>message_end_of_record</strong></span></a>
  863. </p>
  864. </td>
  865. <td>
  866. <p>
  867. Specifies that the data marks the end of a record.
  868. </p>
  869. </td>
  870. </tr>
  871. <tr>
  872. <td>
  873. <p>
  874. <a class="link" href="../basic_stream_socket/message_out_of_band.html" title="basic_stream_socket::message_out_of_band"><span class="bold"><strong>message_out_of_band</strong></span></a>
  875. </p>
  876. </td>
  877. <td>
  878. <p>
  879. Process out-of-band data.
  880. </p>
  881. </td>
  882. </tr>
  883. <tr>
  884. <td>
  885. <p>
  886. <a class="link" href="../basic_stream_socket/message_peek.html" title="basic_stream_socket::message_peek"><span class="bold"><strong>message_peek</strong></span></a>
  887. </p>
  888. </td>
  889. <td>
  890. <p>
  891. Peek at incoming data without removing it from the input queue.
  892. </p>
  893. </td>
  894. </tr>
  895. </tbody>
  896. </table></div>
  897. <h6>
  898. <a name="boost_asio.reference.local__stream_protocol.socket.h4"></a>
  899. <span><a name="boost_asio.reference.local__stream_protocol.socket.protected_data_members"></a></span><a class="link" href="socket.html#boost_asio.reference.local__stream_protocol.socket.protected_data_members">Protected
  900. Data Members</a>
  901. </h6>
  902. <div class="informaltable"><table class="table">
  903. <colgroup>
  904. <col>
  905. <col>
  906. </colgroup>
  907. <thead><tr>
  908. <th>
  909. <p>
  910. Name
  911. </p>
  912. </th>
  913. <th>
  914. <p>
  915. Description
  916. </p>
  917. </th>
  918. </tr></thead>
  919. <tbody>
  920. <tr>
  921. <td>
  922. <p>
  923. <a class="link" href="../basic_stream_socket/implementation.html" title="basic_stream_socket::implementation"><span class="bold"><strong>implementation</strong></span></a>
  924. </p>
  925. </td>
  926. <td>
  927. <p>
  928. (Deprecated: Use get_implementation().) The underlying implementation
  929. of the I/O object.
  930. </p>
  931. </td>
  932. </tr>
  933. <tr>
  934. <td>
  935. <p>
  936. <a class="link" href="../basic_stream_socket/service.html" title="basic_stream_socket::service"><span class="bold"><strong>service</strong></span></a>
  937. </p>
  938. </td>
  939. <td>
  940. <p>
  941. (Deprecated: Use get_service().) The service associated with
  942. the I/O object.
  943. </p>
  944. </td>
  945. </tr>
  946. </tbody>
  947. </table></div>
  948. <p>
  949. The <a class="link" href="../basic_stream_socket.html" title="basic_stream_socket"><code class="computeroutput"><span class="identifier">basic_stream_socket</span></code></a> class template
  950. provides asynchronous and blocking stream-oriented socket functionality.
  951. </p>
  952. <h6>
  953. <a name="boost_asio.reference.local__stream_protocol.socket.h5"></a>
  954. <span><a name="boost_asio.reference.local__stream_protocol.socket.thread_safety"></a></span><a class="link" href="socket.html#boost_asio.reference.local__stream_protocol.socket.thread_safety">Thread
  955. Safety</a>
  956. </h6>
  957. <p>
  958. <span class="bold"><strong>Distinct</strong></span> <span class="bold"><strong>objects:</strong></span>
  959. Safe.
  960. </p>
  961. <p>
  962. <span class="bold"><strong>Shared</strong></span> <span class="bold"><strong>objects:</strong></span>
  963. Unsafe.
  964. </p>
  965. <h6>
  966. <a name="boost_asio.reference.local__stream_protocol.socket.h6"></a>
  967. <span><a name="boost_asio.reference.local__stream_protocol.socket.requirements"></a></span><a class="link" href="socket.html#boost_asio.reference.local__stream_protocol.socket.requirements">Requirements</a>
  968. </h6>
  969. <p>
  970. <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/local/stream_protocol.hpp</code>
  971. </p>
  972. <p>
  973. <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code>
  974. </p>
  975. </div>
  976. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  977. <td align="left"></td>
  978. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2012 Christopher M. Kohlhoff<p>
  979. Distributed under the Boost Software License, Version 1.0. (See accompanying
  980. 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>)
  981. </p>
  982. </div></td>
  983. </tr></table>
  984. <hr>
  985. <div class="spirit-nav">
  986. <a accesskey="p" href="protocol.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../local__stream_protocol.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  987. </div>
  988. </body>
  989. </html>