• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>basic_stream::write_some (2 of 2 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="../../../../index.html" title="Chapter 1. Boost.Beast">
8<link rel="up" href="../write_some.html" title="basic_stream::write_some">
9<link rel="prev" href="overload1.html" title="basic_stream::write_some (1 of 2 overloads)">
10<link rel="next" href="../async_write_some.html" title="basic_stream::async_write_some">
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="overload1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../async_write_some.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h6 class="title">
27<a name="beast.ref.boost__beast__basic_stream.write_some.overload2"></a><a class="link" href="overload2.html" title="basic_stream::write_some (2 of 2 overloads)">basic_stream::write_some
28          (2 of 2 overloads)</a>
29</h6></div></div></div>
30<p>
31            Write some data.
32          </p>
33<h7><a name="beast.ref.boost__beast__basic_stream.write_some.overload2.h0"></a>
34            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.write_some.overload2.synopsis"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__basic_stream.write_some.overload2.synopsis">Synopsis</a>
35          </h7><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
36    <span class="keyword">class</span> <a href="../../../../../../../../doc/html/boost_asio/reference/ConstBufferSequence.html" target="_top"><span class="emphasis"><em>ConstBufferSequence</em></span></a><span class="special">&gt;</span>
37<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>
38<span class="identifier">write_some</span><span class="special">(</span>
39    <span class="identifier">ConstBufferSequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
40    <span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
41</pre>
42<h7><a name="beast.ref.boost__beast__basic_stream.write_some.overload2.h1"></a>
43            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.write_some.overload2.description"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__basic_stream.write_some.overload2.description">Description</a>
44          </h7><p>
45            This function is used to write some data to the stream. The call blocks
46            until one of the following is true:
47          </p>
48<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
49<li class="listitem">
50                One or more bytes are written to the stream.
51              </li>
52<li class="listitem">
53                An error occurs.
54              </li>
55</ul></div>
56<h7><a name="beast.ref.boost__beast__basic_stream.write_some.overload2.h2"></a>
57            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.write_some.overload2.parameters"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__basic_stream.write_some.overload2.parameters">Parameters</a>
58          </h7><div class="informaltable"><table class="table">
59<colgroup>
60<col>
61<col>
62</colgroup>
63<thead><tr>
64<th>
65                    <p>
66                      Name
67                    </p>
68                  </th>
69<th>
70                    <p>
71                      Description
72                    </p>
73                  </th>
74</tr></thead>
75<tbody>
76<tr>
77<td>
78                    <p>
79                      <code class="computeroutput"><span class="identifier">buffers</span></code>
80                    </p>
81                  </td>
82<td>
83                    <p>
84                      The buffers from which the data will be written. If the size
85                      of the buffers is zero bytes, the call always returns immediately
86                      with no error.
87                    </p>
88                  </td>
89</tr>
90<tr>
91<td>
92                    <p>
93                      <code class="computeroutput"><span class="identifier">ec</span></code>
94                    </p>
95                  </td>
96<td>
97                    <p>
98                      Set to indicate what error occurred, if any.
99                    </p>
100                  </td>
101</tr>
102</tbody>
103</table></div>
104<h7><a name="beast.ref.boost__beast__basic_stream.write_some.overload2.h3"></a>
105            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.write_some.overload2.return_value"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__basic_stream.write_some.overload2.return_value">Return
106            Value</a>
107          </h7><p>
108            The number of bytes written.
109          </p>
110<h7><a name="beast.ref.boost__beast__basic_stream.write_some.overload2.h4"></a>
111            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.write_some.overload2.exceptions"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__basic_stream.write_some.overload2.exceptions">Exceptions</a>
112          </h7><div class="informaltable"><table class="table">
113<colgroup>
114<col>
115<col>
116</colgroup>
117<thead><tr>
118<th>
119                    <p>
120                      Type
121                    </p>
122                  </th>
123<th>
124                    <p>
125                      Thrown On
126                    </p>
127                  </th>
128</tr></thead>
129<tbody><tr>
130<td>
131                    <p>
132                      <code class="computeroutput"><span class="identifier">system_error</span></code>
133                    </p>
134                  </td>
135<td>
136                    <p>
137                      Thrown on failure.
138                    </p>
139                  </td>
140</tr></tbody>
141</table></div>
142<h7><a name="beast.ref.boost__beast__basic_stream.write_some.overload2.h5"></a>
143            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.write_some.overload2.remarks"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__basic_stream.write_some.overload2.remarks">Remarks</a>
144          </h7><p>
145            The <code class="computeroutput"><span class="identifier">write_some</span></code> operation
146            may not transmit all of the requested number of bytes. Consider using
147            the function <a class="link" href="../../boost__beast__file_mode.html" title="file_mode"><code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">write</span></code></a> if you need to ensure
148            that the requested amount of data is written before the blocking operation
149            completes.
150          </p>
151</div>
152<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
153<td align="left"></td>
154<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
155      Falco<p>
156        Distributed under the Boost Software License, Version 1.0. (See accompanying
157        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>)
158      </p>
159</div></td>
160</tr></table>
161<hr>
162<div class="spirit-nav">
163<a accesskey="p" href="overload1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../async_write_some.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
164</div>
165</body>
166</html>
167