1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>read_until (14 of 24 overloads)</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="../read_until.html" title="read_until"> 9<link rel="prev" href="overload13.html" title="read_until (13 of 24 overloads)"> 10<link rel="next" href="overload15.html" title="read_until (15 of 24 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="overload13.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="overload15.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<a name="boost_asio.reference.read_until.overload14"></a><a class="link" href="overload14.html" title="read_until (14 of 24 overloads)">read_until 28 (14 of 24 overloads)</a> 29</h4></div></div></div> 30<p> 31 Read data into a streambuf until some part of the data it contains matches 32 a regular expression. 33 </p> 34<pre class="programlisting">template< 35 typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>, 36 typename Allocator> 37std::size_t read_until( 38 SyncReadStream & s, 39 boost::asio::basic_streambuf< Allocator > & b, 40 const boost::regex & expr, 41 boost::system::error_code & ec); 42</pre> 43<p> 44 This function is used to read data into the specified streambuf until the 45 streambuf's get area contains some data that matches a regular expression. 46 The call will block until one of the following conditions is true: 47 </p> 48<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 49<li class="listitem"> 50 A substring of the streambuf's get area matches the regular expression. 51 </li> 52<li class="listitem"> 53 An error occurred. 54 </li> 55</ul></div> 56<p> 57 This operation is implemented in terms of zero or more calls to the stream's 58 read_some function. If the streambuf's get area already contains data that 59 matches the regular expression, the function returns immediately. 60 </p> 61<h6> 62<a name="boost_asio.reference.read_until.overload14.h0"></a> 63 <span class="phrase"><a name="boost_asio.reference.read_until.overload14.parameters"></a></span><a class="link" href="overload14.html#boost_asio.reference.read_until.overload14.parameters">Parameters</a> 64 </h6> 65<div class="variablelist"> 66<p class="title"><b></b></p> 67<dl class="variablelist"> 68<dt><span class="term">s</span></dt> 69<dd><p> 70 The stream from which the data is to be read. The type must support 71 the SyncReadStream concept. 72 </p></dd> 73<dt><span class="term">b</span></dt> 74<dd><p> 75 A streambuf object into which the data will be read. 76 </p></dd> 77<dt><span class="term">expr</span></dt> 78<dd><p> 79 The regular expression. 80 </p></dd> 81<dt><span class="term">ec</span></dt> 82<dd><p> 83 Set to indicate what error occurred, if any. 84 </p></dd> 85</dl> 86</div> 87<h6> 88<a name="boost_asio.reference.read_until.overload14.h1"></a> 89 <span class="phrase"><a name="boost_asio.reference.read_until.overload14.return_value"></a></span><a class="link" href="overload14.html#boost_asio.reference.read_until.overload14.return_value">Return 90 Value</a> 91 </h6> 92<p> 93 The number of bytes in the streambuf's get area up to and including the 94 substring that matches the regular expression. Returns 0 if an error occurred. 95 </p> 96<h6> 97<a name="boost_asio.reference.read_until.overload14.h2"></a> 98 <span class="phrase"><a name="boost_asio.reference.read_until.overload14.remarks"></a></span><a class="link" href="overload14.html#boost_asio.reference.read_until.overload14.remarks">Remarks</a> 99 </h6> 100<p> 101 After a successful read_until operation, the streambuf may contain additional 102 data beyond that which matched the regular expression. An application will 103 typically leave that data in the streambuf for a subsequent read_until 104 operation to examine. 105 </p> 106</div> 107<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 108<td align="left"></td> 109<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 110 Kohlhoff<p> 111 Distributed under the Boost Software License, Version 1.0. (See accompanying 112 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>) 113 </p> 114</div></td> 115</tr></table> 116<hr> 117<div class="spirit-nav"> 118<a accesskey="p" href="overload13.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="overload15.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 119</div> 120</body> 121</html> 122
