async_write_some.html
5.33 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::async_write_some</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="async_shutdown.html" title="ssl::stream::async_shutdown">
<link rel="next" href="executor_type.html" title="ssl::stream::executor_type">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="async_shutdown.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="executor_type.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.async_write_some"></a><a class="link" href="async_write_some.html" title="ssl::stream::async_write_some">ssl::stream::async_write_some</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.async_write_some"></a>
Start
an asynchronous write.
</p>
<pre class="programlisting">template<
typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>,
typename <a class="link" href="../WriteHandler.html" title="Write handler requirements">WriteHandler</a> = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>>
<a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_write_some(
const ConstBufferSequence & buffers,
WriteHandler && handler = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
</pre>
<p>
This function is used to asynchronously write one or more bytes of data
to the stream. The function call always returns immediately.
</p>
<h6>
<a name="asio.reference.ssl__stream.async_write_some.h0"></a>
<span><a name="asio.reference.ssl__stream.async_write_some.parameters"></a></span><a class="link" href="async_write_some.html#asio.reference.ssl__stream.async_write_some.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">buffers</span></dt>
<dd><p>
The data to be written to the stream. Although the buffers object
may be copied as necessary, ownership of the underlying buffers is
retained by the caller, which must guarantee that they remain valid
until the handler is called.
</p></dd>
<dt><span class="term">handler</span></dt>
<dd>
<p>
The handler to be called when the write operation completes. Copies
will be made of the handler as required. The equivalent function
signature of the handler must be:
</p>
<pre class="programlisting">void handler(
const asio::error_code& error, // Result of operation.
std::size_t bytes_transferred // Number of bytes written.
);
</pre>
<p>
</p>
</dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.async_write_some.h1"></a>
<span><a name="asio.reference.ssl__stream.async_write_some.remarks"></a></span><a class="link" href="async_write_some.html#asio.reference.ssl__stream.async_write_some.remarks">Remarks</a>
</h6>
<p>
The async_write_some operation may not transmit all of the data to the
peer. Consider using the <a class="link" href="../async_write.html" title="async_write"><code class="computeroutput">async_write</code></a>
function if you need to ensure that all data is written before the asynchronous
operation completes.
</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-2020 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="async_shutdown.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="executor_type.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>