3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>write (7 of 8 overloads)</title>
5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
8 <link rel="up" href="../write.html" title="write">
9 <link rel="prev" href="overload6.html" title="write (6 of 8 overloads)">
10 <link rel="next" href="overload8.html" title="write (8 of 8 overloads)">
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>
22 <div class="spirit-nav">
23 <a accesskey="p" href="overload6.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="overload8.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="titlepage"><div><div><h4 class="title">
27 <a name="boost_asio.reference.write.overload7"></a><a class="link" href="overload7.html" title="write (7 of 8 overloads)">write (7 of 8
29 </h4></div></div></div>
31 Write a certain amount of data to a stream before returning.
33 <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span>
34 <span class="keyword">typename</span> <a class="link" href="../SyncWriteStream.html" title="Buffer-oriented synchronous write stream requirements">SyncWriteStream</a><span class="special">,</span>
35 <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
36 <span class="keyword">typename</span> <span class="identifier">CompletionCondition</span><span class="special">></span>
37 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">write</span><span class="special">(</span>
38 <span class="identifier">SyncWriteStream</span> <span class="special">&</span> <span class="identifier">s</span><span class="special">,</span>
39 <span class="identifier">basic_streambuf</span><span class="special"><</span> <span class="identifier">Allocator</span> <span class="special">></span> <span class="special">&</span> <span class="identifier">b</span><span class="special">,</span>
40 <span class="identifier">CompletionCondition</span> <span class="identifier">completion_condition</span><span class="special">);</span>
43 This function is used to write a certain number of bytes of data to a stream.
44 The call will block until one of the following conditions is true:
46 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
48 All of the data in the supplied <a class="link" href="../basic_streambuf.html" title="basic_streambuf"><code class="computeroutput"><span class="identifier">basic_streambuf</span></code></a> has been written.
51 The completion_condition function object returns 0.
55 This operation is implemented in terms of zero or more calls to the stream's
59 <a name="boost_asio.reference.write.overload7.h0"></a>
60 <span class="phrase"><a name="boost_asio.reference.write.overload7.parameters"></a></span><a class="link" href="overload7.html#boost_asio.reference.write.overload7.parameters">Parameters</a>
62 <div class="variablelist">
63 <p class="title"><b></b></p>
64 <dl class="variablelist">
65 <dt><span class="term">s</span></dt>
67 The stream to which the data is to be written. The type must support
68 the SyncWriteStream concept.
70 <dt><span class="term">b</span></dt>
72 The <a class="link" href="../basic_streambuf.html" title="basic_streambuf"><code class="computeroutput"><span class="identifier">basic_streambuf</span></code></a> object from
73 which data will be written.
75 <dt><span class="term">completion_condition</span></dt>
78 The function object to be called to determine whether the write operation
79 is complete. The signature of the function object must be:
81 <pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">completion_condition</span><span class="special">(</span>
82 <span class="comment">// Result of latest write_some operation.</span>
83 <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">error</span><span class="special">,</span>
85 <span class="comment">// Number of bytes transferred so far.</span>
86 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span>
87 <span class="special">);</span>
90 A return value of 0 indicates that the write operation is complete.
91 A non-zero return value indicates the maximum number of bytes to
92 be written on the next call to the stream's write_some function.
98 <a name="boost_asio.reference.write.overload7.h1"></a>
99 <span class="phrase"><a name="boost_asio.reference.write.overload7.return_value"></a></span><a class="link" href="overload7.html#boost_asio.reference.write.overload7.return_value">Return
103 The number of bytes transferred.
106 <a name="boost_asio.reference.write.overload7.h2"></a>
107 <span class="phrase"><a name="boost_asio.reference.write.overload7.exceptions"></a></span><a class="link" href="overload7.html#boost_asio.reference.write.overload7.exceptions">Exceptions</a>
109 <div class="variablelist">
110 <p class="title"><b></b></p>
111 <dl class="variablelist">
112 <dt><span class="term">boost::system::system_error</span></dt>
119 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
120 <td align="left"></td>
121 <td align="right"><div class="copyright-footer">Copyright © 2003-2014 Christopher M. Kohlhoff<p>
122 Distributed under the Boost Software License, Version 1.0. (See accompanying
123 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>)
128 <div class="spirit-nav">
129 <a accesskey="p" href="overload6.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="overload8.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>