doc/html/boost_asio/reference/read.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>read</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="../reference.html" title="Reference">
   9 <link rel="prev" href="raw_socket_service/shutdown.html" title="raw_socket_service::shutdown">
  10 <link rel="next" href="read/overload1.html" title="read (1 of 8 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="raw_socket_service/shutdown.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="read/overload1.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.read"></a><a class="link" href="read.html" title="read">read</a>
  28 </h3></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idp187240592"></a>
  31 Attempt to read a certain amount of data from a stream before returning.
  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="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a><span class="special">,</span>
  35     <span class="keyword">typename</span> <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">&gt;</span>
  36 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read/overload1.html" title="read (1 of 8 overloads)">read</a><span class="special">(</span>
  37     <span class="identifier">SyncReadStream</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
  38     <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">);</span>
  39   <span class="emphasis"><em>&#187; <a class="link" href="read/overload1.html" title="read (1 of 8 overloads)">more...</a></em></span>
  40
  41 <span class="keyword">template</span><span class="special">&lt;</span>
  42     <span class="keyword">typename</span> <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a><span class="special">,</span>
  43     <span class="keyword">typename</span> <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">&gt;</span>
  44 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read/overload2.html" title="read (2 of 8 overloads)">read</a><span class="special">(</span>
  45     <span class="identifier">SyncReadStream</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
  46     <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
  47     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  48   <span class="emphasis"><em>&#187; <a class="link" href="read/overload2.html" title="read (2 of 8 overloads)">more...</a></em></span>
  49
  50 <span class="keyword">template</span><span class="special">&lt;</span>
  51     <span class="keyword">typename</span> <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a><span class="special">,</span>
  52     <span class="keyword">typename</span> <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">,</span>
  53     <span class="keyword">typename</span> <span class="identifier">CompletionCondition</span><span class="special">&gt;</span>
  54 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read/overload3.html" title="read (3 of 8 overloads)">read</a><span class="special">(</span>
  55     <span class="identifier">SyncReadStream</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
  56     <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
  57     <span class="identifier">CompletionCondition</span> <span class="identifier">completion_condition</span><span class="special">);</span>
  58   <span class="emphasis"><em>&#187; <a class="link" href="read/overload3.html" title="read (3 of 8 overloads)">more...</a></em></span>
  59
  60 <span class="keyword">template</span><span class="special">&lt;</span>
  61     <span class="keyword">typename</span> <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a><span class="special">,</span>
  62     <span class="keyword">typename</span> <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">,</span>
  63     <span class="keyword">typename</span> <span class="identifier">CompletionCondition</span><span class="special">&gt;</span>
  64 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read/overload4.html" title="read (4 of 8 overloads)">read</a><span class="special">(</span>
  65     <span class="identifier">SyncReadStream</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
  66     <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
  67     <span class="identifier">CompletionCondition</span> <span class="identifier">completion_condition</span><span class="special">,</span>
  68     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  69   <span class="emphasis"><em>&#187; <a class="link" href="read/overload4.html" title="read (4 of 8 overloads)">more...</a></em></span>
  70
  71 <span class="keyword">template</span><span class="special">&lt;</span>
  72     <span class="keyword">typename</span> <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a><span class="special">,</span>
  73     <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
  74 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read/overload5.html" title="read (5 of 8 overloads)">read</a><span class="special">(</span>
  75     <span class="identifier">SyncReadStream</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
  76     <span class="identifier">basic_streambuf</span><span class="special">&lt;</span> <span class="identifier">Allocator</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">b</span><span class="special">);</span>
  77   <span class="emphasis"><em>&#187; <a class="link" href="read/overload5.html" title="read (5 of 8 overloads)">more...</a></em></span>
  78
  79 <span class="keyword">template</span><span class="special">&lt;</span>
  80     <span class="keyword">typename</span> <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a><span class="special">,</span>
  81     <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
  82 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read/overload6.html" title="read (6 of 8 overloads)">read</a><span class="special">(</span>
  83     <span class="identifier">SyncReadStream</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
  84     <span class="identifier">basic_streambuf</span><span class="special">&lt;</span> <span class="identifier">Allocator</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">b</span><span class="special">,</span>
  85     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  86   <span class="emphasis"><em>&#187; <a class="link" href="read/overload6.html" title="read (6 of 8 overloads)">more...</a></em></span>
  87
  88 <span class="keyword">template</span><span class="special">&lt;</span>
  89     <span class="keyword">typename</span> <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a><span class="special">,</span>
  90     <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
  91     <span class="keyword">typename</span> <span class="identifier">CompletionCondition</span><span class="special">&gt;</span>
  92 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read/overload7.html" title="read (7 of 8 overloads)">read</a><span class="special">(</span>
  93     <span class="identifier">SyncReadStream</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
  94     <span class="identifier">basic_streambuf</span><span class="special">&lt;</span> <span class="identifier">Allocator</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">b</span><span class="special">,</span>
  95     <span class="identifier">CompletionCondition</span> <span class="identifier">completion_condition</span><span class="special">);</span>
  96   <span class="emphasis"><em>&#187; <a class="link" href="read/overload7.html" title="read (7 of 8 overloads)">more...</a></em></span>
  97
  98 <span class="keyword">template</span><span class="special">&lt;</span>
  99     <span class="keyword">typename</span> <a class="link" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a><span class="special">,</span>
 100     <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
 101     <span class="keyword">typename</span> <span class="identifier">CompletionCondition</span><span class="special">&gt;</span>
 102 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read/overload8.html" title="read (8 of 8 overloads)">read</a><span class="special">(</span>
 103     <span class="identifier">SyncReadStream</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
 104     <span class="identifier">basic_streambuf</span><span class="special">&lt;</span> <span class="identifier">Allocator</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">b</span><span class="special">,</span>
 105     <span class="identifier">CompletionCondition</span> <span class="identifier">completion_condition</span><span class="special">,</span>
 106     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
 107   <span class="emphasis"><em>&#187; <a class="link" href="read/overload8.html" title="read (8 of 8 overloads)">more...</a></em></span>
 108 </pre>
 109 <h5>
 110 <a name="boost_asio.reference.read.h0"></a>
 111         <span class="phrase"><a name="boost_asio.reference.read.requirements"></a></span><a class="link" href="read.html#boost_asio.reference.read.requirements">Requirements</a>
 112       </h5>
 113 <p>
 114         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/read.hpp</code>
 115       </p>
 116 <p>
 117         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 118       </p>
 119 </div>
 120 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 121 <td align="left"></td>
 122 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
 123         Distributed under the Boost Software License, Version 1.0. (See accompanying
 124         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>)
 125       </p>
 126 </div></td>
 127 </tr></table>
 128 <hr>
 129 <div class="spirit-nav">
 130 <a accesskey="p" href="raw_socket_service/shutdown.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="read/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 131 </div>
 132 </body>
 133 </html>