doc/html/boost_asio/reference/read_until/overload6.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>read_until (6 of 24 overloads)</title>
<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../read_until.html" title="read_until">
<link rel="prev" href="overload5.html" title="read_until (5 of 24 overloads)">
<link rel="next" href="overload7.html" title="read_until (7 of 24 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload5.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.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="overload7.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.read_until.overload6"></a><a class="link" href="overload6.html" title="read_until (6 of 24 overloads)">read_until
        (6 of 24 overloads)</a>
</h4></div></div></div>
<p>
          Read data into a dynamic buffer sequence until some part of the data it
          contains matches a regular expression.
        </p>
<pre class="programlisting">template&lt;
    typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename <a class="link" href="../DynamicBuffer_v1.html" title="Dynamic buffer requirements (version 1)">DynamicBuffer_v1</a>&gt;
std::size_t read_until(
    SyncReadStream &amp; s,
    DynamicBuffer_v1 &amp;&amp; buffers,
    const boost::regex &amp; expr,
    boost::system::error_code &amp; ec,
    typename enable_if&lt; is_dynamic_buffer_v1&lt; typename decay&lt; DynamicBuffer_v1 &gt;::type &gt;::value &amp;&amp;!is_dynamic_buffer_v2&lt; typename decay&lt; DynamicBuffer_v1 &gt;::type &gt;::value &gt;::type *  = 0);
</pre>
<p>
          This function is used to read data into the specified dynamic buffer sequence
          until the dynamic buffer sequence's get area contains some data that matches
          a regular expression. The call will block until one of the following conditions
          is true:
        </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
              A substring of the dynamic buffer sequence's get area matches the regular
              expression.
            </li>
<li class="listitem">
              An error occurred.
            </li>
</ul></div>
<p>
          This operation is implemented in terms of zero or more calls to the stream's
          read_some function. If the dynamic buffer sequence's get area already contains
          data that matches the regular expression, the function returns immediately.
        </p>
<h6>
<a name="boost_asio.reference.read_until.overload6.h0"></a>
          <span class="phrase"><a name="boost_asio.reference.read_until.overload6.parameters"></a></span><a class="link" href="overload6.html#boost_asio.reference.read_until.overload6.parameters">Parameters</a>
        </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">s</span></dt>
<dd><p>
                The stream from which the data is to be read. The type must support
                the SyncReadStream concept.
              </p></dd>
<dt><span class="term">buffers</span></dt>
<dd><p>
                A dynamic buffer sequence into which the data will be read.
              </p></dd>
<dt><span class="term">expr</span></dt>
<dd><p>
                The regular expression.
              </p></dd>
<dt><span class="term">ec</span></dt>
<dd><p>
                Set to indicate what error occurred, if any.
              </p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.read_until.overload6.h1"></a>
          <span class="phrase"><a name="boost_asio.reference.read_until.overload6.return_value"></a></span><a class="link" href="overload6.html#boost_asio.reference.read_until.overload6.return_value">Return
          Value</a>
        </h6>
<p>
          The number of bytes in the dynamic buffer sequence's get area up to and
          including the substring that matches the regular expression. Returns 0
          if an error occurred.
        </p>
<h6>
<a name="boost_asio.reference.read_until.overload6.h2"></a>
          <span class="phrase"><a name="boost_asio.reference.read_until.overload6.remarks"></a></span><a class="link" href="overload6.html#boost_asio.reference.read_until.overload6.remarks">Remarks</a>
        </h6>
<p>
          After a successful read_until operation, the dynamic buffer sequence may
          contain additional data beyond that which matched the regular expression.
          An application will typically leave that data in the dynamic buffer sequence
          for a subsequent read_until operation to examine.
        </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload5.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.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="overload7.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>