3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>basic_serial_port::async_write_some</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="../basic_serial_port.html" title="basic_serial_port">
9 <link rel="prev" href="async_read_some.html" title="basic_serial_port::async_read_some">
10 <link rel="next" href="basic_serial_port.html" title="basic_serial_port::basic_serial_port">
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="async_read_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_serial_port.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="basic_serial_port.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.basic_serial_port.async_write_some"></a><a class="link" href="async_write_some.html" title="basic_serial_port::async_write_some">basic_serial_port::async_write_some</a>
28 </h4></div></div></div>
30 <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.async_write_some"></a>
32 an asynchronous write.
34 <pre class="programlisting">template<
35 typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>,
36 typename <a class="link" href="../WriteHandler.html" title="Write handler requirements">WriteHandler</a> = <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>>
37 <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_write_some(
38 const ConstBufferSequence & buffers,
39 WriteHandler && handler = <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
42 This function is used to asynchronously write data to the serial port.
43 The function call always returns immediately.
46 <a name="boost_asio.reference.basic_serial_port.async_write_some.h0"></a>
47 <span class="phrase"><a name="boost_asio.reference.basic_serial_port.async_write_some.parameters"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.basic_serial_port.async_write_some.parameters">Parameters</a>
49 <div class="variablelist">
50 <p class="title"><b></b></p>
51 <dl class="variablelist">
52 <dt><span class="term">buffers</span></dt>
54 One or more data buffers to be written to the serial port. Although
55 the buffers object may be copied as necessary, ownership of the underlying
56 memory blocks is retained by the caller, which must guarantee that
57 they remain valid until the handler is called.
59 <dt><span class="term">handler</span></dt>
62 The handler to be called when the write operation completes. Copies
63 will be made of the handler as required. The function signature of
66 <pre class="programlisting">void handler(
67 const boost::system::error_code& error, // Result of operation.
68 std::size_t bytes_transferred // Number of bytes written.
72 Regardless of whether the asynchronous operation completes immediately
73 or not, the handler will not be invoked from within this function.
74 On immediate completion, invocation of the handler will be performed
75 in a manner equivalent to using <a class="link" href="../post.html" title="post"><code class="computeroutput">post</code></a>.
81 <a name="boost_asio.reference.basic_serial_port.async_write_some.h1"></a>
82 <span class="phrase"><a name="boost_asio.reference.basic_serial_port.async_write_some.remarks"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.basic_serial_port.async_write_some.remarks">Remarks</a>
85 The write operation may not transmit all of the data to the peer. Consider
86 using the <a class="link" href="../async_write.html" title="async_write"><code class="computeroutput">async_write</code></a>
87 function if you need to ensure that all data is written before the asynchronous
91 <a name="boost_asio.reference.basic_serial_port.async_write_some.h2"></a>
92 <span class="phrase"><a name="boost_asio.reference.basic_serial_port.async_write_some.example"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.basic_serial_port.async_write_some.example">Example</a>
95 To write a single data buffer use the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
98 <pre class="programlisting">basic_serial_port.async_write_some(
99 boost::asio::buffer(data, size), handler);
102 See the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
103 documentation for information on writing multiple buffers in one go, and
104 how to use it with arrays, boost::array or std::vector.
107 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
108 <td align="left"></td>
109 <td align="right"><div class="copyright-footer">Copyright © 2003-2019 Christopher M. Kohlhoff<p>
110 Distributed under the Boost Software License, Version 1.0. (See accompanying
111 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>)
116 <div class="spirit-nav">
117 <a accesskey="p" href="async_read_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_serial_port.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="basic_serial_port.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>