doc/html/boost_asio/reference/ssl__stream/read_some/overload1.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>ssl::stream::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="ssl::stream::read_some">
   9 <link rel="prev" href="../read_some.html" title="ssl::stream::read_some">
  10 <link rel="next" href="overload2.html" title="ssl::stream::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.ssl__stream.read_some.overload1"></a><a class="link" href="overload1.html" title="ssl::stream::read_some (1 of 2 overloads)">ssl::stream::read_some
  28           (1 of 2 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Read some data from the stream.
  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. The function call
  40             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.ssl__stream.read_some.overload1.h0"></a>
  45             <span class="phrase"><a name="boost_asio.reference.ssl__stream.read_some.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.ssl__stream.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                   The buffers into which the data will be read.
  53                 </p></dd>
  54 </dl>
  55 </div>
  56 <h6>
  57 <a name="boost_asio.reference.ssl__stream.read_some.overload1.h1"></a>
  58             <span class="phrase"><a name="boost_asio.reference.ssl__stream.read_some.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.ssl__stream.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.ssl__stream.read_some.overload1.h2"></a>
  66             <span class="phrase"><a name="boost_asio.reference.ssl__stream.read_some.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.ssl__stream.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.
  74                 </p></dd>
  75 </dl>
  76 </div>
  77 <h6>
  78 <a name="boost_asio.reference.ssl__stream.read_some.overload1.h3"></a>
  79             <span class="phrase"><a name="boost_asio.reference.ssl__stream.read_some.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.ssl__stream.read_some.overload1.remarks">Remarks</a>
  80           </h6>
  81 <p>
  82             The read_some operation may not read all of the requested number of bytes.
  83             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
  84             ensure that the requested amount of data is read before the blocking
  85             operation completes.
  86           </p>
  87 </div>
  88 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  89 <td align="left"></td>
  90 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  91         Distributed under the Boost Software License, Version 1.0. (See accompanying
  92         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>)
  93       </p>
  94 </div></td>
  95 </tr></table>
  96 <hr>
  97 <div class="spirit-nav">
  98 <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>
  99 </div>
 100 </body>
 101 </html>