PageRenderTime 59ms CodeModel.GetById 25ms RepoModel.GetById 0ms app.codeStats 0ms

/boost_1_57_0/doc/html/boost_asio/reference/basic_stream_socket/read_some/overload1.html

http://github.com/MisterTea/HyperNEAT
HTML | 116 lines | 116 code | 0 blank | 0 comment | 0 complexity | 2e206c134e72910e0c1c344b80ca6ffc MD5 | raw file
Possible License(s): BSD-3-Clause, LGPL-3.0, GPL-3.0, GPL-2.0
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>basic_stream_socket::read_some (1 of 2 overloads)</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="../read_some.html" title="basic_stream_socket::read_some">
  9. <link rel="prev" href="../read_some.html" title="basic_stream_socket::read_some">
  10. <link rel="next" href="overload2.html" title="basic_stream_socket::read_some (2 of 2 overloads)">
  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="../read_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h5 class="title">
  27. <a name="boost_asio.reference.basic_stream_socket.read_some.overload1"></a><a class="link" href="overload1.html" title="basic_stream_socket::read_some (1 of 2 overloads)">basic_stream_socket::read_some
  28. (1 of 2 overloads)</a>
  29. </h5></div></div></div>
  30. <p>
  31. Read some data from the socket.
  32. </p>
  33. <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  34. <span class="keyword">typename</span> <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">&gt;</span>
  35. <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">read_some</span><span class="special">(</span>
  36. <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">);</span>
  37. </pre>
  38. <p>
  39. This function is used to read data from the stream socket. The function
  40. call will block until one or more bytes of data has been read successfully,
  41. or until an error occurs.
  42. </p>
  43. <h6>
  44. <a name="boost_asio.reference.basic_stream_socket.read_some.overload1.h0"></a>
  45. <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.read_some.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.read_some.overload1.parameters">Parameters</a>
  46. </h6>
  47. <div class="variablelist">
  48. <p class="title"><b></b></p>
  49. <dl class="variablelist">
  50. <dt><span class="term">buffers</span></dt>
  51. <dd><p>
  52. One or more buffers into which the data will be read.
  53. </p></dd>
  54. </dl>
  55. </div>
  56. <h6>
  57. <a name="boost_asio.reference.basic_stream_socket.read_some.overload1.h1"></a>
  58. <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.read_some.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.read_some.overload1.return_value">Return
  59. Value</a>
  60. </h6>
  61. <p>
  62. The number of bytes read.
  63. </p>
  64. <h6>
  65. <a name="boost_asio.reference.basic_stream_socket.read_some.overload1.h2"></a>
  66. <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.read_some.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.read_some.overload1.exceptions">Exceptions</a>
  67. </h6>
  68. <div class="variablelist">
  69. <p class="title"><b></b></p>
  70. <dl class="variablelist">
  71. <dt><span class="term">boost::system::system_error</span></dt>
  72. <dd><p>
  73. Thrown on failure. An error code of <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">eof</span></code>
  74. indicates that the connection was closed by the peer.
  75. </p></dd>
  76. </dl>
  77. </div>
  78. <h6>
  79. <a name="boost_asio.reference.basic_stream_socket.read_some.overload1.h3"></a>
  80. <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.read_some.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.read_some.overload1.remarks">Remarks</a>
  81. </h6>
  82. <p>
  83. The read_some operation may not read all of the requested number of bytes.
  84. Consider using the <a class="link" href="../../read.html" title="read"><code class="computeroutput"><span class="identifier">read</span></code></a> function if you need to
  85. ensure that the requested amount of data is read before the blocking
  86. operation completes.
  87. </p>
  88. <h6>
  89. <a name="boost_asio.reference.basic_stream_socket.read_some.overload1.h4"></a>
  90. <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.read_some.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.read_some.overload1.example">Example</a>
  91. </h6>
  92. <p>
  93. To read into a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> function as follows:
  94. </p>
  95. <pre class="programlisting"><span class="identifier">socket</span><span class="special">.</span><span class="identifier">read_some</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">size</span><span class="special">));</span>
  96. </pre>
  97. <p>
  98. See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a>
  99. documentation for information on reading into multiple buffers in one
  100. go, and how to use it with arrays, boost::array or std::vector.
  101. </p>
  102. </div>
  103. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  104. <td align="left"></td>
  105. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  106. Distributed under the Boost Software License, Version 1.0. (See accompanying
  107. 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>)
  108. </p>
  109. </div></td>
  110. </tr></table>
  111. <hr>
  112. <div class="spirit-nav">
  113. <a accesskey="p" href="../read_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  114. </div>
  115. </body>
  116. </html>