diff options
Diffstat (limited to 'doc/html/boost_asio/reference/SyncReadStream.html')
| -rw-r--r-- | doc/html/boost_asio/reference/SyncReadStream.html | 75 |
1 files changed, 25 insertions, 50 deletions
diff --git a/doc/html/boost_asio/reference/SyncReadStream.html b/doc/html/boost_asio/reference/SyncReadStream.html index 5abc21755c..1a0fec8340 100644 --- a/doc/html/boost_asio/reference/SyncReadStream.html +++ b/doc/html/boost_asio/reference/SyncReadStream.html @@ -28,15 +28,17 @@ synchronous read stream requirements</a> </h3></div></div></div> <p> - In the table below, <code class="computeroutput"><span class="identifier">a</span></code> denotes - a synchronous read stream object, <code class="computeroutput"><span class="identifier">mb</span></code> - denotes an object satisfying <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">mutable - buffer sequence</a> requirements, and <code class="computeroutput"><span class="identifier">ec</span></code> - denotes an object of type <code class="computeroutput"><span class="identifier">error_code</span></code>. + A type <code class="computeroutput">X</code> meets the <code class="computeroutput">SyncReadStream</code> requirements + if it satisfies the requirements listed below. + </p> +<p> + In the table below, <code class="computeroutput">a</code> denotes a value of type <code class="computeroutput">X</code>, + <code class="computeroutput">mb</code> denotes a (possibly const) value satisfying the <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements"><code class="computeroutput">MutableBufferSequence</code></a> + requirements, and <code class="computeroutput">ec</code> denotes an object of type <code class="computeroutput">error_code</code>. </p> <div class="table"> -<a name="boost_asio.reference.SyncReadStream.t0"></a><p class="title"><b>Table 36. Buffer-oriented synchronous read stream requirements</b></p> -<div class="table-contents"><table class="table" summary="Buffer-oriented synchronous read stream requirements"> +<a name="boost_asio.reference.SyncReadStream.t0"></a><p class="title"><b>Table 28. SyncReadStream requirements</b></p> +<div class="table-contents"><table class="table" summary="SyncReadStream requirements"> <colgroup> <col> <col> @@ -59,61 +61,34 @@ </p> </th> </tr></thead> -<tbody> -<tr> -<td> - <p> - <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">read_some</span><span class="special">(</span><span class="identifier">mb</span><span class="special">);</span></code> - </p> - </td> -<td> - <p> - <code class="computeroutput"><span class="identifier">size_t</span></code> - </p> - </td> -<td> - <p> - Equivalent to: -</p> -<pre class="programlisting"><span class="identifier">error_code</span> <span class="identifier">ec</span><span class="special">;</span> -<span class="identifier">size_t</span> <span class="identifier">s</span> <span class="special">=</span> <span class="identifier">a</span><span class="special">.</span><span class="identifier">read_some</span><span class="special">(</span><span class="identifier">mb</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span> -<span class="keyword">if</span> <span class="special">(</span><span class="identifier">ec</span><span class="special">)</span> <span class="keyword">throw</span> <span class="identifier">system_error</span><span class="special">(</span><span class="identifier">ec</span><span class="special">);</span> -<span class="keyword">return</span> <span class="identifier">s</span><span class="special">;</span> -</pre> -<p> - </p> - </td> -</tr> -<tr> +<tbody><tr> <td> <p> - <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">read_some</span><span class="special">(</span><span class="identifier">mb</span><span class="special">,</span> - <span class="identifier">ec</span><span class="special">);</span></code> + <code class="computeroutput">a.read_some(mb)</code><br> <code class="computeroutput">a.read_some(mb,ec)</code> </p> </td> <td> <p> - <code class="computeroutput"><span class="identifier">size_t</span></code> + <code class="computeroutput">size_t</code> </p> </td> <td> <p> - Reads one or more bytes of data from the stream <code class="computeroutput"><span class="identifier">a</span></code>.<br> - <br> The mutable buffer sequence <code class="computeroutput"><span class="identifier">mb</span></code> - specifies memory where the data should be placed. The <code class="computeroutput"><span class="identifier">read_some</span></code> operation shall always - fill a buffer in the sequence completely before proceeding to the - next.<br> <br> If successful, returns the number of bytes read - and sets <code class="computeroutput"><span class="identifier">ec</span></code> such - that <code class="computeroutput"><span class="special">!</span><span class="identifier">ec</span></code> - is true. If an error occurred, returns <code class="computeroutput"><span class="number">0</span></code> - and sets <code class="computeroutput"><span class="identifier">ec</span></code> such - that <code class="computeroutput"><span class="special">!!</span><span class="identifier">ec</span></code> - is true.<br> <br> If the total size of all buffers in the sequence - <code class="computeroutput"><span class="identifier">mb</span></code> is <code class="computeroutput"><span class="number">0</span></code>, the function shall return <code class="computeroutput"><span class="number">0</span></code> immediately. + Meets the requirements for a <a class="link" href="read_write_operations.html" title="Requirements on read and write operations">read + operation</a>.<br> <br> If <code class="computeroutput">buffer_size(mb) > 0</code>, + reads one or more bytes of data from the stream <code class="computeroutput">a</code> + into the buffer sequence <code class="computeroutput">mb</code>. If successful, sets + <code class="computeroutput">ec</code> such that <code class="computeroutput">!ec</code> is <code class="computeroutput">true</code>, + and returns the number of bytes read. If an error occurred, sets + <code class="computeroutput">ec</code> such that <code class="computeroutput">!!ec</code> is <code class="computeroutput">true</code>, + and returns 0. If all data has been read from the stream, and the + stream performed an orderly shutdown, sets <code class="computeroutput">ec</code> to + <code class="computeroutput">stream_errc::eof</code> and returns 0.<br> <br> If <code class="computeroutput">buffer_size(mb) + == 0</code>, the operation shall not block. Sets <code class="computeroutput">ec</code> + such that <code class="computeroutput">!ec</code> is <code class="computeroutput">true</code>, and returns 0. </p> </td> -</tr> -</tbody> +</tr></tbody> </table></div> </div> <br class="table-break"> |