1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Buffer-oriented synchronous read stream requirements</title> 5<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../reference.html" title="Reference"> 9<link rel="prev" href="SyncRandomAccessWriteDevice.html" title="Buffer-oriented synchronous random-access write device requirements"> 10<link rel="next" href="SyncWriteStream.html" title="Buffer-oriented synchronous write stream requirements"> 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="SyncRandomAccessWriteDevice.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="SyncWriteStream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h3 class="title"> 27<a name="boost_asio.reference.SyncReadStream"></a><a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">Buffer-oriented 28 synchronous read stream requirements</a> 29</h3></div></div></div> 30<p> 31 A type <code class="computeroutput">X</code> meets the <code class="computeroutput">SyncReadStream</code> requirements 32 if it satisfies the requirements listed below. 33 </p> 34<p> 35 In the table below, <code class="computeroutput">a</code> denotes a value of type <code class="computeroutput">X</code>, 36 <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> 37 requirements, and <code class="computeroutput">ec</code> denotes an object of type <code class="computeroutput">error_code</code>. 38 </p> 39<div class="table"> 40<a name="boost_asio.reference.SyncReadStream.t0"></a><p class="title"><b>Table 30. SyncReadStream requirements</b></p> 41<div class="table-contents"><table class="table" summary="SyncReadStream requirements"> 42<colgroup> 43<col> 44<col> 45<col> 46</colgroup> 47<thead><tr> 48<th> 49 <p> 50 operation 51 </p> 52 </th> 53<th> 54 <p> 55 type 56 </p> 57 </th> 58<th> 59 <p> 60 semantics, pre/post-conditions 61 </p> 62 </th> 63</tr></thead> 64<tbody><tr> 65<td> 66 <p> 67 <code class="computeroutput">a.read_some(mb)</code><br> <code class="computeroutput">a.read_some(mb,ec)</code> 68 </p> 69 </td> 70<td> 71 <p> 72 <code class="computeroutput">size_t</code> 73 </p> 74 </td> 75<td> 76 <p> 77 Meets the requirements for a <a class="link" href="read_write_operations.html" title="Requirements on read and write operations">read 78 operation</a>.<br> <br> If <code class="computeroutput">buffer_size(mb) > 0</code>, 79 reads one or more bytes of data from the stream <code class="computeroutput">a</code> 80 into the buffer sequence <code class="computeroutput">mb</code>. If successful, sets 81 <code class="computeroutput">ec</code> such that <code class="computeroutput">!ec</code> is <code class="computeroutput">true</code>, 82 and returns the number of bytes read. If an error occurred, sets 83 <code class="computeroutput">ec</code> such that <code class="computeroutput">!!ec</code> is <code class="computeroutput">true</code>, 84 and returns 0. If all data has been read from the stream, and the 85 stream performed an orderly shutdown, sets <code class="computeroutput">ec</code> to 86 <code class="computeroutput">stream_errc::eof</code> and returns 0.<br> <br> If <code class="computeroutput">buffer_size(mb) 87 == 0</code>, the operation shall not block. Sets <code class="computeroutput">ec</code> 88 such that <code class="computeroutput">!ec</code> is <code class="computeroutput">true</code>, and returns 0. 89 </p> 90 </td> 91</tr></tbody> 92</table></div> 93</div> 94<br class="table-break"> 95</div> 96<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 97<td align="left"></td> 98<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 99 Kohlhoff<p> 100 Distributed under the Boost Software License, Version 1.0. (See accompanying 101 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>) 102 </p> 103</div></td> 104</tr></table> 105<hr> 106<div class="spirit-nav"> 107<a accesskey="p" href="SyncRandomAccessWriteDevice.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="SyncWriteStream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 108</div> 109</body> 110</html> 111
