diff options
Diffstat (limited to 'doc/html/boost_asio/reference/write/overload16.html')
| -rw-r--r-- | doc/html/boost_asio/reference/write/overload16.html | 125 |
1 files changed, 125 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/write/overload16.html b/doc/html/boost_asio/reference/write/overload16.html new file mode 100644 index 0000000000..d483855dd4 --- /dev/null +++ b/doc/html/boost_asio/reference/write/overload16.html @@ -0,0 +1,125 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>write (16 of 16 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="../write.html" title="write"> +<link rel="prev" href="overload15.html" title="write (15 of 16 overloads)"> +<link rel="next" href="../write_at.html" title="write_at"> +</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="overload15.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write.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="../write_at.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.write.overload16"></a><a class="link" href="overload16.html" title="write (16 of 16 overloads)">write (16 of + 16 overloads)</a> +</h4></div></div></div> +<p> + Write a certain amount of data to a stream before returning. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../SyncWriteStream.html" title="Buffer-oriented synchronous write stream requirements">SyncWriteStream</a>, + typename <a class="link" href="../DynamicBuffer_v2.html" title="Dynamic buffer requirements (version 2)">DynamicBuffer_v2</a>, + typename <a class="link" href="../CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a>> +std::size_t write( + SyncWriteStream & s, + DynamicBuffer_v2 buffers, + CompletionCondition completion_condition, + boost::system::error_code & ec, + typename enable_if< is_dynamic_buffer_v2< DynamicBuffer_v2 >::value >::type * = 0); +</pre> +<p> + This function is used to write a certain number of bytes of data to a stream. + 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"> + All of the data in the supplied dynamic buffer sequence has been written. + </li> +<li class="listitem"> + The completion_condition function object returns 0. + </li> +</ul></div> +<p> + This operation is implemented in terms of zero or more calls to the stream's + write_some function. + </p> +<h6> +<a name="boost_asio.reference.write.overload16.h0"></a> + <span class="phrase"><a name="boost_asio.reference.write.overload16.parameters"></a></span><a class="link" href="overload16.html#boost_asio.reference.write.overload16.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 to which the data is to be written. The type must support + the SyncWriteStream concept. + </p></dd> +<dt><span class="term">buffers</span></dt> +<dd><p> + The dynamic buffer sequence from which data will be written. Successfully + written data is automatically consumed from the buffers. + </p></dd> +<dt><span class="term">completion_condition</span></dt> +<dd> +<p> + The function object to be called to determine whether the write operation + is complete. The signature of the function object must be: +</p> +<pre class="programlisting">std::size_t completion_condition( + // Result of latest write_some operation. + const boost::system::error_code& error, + + // Number of bytes transferred so far. + std::size_t bytes_transferred +); +</pre> +<p> + A return value of 0 indicates that the write operation is complete. + A non-zero return value indicates the maximum number of bytes to + be written on the next call to the stream's write_some function. + </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.write.overload16.h1"></a> + <span class="phrase"><a name="boost_asio.reference.write.overload16.return_value"></a></span><a class="link" href="overload16.html#boost_asio.reference.write.overload16.return_value">Return Value</a> + </h6> +<p> + The number of bytes written. If an error occurs, returns the total number + of bytes successfully transferred prior to the error. + </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 © 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="overload15.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write.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="../write_at.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |