doc/html/boost_asio/reference/async_read_until.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>async_read_until</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="async_read_at/overload4.html" title="async_read_at (4 of 4 overloads)">
  10 <link rel="next" href="async_read_until/overload1.html" title="async_read_until (1 of 4 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="async_read_at/overload4.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="async_read_until/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.async_read_until"></a><a class="link" href="async_read_until.html" title="async_read_until">async_read_until</a>
  28 </h3></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idp91257840"></a>
  31 Start an asynchronous operation to read data into a streambuf
  32         until it contains a delimiter, matches a regular expression, or a function
  33         object indicates a match.
  34       </p>
  35 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  36     <span class="keyword">typename</span> <a class="link" href="AsyncReadStream.html" title="Buffer-oriented asynchronous read stream requirements">AsyncReadStream</a><span class="special">,</span>
  37     <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
  38     <span class="keyword">typename</span> <a class="link" href="ReadHandler.html" title="Read handler requirements">ReadHandler</a><span class="special">&gt;</span>
  39 <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function"><span class="emphasis"><em>void-or-deduced</em></span></a> <a class="link" href="async_read_until/overload1.html" title="async_read_until (1 of 4 overloads)">async_read_until</a><span class="special">(</span>
  40     <span class="identifier">AsyncReadStream</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
  41     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><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>
  42     <span class="keyword">char</span> <span class="identifier">delim</span><span class="special">,</span>
  43     <span class="identifier">ReadHandler</span> <span class="identifier">handler</span><span class="special">);</span>
  44   <span class="emphasis"><em>&#187; <a class="link" href="async_read_until/overload1.html" title="async_read_until (1 of 4 overloads)">more...</a></em></span>
  45
  46 <span class="keyword">template</span><span class="special">&lt;</span>
  47     <span class="keyword">typename</span> <a class="link" href="AsyncReadStream.html" title="Buffer-oriented asynchronous read stream requirements">AsyncReadStream</a><span class="special">,</span>
  48     <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
  49     <span class="keyword">typename</span> <a class="link" href="ReadHandler.html" title="Read handler requirements">ReadHandler</a><span class="special">&gt;</span>
  50 <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function"><span class="emphasis"><em>void-or-deduced</em></span></a> <a class="link" href="async_read_until/overload2.html" title="async_read_until (2 of 4 overloads)">async_read_until</a><span class="special">(</span>
  51     <span class="identifier">AsyncReadStream</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
  52     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><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>
  53     <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> <span class="identifier">delim</span><span class="special">,</span>
  54     <span class="identifier">ReadHandler</span> <span class="identifier">handler</span><span class="special">);</span>
  55   <span class="emphasis"><em>&#187; <a class="link" href="async_read_until/overload2.html" title="async_read_until (2 of 4 overloads)">more...</a></em></span>
  56
  57 <span class="keyword">template</span><span class="special">&lt;</span>
  58     <span class="keyword">typename</span> <a class="link" href="AsyncReadStream.html" title="Buffer-oriented asynchronous read stream requirements">AsyncReadStream</a><span class="special">,</span>
  59     <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
  60     <span class="keyword">typename</span> <a class="link" href="ReadHandler.html" title="Read handler requirements">ReadHandler</a><span class="special">&gt;</span>
  61 <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function"><span class="emphasis"><em>void-or-deduced</em></span></a> <a class="link" href="async_read_until/overload3.html" title="async_read_until (3 of 4 overloads)">async_read_until</a><span class="special">(</span>
  62     <span class="identifier">AsyncReadStream</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
  63     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><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>
  64     <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">regex</span> <span class="special">&amp;</span> <span class="identifier">expr</span><span class="special">,</span>
  65     <span class="identifier">ReadHandler</span> <span class="identifier">handler</span><span class="special">);</span>
  66   <span class="emphasis"><em>&#187; <a class="link" href="async_read_until/overload3.html" title="async_read_until (3 of 4 overloads)">more...</a></em></span>
  67
  68 <span class="keyword">template</span><span class="special">&lt;</span>
  69     <span class="keyword">typename</span> <a class="link" href="AsyncReadStream.html" title="Buffer-oriented asynchronous read stream requirements">AsyncReadStream</a><span class="special">,</span>
  70     <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
  71     <span class="keyword">typename</span> <span class="identifier">MatchCondition</span><span class="special">,</span>
  72     <span class="keyword">typename</span> <a class="link" href="ReadHandler.html" title="Read handler requirements">ReadHandler</a><span class="special">&gt;</span>
  73 <a class="link" href="asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function"><span class="emphasis"><em>void-or-deduced</em></span></a> <a class="link" href="async_read_until/overload4.html" title="async_read_until (4 of 4 overloads)">async_read_until</a><span class="special">(</span>
  74     <span class="identifier">AsyncReadStream</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
  75     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><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>
  76     <span class="identifier">MatchCondition</span> <span class="identifier">match_condition</span><span class="special">,</span>
  77     <span class="identifier">ReadHandler</span> <span class="identifier">handler</span><span class="special">,</span>
  78     <span class="keyword">typename</span> <span class="identifier">enable_if</span><span class="special">&lt;</span> <span class="identifier">is_match_condition</span><span class="special">&lt;</span> <span class="identifier">MatchCondition</span> <span class="special">&gt;::</span><span class="identifier">value</span> <span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">*</span>  <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
  79   <span class="emphasis"><em>&#187; <a class="link" href="async_read_until/overload4.html" title="async_read_until (4 of 4 overloads)">more...</a></em></span>
  80 </pre>
  81 <h5>
  82 <a name="boost_asio.reference.async_read_until.h0"></a>
  83         <span class="phrase"><a name="boost_asio.reference.async_read_until.requirements"></a></span><a class="link" href="async_read_until.html#boost_asio.reference.async_read_until.requirements">Requirements</a>
  84       </h5>
  85 <p>
  86         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/read_until.hpp</code>
  87       </p>
  88 <p>
  89         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
  90       </p>
  91 </div>
  92 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  93 <td align="left"></td>
  94 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
  95         Distributed under the Boost Software License, Version 1.0. (See accompanying
  96         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>)
  97       </p>
  98 </div></td>
  99 </tr></table>
 100 <hr>
 101 <div class="spirit-nav">
 102 <a accesskey="p" href="async_read_at/overload4.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="async_read_until/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 103 </div>
 104 </body>
 105 </html>