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