diff options
Diffstat (limited to 'doc/html/boost_asio/reference/basic_serial_port')
50 files changed, 3931 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/basic_serial_port/_basic_serial_port.html b/doc/html/boost_asio/reference/basic_serial_port/_basic_serial_port.html new file mode 100644 index 0000000000..d08a06fda5 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/_basic_serial_port.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::~basic_serial_port</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="write_some/overload2.html" title="basic_serial_port::write_some (2 of 2 overloads)"> +<link rel="next" href="../basic_signal_set.html" title="basic_signal_set"> +</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="write_some/overload2.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_signal_set.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.basic_serial_port._basic_serial_port"></a><a class="link" href="_basic_serial_port.html" title="basic_serial_port::~basic_serial_port">basic_serial_port::~basic_serial_port</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port._basic_serial_port"></a> +Destroys + the serial port. + </p> +<pre class="programlisting">~basic_serial_port(); +</pre> +<p> + This function destroys the serial port, cancelling any outstanding asynchronous + wait operations associated with the serial port as if by calling <code class="computeroutput">cancel</code>. + </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="write_some/overload2.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_signal_set.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/assign.html b/doc/html/boost_asio/reference/basic_serial_port/assign.html new file mode 100644 index 0000000000..8801c402f5 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/assign.html @@ -0,0 +1,57 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::assign</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="../basic_serial_port.html" title="basic_serial_port"> +<link rel="next" href="assign/overload1.html" title="basic_serial_port::assign (1 of 2 overloads)"> +</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="../basic_serial_port.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="assign/overload1.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.basic_serial_port.assign"></a><a class="link" href="assign.html" title="basic_serial_port::assign">basic_serial_port::assign</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.assign"></a> +Assign + an existing native serial port to the serial port. + </p> +<pre class="programlisting">void <a class="link" href="assign/overload1.html" title="basic_serial_port::assign (1 of 2 overloads)">assign</a>( + const native_handle_type & native_serial_port); + <span class="emphasis"><em>» <a class="link" href="assign/overload1.html" title="basic_serial_port::assign (1 of 2 overloads)">more...</a></em></span> + +void <a class="link" href="assign/overload2.html" title="basic_serial_port::assign (2 of 2 overloads)">assign</a>( + const native_handle_type & native_serial_port, + boost::system::error_code & ec); + <span class="emphasis"><em>» <a class="link" href="assign/overload2.html" title="basic_serial_port::assign (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="../basic_serial_port.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="assign/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/assign/overload1.html b/doc/html/boost_asio/reference/basic_serial_port/assign/overload1.html new file mode 100644 index 0000000000..0e6587c7b7 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/assign/overload1.html @@ -0,0 +1,50 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::assign (1 of 2 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="../assign.html" title="basic_serial_port::assign"> +<link rel="prev" href="../assign.html" title="basic_serial_port::assign"> +<link rel="next" href="overload2.html" title="basic_serial_port::assign (2 of 2 overloads)"> +</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="../assign.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../assign.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.assign.overload1"></a><a class="link" href="overload1.html" title="basic_serial_port::assign (1 of 2 overloads)">basic_serial_port::assign + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Assign an existing native serial port to the serial port. + </p> +<pre class="programlisting">void assign( + const native_handle_type & native_serial_port); +</pre> +</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="../assign.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../assign.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/assign/overload2.html b/doc/html/boost_asio/reference/basic_serial_port/assign/overload2.html new file mode 100644 index 0000000000..aae84aae5b --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/assign/overload2.html @@ -0,0 +1,51 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::assign (2 of 2 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="../assign.html" title="basic_serial_port::assign"> +<link rel="prev" href="overload1.html" title="basic_serial_port::assign (1 of 2 overloads)"> +<link rel="next" href="../async_read_some.html" title="basic_serial_port::async_read_some"> +</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../assign.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="../async_read_some.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.assign.overload2"></a><a class="link" href="overload2.html" title="basic_serial_port::assign (2 of 2 overloads)">basic_serial_port::assign + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Assign an existing native serial port to the serial port. + </p> +<pre class="programlisting">void assign( + const native_handle_type & native_serial_port, + boost::system::error_code & ec); +</pre> +</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../assign.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="../async_read_some.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/async_read_some.html b/doc/html/boost_asio/reference/basic_serial_port/async_read_some.html new file mode 100644 index 0000000000..88cf0d124d --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/async_read_some.html @@ -0,0 +1,120 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::async_read_some</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="assign/overload2.html" title="basic_serial_port::assign (2 of 2 overloads)"> +<link rel="next" href="async_write_some.html" title="basic_serial_port::async_write_some"> +</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="assign/overload2.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="async_write_some.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.basic_serial_port.async_read_some"></a><a class="link" href="async_read_some.html" title="basic_serial_port::async_read_some">basic_serial_port::async_read_some</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.async_read_some"></a> +Start + an asynchronous read. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>, + typename <a class="link" href="../ReadHandler.html" title="Read handler requirements">ReadHandler</a>> +<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_read_some( + const MutableBufferSequence & buffers, + ReadHandler && handler); +</pre> +<p> + This function is used to asynchronously read data from the serial port. + The function call always returns immediately. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.async_read_some.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.async_read_some.parameters"></a></span><a class="link" href="async_read_some.html#boost_asio.reference.basic_serial_port.async_read_some.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more buffers into which the data will be read. Although the + buffers object may be copied as necessary, ownership of the underlying + memory blocks 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 read operation completes. Copies + will be made of the handler as required. The function signature of + the handler must be: +</p> +<pre class="programlisting">void handler( + const boost::system::error_code& error, // Result of operation. + std::size_t bytes_transferred // Number of bytes read. +); +</pre> +<p> + Regardless of whether the asynchronous operation completes immediately + or not, the handler will not be invoked from within this function. + On immediate completion, invocation of the handler will be performed + in a manner equivalent to using <a class="link" href="../post.html" title="post"><code class="computeroutput">post</code></a>. + </p> +</dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_serial_port.async_read_some.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.async_read_some.remarks"></a></span><a class="link" href="async_read_some.html#boost_asio.reference.basic_serial_port.async_read_some.remarks">Remarks</a> + </h6> +<p> + The read operation may not read all of the requested number of bytes. Consider + using the <a class="link" href="../async_read.html" title="async_read"><code class="computeroutput">async_read</code></a> + function if you need to ensure that the requested amount of data is read + before the asynchronous operation completes. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.async_read_some.h2"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.async_read_some.example"></a></span><a class="link" href="async_read_some.html#boost_asio.reference.basic_serial_port.async_read_some.example">Example</a> + </h6> +<p> + To read into a single data buffer use the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a> + function as follows: + </p> +<pre class="programlisting">basic_serial_port.async_read_some( + boost::asio::buffer(data, size), handler); +</pre> +<p> + See the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a> + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. + </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="assign/overload2.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="async_write_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/async_write_some.html b/doc/html/boost_asio/reference/basic_serial_port/async_write_some.html new file mode 100644 index 0000000000..2284c2d5c5 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/async_write_some.html @@ -0,0 +1,120 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::async_write_some</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="async_read_some.html" title="basic_serial_port::async_read_some"> +<link rel="next" href="basic_serial_port.html" title="basic_serial_port::basic_serial_port"> +</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="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> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<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> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.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#boost_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); +</pre> +<p> + This function is used to asynchronously write data to the serial port. + The function call always returns immediately. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.async_write_some.h0"></a> + <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> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more data buffers to be written to the serial port. Although + the buffers object may be copied as necessary, ownership of the underlying + memory blocks 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 function signature of + the handler must be: +</p> +<pre class="programlisting">void handler( + const boost::system::error_code& error, // Result of operation. + std::size_t bytes_transferred // Number of bytes written. +); +</pre> +<p> + Regardless of whether the asynchronous operation completes immediately + or not, the handler will not be invoked from within this function. + On immediate completion, invocation of the handler will be performed + in a manner equivalent to using <a class="link" href="../post.html" title="post"><code class="computeroutput">post</code></a>. + </p> +</dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_serial_port.async_write_some.h1"></a> + <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> + </h6> +<p> + The write 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> +<h6> +<a name="boost_asio.reference.basic_serial_port.async_write_some.h2"></a> + <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> + </h6> +<p> + To write a single data buffer use the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a> + function as follows: + </p> +<pre class="programlisting">basic_serial_port.async_write_some( + boost::asio::buffer(data, size), handler); +</pre> +<p> + See the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a> + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. + </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="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> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port.html b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port.html new file mode 100644 index 0000000000..d9cedbbaca --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port.html @@ -0,0 +1,114 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::basic_serial_port</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="async_write_some.html" title="basic_serial_port::async_write_some"> +<link rel="next" href="basic_serial_port/overload1.html" title="basic_serial_port::basic_serial_port (1 of 9 overloads)"> +</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="async_write_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/overload1.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.basic_serial_port.basic_serial_port"></a><a class="link" href="basic_serial_port.html" title="basic_serial_port::basic_serial_port">basic_serial_port::basic_serial_port</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.basic_serial_port"></a> +Construct + a <a class="link" href="../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> + without opening it. + </p> +<pre class="programlisting">explicit <a class="link" href="basic_serial_port/overload1.html" title="basic_serial_port::basic_serial_port (1 of 9 overloads)">basic_serial_port</a>( + const executor_type & ex); + <span class="emphasis"><em>» <a class="link" href="basic_serial_port/overload1.html" title="basic_serial_port::basic_serial_port (1 of 9 overloads)">more...</a></em></span> + +template< + typename ExecutionContext> +explicit <a class="link" href="basic_serial_port/overload2.html" title="basic_serial_port::basic_serial_port (2 of 9 overloads)">basic_serial_port</a>( + ExecutionContext & context, + typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value, basic_serial_port >::type * = 0); + <span class="emphasis"><em>» <a class="link" href="basic_serial_port/overload2.html" title="basic_serial_port::basic_serial_port (2 of 9 overloads)">more...</a></em></span> +</pre> +<p> + Construct and open a <a class="link" href="../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a>. + </p> +<pre class="programlisting"><a class="link" href="basic_serial_port/overload3.html" title="basic_serial_port::basic_serial_port (3 of 9 overloads)">basic_serial_port</a>( + const executor_type & ex, + const char * device); + <span class="emphasis"><em>» <a class="link" href="basic_serial_port/overload3.html" title="basic_serial_port::basic_serial_port (3 of 9 overloads)">more...</a></em></span> + +template< + typename ExecutionContext> +<a class="link" href="basic_serial_port/overload4.html" title="basic_serial_port::basic_serial_port (4 of 9 overloads)">basic_serial_port</a>( + ExecutionContext & context, + const char * device, + typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value >::type * = 0); + <span class="emphasis"><em>» <a class="link" href="basic_serial_port/overload4.html" title="basic_serial_port::basic_serial_port (4 of 9 overloads)">more...</a></em></span> + +<a class="link" href="basic_serial_port/overload5.html" title="basic_serial_port::basic_serial_port (5 of 9 overloads)">basic_serial_port</a>( + const executor_type & ex, + const std::string & device); + <span class="emphasis"><em>» <a class="link" href="basic_serial_port/overload5.html" title="basic_serial_port::basic_serial_port (5 of 9 overloads)">more...</a></em></span> + +template< + typename ExecutionContext> +<a class="link" href="basic_serial_port/overload6.html" title="basic_serial_port::basic_serial_port (6 of 9 overloads)">basic_serial_port</a>( + ExecutionContext & context, + const std::string & device, + typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value >::type * = 0); + <span class="emphasis"><em>» <a class="link" href="basic_serial_port/overload6.html" title="basic_serial_port::basic_serial_port (6 of 9 overloads)">more...</a></em></span> +</pre> +<p> + Construct a <a class="link" href="../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> + on an existing native serial port. + </p> +<pre class="programlisting"><a class="link" href="basic_serial_port/overload7.html" title="basic_serial_port::basic_serial_port (7 of 9 overloads)">basic_serial_port</a>( + const executor_type & ex, + const native_handle_type & native_serial_port); + <span class="emphasis"><em>» <a class="link" href="basic_serial_port/overload7.html" title="basic_serial_port::basic_serial_port (7 of 9 overloads)">more...</a></em></span> + +template< + typename ExecutionContext> +<a class="link" href="basic_serial_port/overload8.html" title="basic_serial_port::basic_serial_port (8 of 9 overloads)">basic_serial_port</a>( + ExecutionContext & context, + const native_handle_type & native_serial_port, + typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value >::type * = 0); + <span class="emphasis"><em>» <a class="link" href="basic_serial_port/overload8.html" title="basic_serial_port::basic_serial_port (8 of 9 overloads)">more...</a></em></span> +</pre> +<p> + Move-construct a <a class="link" href="../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> + from another. + </p> +<pre class="programlisting"><a class="link" href="basic_serial_port/overload9.html" title="basic_serial_port::basic_serial_port (9 of 9 overloads)">basic_serial_port</a>( + basic_serial_port && other); + <span class="emphasis"><em>» <a class="link" href="basic_serial_port/overload9.html" title="basic_serial_port::basic_serial_port (9 of 9 overloads)">more...</a></em></span> +</pre> +</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="async_write_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/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload1.html b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload1.html new file mode 100644 index 0000000000..849f773d90 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload1.html @@ -0,0 +1,69 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::basic_serial_port (1 of 9 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="../basic_serial_port.html" title="basic_serial_port::basic_serial_port"> +<link rel="prev" href="../basic_serial_port.html" title="basic_serial_port::basic_serial_port"> +<link rel="next" href="overload2.html" title="basic_serial_port::basic_serial_port (2 of 9 overloads)"> +</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="../basic_serial_port.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload1"></a><a class="link" href="overload1.html" title="basic_serial_port::basic_serial_port (1 of 9 overloads)">basic_serial_port::basic_serial_port + (1 of 9 overloads)</a> +</h5></div></div></div> +<p> + Construct a <a class="link" href="../../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> + without opening it. + </p> +<pre class="programlisting">basic_serial_port( + const executor_type & ex); +</pre> +<p> + This constructor creates a serial port without opening it. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.basic_serial_port.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">ex</span></dt> +<dd><p> + The I/O executor that the serial port will use, by default, to + dispatch handlers for any asynchronous operations performed on + the serial port. + </p></dd> +</dl> +</div> +</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="../basic_serial_port.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload2.html b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload2.html new file mode 100644 index 0000000000..8114172a1b --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload2.html @@ -0,0 +1,72 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::basic_serial_port (2 of 9 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="../basic_serial_port.html" title="basic_serial_port::basic_serial_port"> +<link rel="prev" href="overload1.html" title="basic_serial_port::basic_serial_port (1 of 9 overloads)"> +<link rel="next" href="overload3.html" title="basic_serial_port::basic_serial_port (3 of 9 overloads)"> +</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="overload1.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="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload2"></a><a class="link" href="overload2.html" title="basic_serial_port::basic_serial_port (2 of 9 overloads)">basic_serial_port::basic_serial_port + (2 of 9 overloads)</a> +</h5></div></div></div> +<p> + Construct a <a class="link" href="../../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> + without opening it. + </p> +<pre class="programlisting">template< + typename ExecutionContext> +basic_serial_port( + ExecutionContext & context, + typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value, basic_serial_port >::type * = 0); +</pre> +<p> + This constructor creates a serial port without opening it. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_serial_port.basic_serial_port.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">context</span></dt> +<dd><p> + An execution context which provides the I/O executor that the serial + port will use, by default, to dispatch handlers for any asynchronous + operations performed on the serial port. + </p></dd> +</dl> +</div> +</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="overload1.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="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload3.html b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload3.html new file mode 100644 index 0000000000..3dd79f3754 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload3.html @@ -0,0 +1,74 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::basic_serial_port (3 of 9 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="../basic_serial_port.html" title="basic_serial_port::basic_serial_port"> +<link rel="prev" href="overload2.html" title="basic_serial_port::basic_serial_port (2 of 9 overloads)"> +<link rel="next" href="overload4.html" title="basic_serial_port::basic_serial_port (4 of 9 overloads)"> +</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="overload2.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="overload4.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload3"></a><a class="link" href="overload3.html" title="basic_serial_port::basic_serial_port (3 of 9 overloads)">basic_serial_port::basic_serial_port + (3 of 9 overloads)</a> +</h5></div></div></div> +<p> + Construct and open a <a class="link" href="../../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a>. + </p> +<pre class="programlisting">basic_serial_port( + const executor_type & ex, + const char * device); +</pre> +<p> + This constructor creates and opens a serial port for the specified device + name. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload3.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_serial_port.basic_serial_port.overload3.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">ex</span></dt> +<dd><p> + The I/O executor that the serial port will use, by default, to + dispatch handlers for any asynchronous operations performed on + the serial port. + </p></dd> +<dt><span class="term">device</span></dt> +<dd><p> + The platform-specific device name for this serial port. + </p></dd> +</dl> +</div> +</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="overload2.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="overload4.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload4.html b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload4.html new file mode 100644 index 0000000000..7c595cb7f6 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload4.html @@ -0,0 +1,77 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::basic_serial_port (4 of 9 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="../basic_serial_port.html" title="basic_serial_port::basic_serial_port"> +<link rel="prev" href="overload3.html" title="basic_serial_port::basic_serial_port (3 of 9 overloads)"> +<link rel="next" href="overload5.html" title="basic_serial_port::basic_serial_port (5 of 9 overloads)"> +</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="overload3.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="overload5.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload4"></a><a class="link" href="overload4.html" title="basic_serial_port::basic_serial_port (4 of 9 overloads)">basic_serial_port::basic_serial_port + (4 of 9 overloads)</a> +</h5></div></div></div> +<p> + Construct and open a <a class="link" href="../../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a>. + </p> +<pre class="programlisting">template< + typename ExecutionContext> +basic_serial_port( + ExecutionContext & context, + const char * device, + typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value >::type * = 0); +</pre> +<p> + This constructor creates and opens a serial port for the specified device + name. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload4.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload4.parameters"></a></span><a class="link" href="overload4.html#boost_asio.reference.basic_serial_port.basic_serial_port.overload4.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">context</span></dt> +<dd><p> + An execution context which provides the I/O executor that the serial + port will use, by default, to dispatch handlers for any asynchronous + operations performed on the serial port. + </p></dd> +<dt><span class="term">device</span></dt> +<dd><p> + The platform-specific device name for this serial port. + </p></dd> +</dl> +</div> +</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="overload3.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="overload5.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload5.html b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload5.html new file mode 100644 index 0000000000..c2d07570eb --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload5.html @@ -0,0 +1,74 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::basic_serial_port (5 of 9 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="../basic_serial_port.html" title="basic_serial_port::basic_serial_port"> +<link rel="prev" href="overload4.html" title="basic_serial_port::basic_serial_port (4 of 9 overloads)"> +<link rel="next" href="overload6.html" title="basic_serial_port::basic_serial_port (6 of 9 overloads)"> +</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="overload4.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="overload6.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload5"></a><a class="link" href="overload5.html" title="basic_serial_port::basic_serial_port (5 of 9 overloads)">basic_serial_port::basic_serial_port + (5 of 9 overloads)</a> +</h5></div></div></div> +<p> + Construct and open a <a class="link" href="../../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a>. + </p> +<pre class="programlisting">basic_serial_port( + const executor_type & ex, + const std::string & device); +</pre> +<p> + This constructor creates and opens a serial port for the specified device + name. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload5.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload5.parameters"></a></span><a class="link" href="overload5.html#boost_asio.reference.basic_serial_port.basic_serial_port.overload5.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">ex</span></dt> +<dd><p> + The I/O executor that the serial port will use, by default, to + dispatch handlers for any asynchronous operations performed on + the serial port. + </p></dd> +<dt><span class="term">device</span></dt> +<dd><p> + The platform-specific device name for this serial port. + </p></dd> +</dl> +</div> +</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="overload4.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="overload6.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload6.html b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload6.html new file mode 100644 index 0000000000..ec053a23c9 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload6.html @@ -0,0 +1,77 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::basic_serial_port (6 of 9 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="../basic_serial_port.html" title="basic_serial_port::basic_serial_port"> +<link rel="prev" href="overload5.html" title="basic_serial_port::basic_serial_port (5 of 9 overloads)"> +<link rel="next" href="overload7.html" title="basic_serial_port::basic_serial_port (7 of 9 overloads)"> +</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="overload5.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="overload7.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload6"></a><a class="link" href="overload6.html" title="basic_serial_port::basic_serial_port (6 of 9 overloads)">basic_serial_port::basic_serial_port + (6 of 9 overloads)</a> +</h5></div></div></div> +<p> + Construct and open a <a class="link" href="../../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a>. + </p> +<pre class="programlisting">template< + typename ExecutionContext> +basic_serial_port( + ExecutionContext & context, + const std::string & device, + typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value >::type * = 0); +</pre> +<p> + This constructor creates and opens a serial port for the specified device + name. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload6.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload6.parameters"></a></span><a class="link" href="overload6.html#boost_asio.reference.basic_serial_port.basic_serial_port.overload6.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">context</span></dt> +<dd><p> + An execution context which provides the I/O executor that the serial + port will use, by default, to dispatch handlers for any asynchronous + operations performed on the serial port. + </p></dd> +<dt><span class="term">device</span></dt> +<dd><p> + The platform-specific device name for this serial port. + </p></dd> +</dl> +</div> +</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="overload5.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="overload7.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload7.html b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload7.html new file mode 100644 index 0000000000..5d558bfea6 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload7.html @@ -0,0 +1,88 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::basic_serial_port (7 of 9 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="../basic_serial_port.html" title="basic_serial_port::basic_serial_port"> +<link rel="prev" href="overload6.html" title="basic_serial_port::basic_serial_port (6 of 9 overloads)"> +<link rel="next" href="overload8.html" title="basic_serial_port::basic_serial_port (8 of 9 overloads)"> +</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="overload6.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="overload8.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload7"></a><a class="link" href="overload7.html" title="basic_serial_port::basic_serial_port (7 of 9 overloads)">basic_serial_port::basic_serial_port + (7 of 9 overloads)</a> +</h5></div></div></div> +<p> + Construct a <a class="link" href="../../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> + on an existing native serial port. + </p> +<pre class="programlisting">basic_serial_port( + const executor_type & ex, + const native_handle_type & native_serial_port); +</pre> +<p> + This constructor creates a serial port object to hold an existing native + serial port. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload7.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload7.parameters"></a></span><a class="link" href="overload7.html#boost_asio.reference.basic_serial_port.basic_serial_port.overload7.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">ex</span></dt> +<dd><p> + The I/O executor that the serial port will use, by default, to + dispatch handlers for any asynchronous operations performed on + the serial port. + </p></dd> +<dt><span class="term">native_serial_port</span></dt> +<dd><p> + A native serial port. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload7.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload7.exceptions"></a></span><a class="link" href="overload7.html#boost_asio.reference.basic_serial_port.basic_serial_port.overload7.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</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="overload6.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="overload8.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload8.html b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload8.html new file mode 100644 index 0000000000..7970e554fd --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload8.html @@ -0,0 +1,91 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::basic_serial_port (8 of 9 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="../basic_serial_port.html" title="basic_serial_port::basic_serial_port"> +<link rel="prev" href="overload7.html" title="basic_serial_port::basic_serial_port (7 of 9 overloads)"> +<link rel="next" href="overload9.html" title="basic_serial_port::basic_serial_port (9 of 9 overloads)"> +</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="overload7.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="overload9.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload8"></a><a class="link" href="overload8.html" title="basic_serial_port::basic_serial_port (8 of 9 overloads)">basic_serial_port::basic_serial_port + (8 of 9 overloads)</a> +</h5></div></div></div> +<p> + Construct a <a class="link" href="../../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> + on an existing native serial port. + </p> +<pre class="programlisting">template< + typename ExecutionContext> +basic_serial_port( + ExecutionContext & context, + const native_handle_type & native_serial_port, + typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value >::type * = 0); +</pre> +<p> + This constructor creates a serial port object to hold an existing native + serial port. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload8.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload8.parameters"></a></span><a class="link" href="overload8.html#boost_asio.reference.basic_serial_port.basic_serial_port.overload8.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">context</span></dt> +<dd><p> + An execution context which provides the I/O executor that the serial + port will use, by default, to dispatch handlers for any asynchronous + operations performed on the serial port. + </p></dd> +<dt><span class="term">native_serial_port</span></dt> +<dd><p> + A native serial port. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload8.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload8.exceptions"></a></span><a class="link" href="overload8.html#boost_asio.reference.basic_serial_port.basic_serial_port.overload8.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</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="overload7.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="overload9.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload9.html b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload9.html new file mode 100644 index 0000000000..be7a0be4b7 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/basic_serial_port/overload9.html @@ -0,0 +1,77 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::basic_serial_port (9 of 9 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="../basic_serial_port.html" title="basic_serial_port::basic_serial_port"> +<link rel="prev" href="overload8.html" title="basic_serial_port::basic_serial_port (8 of 9 overloads)"> +<link rel="next" href="../cancel.html" title="basic_serial_port::cancel"> +</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="overload8.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="../cancel.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload9"></a><a class="link" href="overload9.html" title="basic_serial_port::basic_serial_port (9 of 9 overloads)">basic_serial_port::basic_serial_port + (9 of 9 overloads)</a> +</h5></div></div></div> +<p> + Move-construct a <a class="link" href="../../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> + from another. + </p> +<pre class="programlisting">basic_serial_port( + basic_serial_port && other); +</pre> +<p> + This constructor moves a serial port from one object to another. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload9.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload9.parameters"></a></span><a class="link" href="overload9.html#boost_asio.reference.basic_serial_port.basic_serial_port.overload9.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">other</span></dt> +<dd><p> + The other <a class="link" href="../../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> + object from which the move will occur. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload9.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.basic_serial_port.overload9.remarks"></a></span><a class="link" href="overload9.html#boost_asio.reference.basic_serial_port.basic_serial_port.overload9.remarks">Remarks</a> + </h6> +<p> + Following the move, the moved-from object is in the same state as if + constructed using the <code class="computeroutput">basic_serial_port(const executor_type&)</code> + constructor. + </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="overload8.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="../cancel.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/cancel.html b/doc/html/boost_asio/reference/basic_serial_port/cancel.html new file mode 100644 index 0000000000..b3a8b8a6eb --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/cancel.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::cancel</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="basic_serial_port/overload9.html" title="basic_serial_port::basic_serial_port (9 of 9 overloads)"> +<link rel="next" href="cancel/overload1.html" title="basic_serial_port::cancel (1 of 2 overloads)"> +</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="basic_serial_port/overload9.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="cancel/overload1.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.basic_serial_port.cancel"></a><a class="link" href="cancel.html" title="basic_serial_port::cancel">basic_serial_port::cancel</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.cancel"></a> +Cancel + all asynchronous operations associated with the serial port. + </p> +<pre class="programlisting">void <a class="link" href="cancel/overload1.html" title="basic_serial_port::cancel (1 of 2 overloads)">cancel</a>(); + <span class="emphasis"><em>» <a class="link" href="cancel/overload1.html" title="basic_serial_port::cancel (1 of 2 overloads)">more...</a></em></span> + +void <a class="link" href="cancel/overload2.html" title="basic_serial_port::cancel (2 of 2 overloads)">cancel</a>( + boost::system::error_code & ec); + <span class="emphasis"><em>» <a class="link" href="cancel/overload2.html" title="basic_serial_port::cancel (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="basic_serial_port/overload9.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="cancel/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/cancel/overload1.html b/doc/html/boost_asio/reference/basic_serial_port/cancel/overload1.html new file mode 100644 index 0000000000..455c5aab31 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/cancel/overload1.html @@ -0,0 +1,67 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::cancel (1 of 2 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="../cancel.html" title="basic_serial_port::cancel"> +<link rel="prev" href="../cancel.html" title="basic_serial_port::cancel"> +<link rel="next" href="overload2.html" title="basic_serial_port::cancel (2 of 2 overloads)"> +</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="../cancel.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.cancel.overload1"></a><a class="link" href="overload1.html" title="basic_serial_port::cancel (1 of 2 overloads)">basic_serial_port::cancel + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Cancel all asynchronous operations associated with the serial port. + </p> +<pre class="programlisting">void cancel(); +</pre> +<p> + This function causes all outstanding asynchronous read or write operations + to finish immediately, and the handlers for cancelled operations will + be passed the <code class="computeroutput">boost::asio::error::operation_aborted</code> error. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.cancel.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.cancel.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.cancel.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</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="../cancel.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/cancel/overload2.html b/doc/html/boost_asio/reference/basic_serial_port/cancel/overload2.html new file mode 100644 index 0000000000..6c18d019ba --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/cancel/overload2.html @@ -0,0 +1,68 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::cancel (2 of 2 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="../cancel.html" title="basic_serial_port::cancel"> +<link rel="prev" href="overload1.html" title="basic_serial_port::cancel (1 of 2 overloads)"> +<link rel="next" href="../close.html" title="basic_serial_port::close"> +</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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="../close.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.cancel.overload2"></a><a class="link" href="overload2.html" title="basic_serial_port::cancel (2 of 2 overloads)">basic_serial_port::cancel + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Cancel all asynchronous operations associated with the serial port. + </p> +<pre class="programlisting">void cancel( + boost::system::error_code & ec); +</pre> +<p> + This function causes all outstanding asynchronous read or write operations + to finish immediately, and the handlers for cancelled operations will + be passed the <code class="computeroutput">boost::asio::error::operation_aborted</code> error. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.cancel.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.cancel.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_serial_port.cancel.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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="../close.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/close.html b/doc/html/boost_asio/reference/basic_serial_port/close.html new file mode 100644 index 0000000000..5d680ef48c --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/close.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::close</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="cancel/overload2.html" title="basic_serial_port::cancel (2 of 2 overloads)"> +<link rel="next" href="close/overload1.html" title="basic_serial_port::close (1 of 2 overloads)"> +</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="cancel/overload2.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="close/overload1.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.basic_serial_port.close"></a><a class="link" href="close.html" title="basic_serial_port::close">basic_serial_port::close</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.close"></a> +Close + the serial port. + </p> +<pre class="programlisting">void <a class="link" href="close/overload1.html" title="basic_serial_port::close (1 of 2 overloads)">close</a>(); + <span class="emphasis"><em>» <a class="link" href="close/overload1.html" title="basic_serial_port::close (1 of 2 overloads)">more...</a></em></span> + +void <a class="link" href="close/overload2.html" title="basic_serial_port::close (2 of 2 overloads)">close</a>( + boost::system::error_code & ec); + <span class="emphasis"><em>» <a class="link" href="close/overload2.html" title="basic_serial_port::close (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="cancel/overload2.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="close/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/close/overload1.html b/doc/html/boost_asio/reference/basic_serial_port/close/overload1.html new file mode 100644 index 0000000000..06e61f0df5 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/close/overload1.html @@ -0,0 +1,67 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::close (1 of 2 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="../close.html" title="basic_serial_port::close"> +<link rel="prev" href="../close.html" title="basic_serial_port::close"> +<link rel="next" href="overload2.html" title="basic_serial_port::close (2 of 2 overloads)"> +</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="../close.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../close.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.close.overload1"></a><a class="link" href="overload1.html" title="basic_serial_port::close (1 of 2 overloads)">basic_serial_port::close + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Close the serial port. + </p> +<pre class="programlisting">void close(); +</pre> +<p> + This function is used to close the serial port. Any asynchronous read + or write operations will be cancelled immediately, and will complete + with the <code class="computeroutput">boost::asio::error::operation_aborted</code> error. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.close.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.close.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.close.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</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="../close.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../close.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/close/overload2.html b/doc/html/boost_asio/reference/basic_serial_port/close/overload2.html new file mode 100644 index 0000000000..5a64ef425f --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/close/overload2.html @@ -0,0 +1,68 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::close (2 of 2 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="../close.html" title="basic_serial_port::close"> +<link rel="prev" href="overload1.html" title="basic_serial_port::close (1 of 2 overloads)"> +<link rel="next" href="../executor_type.html" title="basic_serial_port::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="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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../close.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="../executor_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.close.overload2"></a><a class="link" href="overload2.html" title="basic_serial_port::close (2 of 2 overloads)">basic_serial_port::close + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Close the serial port. + </p> +<pre class="programlisting">void close( + boost::system::error_code & ec); +</pre> +<p> + This function is used to close the serial port. Any asynchronous read + or write operations will be cancelled immediately, and will complete + with the <code class="computeroutput">boost::asio::error::operation_aborted</code> error. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.close.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.close.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_serial_port.close.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../close.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="../executor_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/executor_type.html b/doc/html/boost_asio/reference/basic_serial_port/executor_type.html new file mode 100644 index 0000000000..5baf99e77a --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/executor_type.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::executor_type</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="close/overload2.html" title="basic_serial_port::close (2 of 2 overloads)"> +<link rel="next" href="get_executor.html" title="basic_serial_port::get_executor"> +</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="close/overload2.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="get_executor.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.basic_serial_port.executor_type"></a><a class="link" href="executor_type.html" title="basic_serial_port::executor_type">basic_serial_port::executor_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.executor_type"></a> +The + type of the executor associated with the object. + </p> +<pre class="programlisting">typedef Executor executor_type; +</pre> +<h6> +<a name="boost_asio.reference.basic_serial_port.executor_type.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.executor_type.requirements"></a></span><a class="link" href="executor_type.html#boost_asio.reference.basic_serial_port.executor_type.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_serial_port.hpp</code> + </p> +<p> + <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> + </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="close/overload2.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="get_executor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/get_executor.html b/doc/html/boost_asio/reference/basic_serial_port/get_executor.html new file mode 100644 index 0000000000..325ea41ac9 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/get_executor.html @@ -0,0 +1,50 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::get_executor</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="executor_type.html" title="basic_serial_port::executor_type"> +<link rel="next" href="get_option.html" title="basic_serial_port::get_option"> +</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="executor_type.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="get_option.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.basic_serial_port.get_executor"></a><a class="link" href="get_executor.html" title="basic_serial_port::get_executor">basic_serial_port::get_executor</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.get_executor"></a> +Get + the executor associated with the object. + </p> +<pre class="programlisting">executor_type get_executor(); +</pre> +</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="executor_type.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="get_option.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/get_option.html b/doc/html/boost_asio/reference/basic_serial_port/get_option.html new file mode 100644 index 0000000000..4f4aa68434 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/get_option.html @@ -0,0 +1,61 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::get_option</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="get_executor.html" title="basic_serial_port::get_executor"> +<link rel="next" href="get_option/overload1.html" title="basic_serial_port::get_option (1 of 2 overloads)"> +</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="get_executor.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="get_option/overload1.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.basic_serial_port.get_option"></a><a class="link" href="get_option.html" title="basic_serial_port::get_option">basic_serial_port::get_option</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.get_option"></a> +Get + an option from the serial port. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../GettableSerialPortOption.html" title="Gettable serial port option requirements">GettableSerialPortOption</a>> +void <a class="link" href="get_option/overload1.html" title="basic_serial_port::get_option (1 of 2 overloads)">get_option</a>( + GettableSerialPortOption & option); + <span class="emphasis"><em>» <a class="link" href="get_option/overload1.html" title="basic_serial_port::get_option (1 of 2 overloads)">more...</a></em></span> + +template< + typename <a class="link" href="../GettableSerialPortOption.html" title="Gettable serial port option requirements">GettableSerialPortOption</a>> +void <a class="link" href="get_option/overload2.html" title="basic_serial_port::get_option (2 of 2 overloads)">get_option</a>( + GettableSerialPortOption & option, + boost::system::error_code & ec); + <span class="emphasis"><em>» <a class="link" href="get_option/overload2.html" title="basic_serial_port::get_option (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="get_executor.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="get_option/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/get_option/overload1.html b/doc/html/boost_asio/reference/basic_serial_port/get_option/overload1.html new file mode 100644 index 0000000000..43b614399c --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/get_option/overload1.html @@ -0,0 +1,82 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::get_option (1 of 2 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="../get_option.html" title="basic_serial_port::get_option"> +<link rel="prev" href="../get_option.html" title="basic_serial_port::get_option"> +<link rel="next" href="overload2.html" title="basic_serial_port::get_option (2 of 2 overloads)"> +</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="../get_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_option.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.get_option.overload1"></a><a class="link" href="overload1.html" title="basic_serial_port::get_option (1 of 2 overloads)">basic_serial_port::get_option + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Get an option from the serial port. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../../GettableSerialPortOption.html" title="Gettable serial port option requirements">GettableSerialPortOption</a>> +void get_option( + GettableSerialPortOption & option); +</pre> +<p> + This function is used to get the current value of an option on the serial + port. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.get_option.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.get_option.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.get_option.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">option</span></dt> +<dd><p> + The option value to be obtained from the serial port. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_serial_port.get_option.overload1.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.get_option.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.get_option.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</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="../get_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_option.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/get_option/overload2.html b/doc/html/boost_asio/reference/basic_serial_port/get_option/overload2.html new file mode 100644 index 0000000000..d1ac4718b2 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/get_option/overload2.html @@ -0,0 +1,74 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::get_option (2 of 2 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="../get_option.html" title="basic_serial_port::get_option"> +<link rel="prev" href="overload1.html" title="basic_serial_port::get_option (1 of 2 overloads)"> +<link rel="next" href="../is_open.html" title="basic_serial_port::is_open"> +</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_option.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="../is_open.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.get_option.overload2"></a><a class="link" href="overload2.html" title="basic_serial_port::get_option (2 of 2 overloads)">basic_serial_port::get_option + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Get an option from the serial port. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../../GettableSerialPortOption.html" title="Gettable serial port option requirements">GettableSerialPortOption</a>> +void get_option( + GettableSerialPortOption & option, + boost::system::error_code & ec); +</pre> +<p> + This function is used to get the current value of an option on the serial + port. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.get_option.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.get_option.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_serial_port.get_option.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">option</span></dt> +<dd><p> + The option value to be obtained from the serial port. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_option.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="../is_open.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/is_open.html b/doc/html/boost_asio/reference/basic_serial_port/is_open.html new file mode 100644 index 0000000000..84e1006f86 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/is_open.html @@ -0,0 +1,50 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::is_open</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="get_option/overload2.html" title="basic_serial_port::get_option (2 of 2 overloads)"> +<link rel="next" href="lowest_layer.html" title="basic_serial_port::lowest_layer"> +</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="get_option/overload2.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="lowest_layer.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.basic_serial_port.is_open"></a><a class="link" href="is_open.html" title="basic_serial_port::is_open">basic_serial_port::is_open</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.is_open"></a> +Determine + whether the serial port is open. + </p> +<pre class="programlisting">bool is_open() const; +</pre> +</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="get_option/overload2.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="lowest_layer.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/lowest_layer.html b/doc/html/boost_asio/reference/basic_serial_port/lowest_layer.html new file mode 100644 index 0000000000..f7dd9d1366 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/lowest_layer.html @@ -0,0 +1,57 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::lowest_layer</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="is_open.html" title="basic_serial_port::is_open"> +<link rel="next" href="lowest_layer/overload1.html" title="basic_serial_port::lowest_layer (1 of 2 overloads)"> +</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="is_open.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="lowest_layer/overload1.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.basic_serial_port.lowest_layer"></a><a class="link" href="lowest_layer.html" title="basic_serial_port::lowest_layer">basic_serial_port::lowest_layer</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.lowest_layer"></a> +Get + a reference to the lowest layer. + </p> +<pre class="programlisting">lowest_layer_type & <a class="link" href="lowest_layer/overload1.html" title="basic_serial_port::lowest_layer (1 of 2 overloads)">lowest_layer</a>(); + <span class="emphasis"><em>» <a class="link" href="lowest_layer/overload1.html" title="basic_serial_port::lowest_layer (1 of 2 overloads)">more...</a></em></span> +</pre> +<p> + Get a const reference to the lowest layer. + </p> +<pre class="programlisting">const lowest_layer_type & <a class="link" href="lowest_layer/overload2.html" title="basic_serial_port::lowest_layer (2 of 2 overloads)">lowest_layer</a>() const; + <span class="emphasis"><em>» <a class="link" href="lowest_layer/overload2.html" title="basic_serial_port::lowest_layer (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="is_open.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="lowest_layer/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/lowest_layer/overload1.html b/doc/html/boost_asio/reference/basic_serial_port/lowest_layer/overload1.html new file mode 100644 index 0000000000..d2ce3df3d6 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/lowest_layer/overload1.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::lowest_layer (1 of 2 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="../lowest_layer.html" title="basic_serial_port::lowest_layer"> +<link rel="prev" href="../lowest_layer.html" title="basic_serial_port::lowest_layer"> +<link rel="next" href="overload2.html" title="basic_serial_port::lowest_layer (2 of 2 overloads)"> +</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="../lowest_layer.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.lowest_layer.overload1"></a><a class="link" href="overload1.html" title="basic_serial_port::lowest_layer (1 of 2 overloads)">basic_serial_port::lowest_layer + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Get a reference to the lowest layer. + </p> +<pre class="programlisting">lowest_layer_type & lowest_layer(); +</pre> +<p> + This function returns a reference to the lowest layer in a stack of layers. + Since a <a class="link" href="../../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> + cannot contain any further layers, it simply returns a reference to itself. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.lowest_layer.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.lowest_layer.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.lowest_layer.overload1.return_value">Return + Value</a> + </h6> +<p> + A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. + </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="../lowest_layer.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/lowest_layer/overload2.html b/doc/html/boost_asio/reference/basic_serial_port/lowest_layer/overload2.html new file mode 100644 index 0000000000..50445b9d56 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/lowest_layer/overload2.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::lowest_layer (2 of 2 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="../lowest_layer.html" title="basic_serial_port::lowest_layer"> +<link rel="prev" href="overload1.html" title="basic_serial_port::lowest_layer (1 of 2 overloads)"> +<link rel="next" href="../lowest_layer_type.html" title="basic_serial_port::lowest_layer_type"> +</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.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="../lowest_layer_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.lowest_layer.overload2"></a><a class="link" href="overload2.html" title="basic_serial_port::lowest_layer (2 of 2 overloads)">basic_serial_port::lowest_layer + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Get a const reference to the lowest layer. + </p> +<pre class="programlisting">const lowest_layer_type & lowest_layer() const; +</pre> +<p> + This function returns a const reference to the lowest layer in a stack + of layers. Since a <a class="link" href="../../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> + cannot contain any further layers, it simply returns a reference to itself. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.lowest_layer.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.lowest_layer.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_serial_port.lowest_layer.overload2.return_value">Return + Value</a> + </h6> +<p> + A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. + </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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.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="../lowest_layer_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/lowest_layer_type.html b/doc/html/boost_asio/reference/basic_serial_port/lowest_layer_type.html new file mode 100644 index 0000000000..65b221b3ca --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/lowest_layer_type.html @@ -0,0 +1,381 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::lowest_layer_type</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="lowest_layer/overload2.html" title="basic_serial_port::lowest_layer (2 of 2 overloads)"> +<link rel="next" href="native_handle.html" title="basic_serial_port::native_handle"> +</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="lowest_layer/overload2.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="native_handle.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.basic_serial_port.lowest_layer_type"></a><a class="link" href="lowest_layer_type.html" title="basic_serial_port::lowest_layer_type">basic_serial_port::lowest_layer_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.lowest_layer_type"></a> +A + basic_basic_serial_port is always the lowest layer. + </p> +<pre class="programlisting">typedef basic_serial_port lowest_layer_type; +</pre> +<h6> +<a name="boost_asio.reference.basic_serial_port.lowest_layer_type.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.lowest_layer_type.types"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.basic_serial_port.lowest_layer_type.types">Types</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <a class="link" href="executor_type.html" title="basic_serial_port::executor_type"><span class="bold"><strong>executor_type</strong></span></a> + </p> + </td> +<td> + <p> + The type of the executor associated with the object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="lowest_layer_type.html" title="basic_serial_port::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a> + </p> + </td> +<td> + <p> + A basic_basic_serial_port is always the lowest layer. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="native_handle_type.html" title="basic_serial_port::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a> + </p> + </td> +<td> + <p> + The native representation of a serial port. + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="boost_asio.reference.basic_serial_port.lowest_layer_type.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.lowest_layer_type.member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.basic_serial_port.lowest_layer_type.member_functions">Member + Functions</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <a class="link" href="assign.html" title="basic_serial_port::assign"><span class="bold"><strong>assign</strong></span></a> + </p> + </td> +<td> + <p> + Assign an existing native serial port to the serial port. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="async_read_some.html" title="basic_serial_port::async_read_some"><span class="bold"><strong>async_read_some</strong></span></a> + </p> + </td> +<td> + <p> + Start an asynchronous read. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="async_write_some.html" title="basic_serial_port::async_write_some"><span class="bold"><strong>async_write_some</strong></span></a> + </p> + </td> +<td> + <p> + Start an asynchronous write. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="basic_serial_port.html" title="basic_serial_port::basic_serial_port"><span class="bold"><strong>basic_serial_port</strong></span></a> + </p> + </td> +<td> + <p> + Construct a basic_serial_port without opening it. <br> <span class="silver"> —</span><br> + Construct and open a basic_serial_port. <br> <span class="silver"> —</span><br> Construct + a basic_serial_port on an existing native serial port. <br> + <span class="silver"> —</span><br> Move-construct a basic_serial_port from another. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="cancel.html" title="basic_serial_port::cancel"><span class="bold"><strong>cancel</strong></span></a> + </p> + </td> +<td> + <p> + Cancel all asynchronous operations associated with the serial + port. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="close.html" title="basic_serial_port::close"><span class="bold"><strong>close</strong></span></a> + </p> + </td> +<td> + <p> + Close the serial port. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="get_executor.html" title="basic_serial_port::get_executor"><span class="bold"><strong>get_executor</strong></span></a> + </p> + </td> +<td> + <p> + Get the executor associated with the object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="get_option.html" title="basic_serial_port::get_option"><span class="bold"><strong>get_option</strong></span></a> + </p> + </td> +<td> + <p> + Get an option from the serial port. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="is_open.html" title="basic_serial_port::is_open"><span class="bold"><strong>is_open</strong></span></a> + </p> + </td> +<td> + <p> + Determine whether the serial port is open. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="lowest_layer.html" title="basic_serial_port::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a> + </p> + </td> +<td> + <p> + Get a reference to the lowest layer. <br> <span class="silver"> —</span><br> Get a const + reference to the lowest layer. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="native_handle.html" title="basic_serial_port::native_handle"><span class="bold"><strong>native_handle</strong></span></a> + </p> + </td> +<td> + <p> + Get the native serial port representation. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="open.html" title="basic_serial_port::open"><span class="bold"><strong>open</strong></span></a> + </p> + </td> +<td> + <p> + Open the serial port using the specified device name. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="operator_eq_.html" title="basic_serial_port::operator="><span class="bold"><strong>operator=</strong></span></a> + </p> + </td> +<td> + <p> + Move-assign a basic_serial_port from another. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="read_some.html" title="basic_serial_port::read_some"><span class="bold"><strong>read_some</strong></span></a> + </p> + </td> +<td> + <p> + Read some data from the serial port. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="send_break.html" title="basic_serial_port::send_break"><span class="bold"><strong>send_break</strong></span></a> + </p> + </td> +<td> + <p> + Send a break sequence to the serial port. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="set_option.html" title="basic_serial_port::set_option"><span class="bold"><strong>set_option</strong></span></a> + </p> + </td> +<td> + <p> + Set an option on the serial port. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="write_some.html" title="basic_serial_port::write_some"><span class="bold"><strong>write_some</strong></span></a> + </p> + </td> +<td> + <p> + Write some data to the serial port. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="_basic_serial_port.html" title="basic_serial_port::~basic_serial_port"><span class="bold"><strong>~basic_serial_port</strong></span></a> + </p> + </td> +<td> + <p> + Destroys the serial port. + </p> + </td> +</tr> +</tbody> +</table></div> +<p> + The <a class="link" href="../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> + class provides a wrapper over serial port functionality. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.lowest_layer_type.h2"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.lowest_layer_type.thread_safety"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.basic_serial_port.lowest_layer_type.thread_safety">Thread + Safety</a> + </h6> +<p> + <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe. + </p> +<p> + <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.lowest_layer_type.h3"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.lowest_layer_type.requirements"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.basic_serial_port.lowest_layer_type.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_serial_port.hpp</code> + </p> +<p> + <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> + </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="lowest_layer/overload2.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="native_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/native_handle.html b/doc/html/boost_asio/reference/basic_serial_port/native_handle.html new file mode 100644 index 0000000000..92904be1f1 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/native_handle.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::native_handle</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="lowest_layer_type.html" title="basic_serial_port::lowest_layer_type"> +<link rel="next" href="native_handle_type.html" title="basic_serial_port::native_handle_type"> +</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="lowest_layer_type.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="native_handle_type.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.basic_serial_port.native_handle"></a><a class="link" href="native_handle.html" title="basic_serial_port::native_handle">basic_serial_port::native_handle</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.native_handle"></a> +Get + the native serial port representation. + </p> +<pre class="programlisting">native_handle_type native_handle(); +</pre> +<p> + This function may be used to obtain the underlying representation of the + serial port. This is intended to allow access to native serial port functionality + that is not otherwise provided. + </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="lowest_layer_type.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="native_handle_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/native_handle_type.html b/doc/html/boost_asio/reference/basic_serial_port/native_handle_type.html new file mode 100644 index 0000000000..b700a42353 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/native_handle_type.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::native_handle_type</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="native_handle.html" title="basic_serial_port::native_handle"> +<link rel="next" href="open.html" title="basic_serial_port::open"> +</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="native_handle.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="open.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.basic_serial_port.native_handle_type"></a><a class="link" href="native_handle_type.html" title="basic_serial_port::native_handle_type">basic_serial_port::native_handle_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.native_handle_type"></a> +The + native representation of a serial port. + </p> +<pre class="programlisting">typedef implementation_defined native_handle_type; +</pre> +<h6> +<a name="boost_asio.reference.basic_serial_port.native_handle_type.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.native_handle_type.requirements"></a></span><a class="link" href="native_handle_type.html#boost_asio.reference.basic_serial_port.native_handle_type.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_serial_port.hpp</code> + </p> +<p> + <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> + </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="native_handle.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="open.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/open.html b/doc/html/boost_asio/reference/basic_serial_port/open.html new file mode 100644 index 0000000000..7283b6630e --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/open.html @@ -0,0 +1,57 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::open</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="native_handle_type.html" title="basic_serial_port::native_handle_type"> +<link rel="next" href="open/overload1.html" title="basic_serial_port::open (1 of 2 overloads)"> +</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="native_handle_type.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="open/overload1.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.basic_serial_port.open"></a><a class="link" href="open.html" title="basic_serial_port::open">basic_serial_port::open</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.open"></a> +Open the + serial port using the specified device name. + </p> +<pre class="programlisting">void <a class="link" href="open/overload1.html" title="basic_serial_port::open (1 of 2 overloads)">open</a>( + const std::string & device); + <span class="emphasis"><em>» <a class="link" href="open/overload1.html" title="basic_serial_port::open (1 of 2 overloads)">more...</a></em></span> + +void <a class="link" href="open/overload2.html" title="basic_serial_port::open (2 of 2 overloads)">open</a>( + const std::string & device, + boost::system::error_code & ec); + <span class="emphasis"><em>» <a class="link" href="open/overload2.html" title="basic_serial_port::open (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="native_handle_type.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="open/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/open/overload1.html b/doc/html/boost_asio/reference/basic_serial_port/open/overload1.html new file mode 100644 index 0000000000..3b41f16982 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/open/overload1.html @@ -0,0 +1,79 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::open (1 of 2 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="../open.html" title="basic_serial_port::open"> +<link rel="prev" href="../open.html" title="basic_serial_port::open"> +<link rel="next" href="overload2.html" title="basic_serial_port::open (2 of 2 overloads)"> +</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="../open.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../open.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.open.overload1"></a><a class="link" href="overload1.html" title="basic_serial_port::open (1 of 2 overloads)">basic_serial_port::open + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Open the serial port using the specified device name. + </p> +<pre class="programlisting">void open( + const std::string & device); +</pre> +<p> + This function opens the serial port for the specified device name. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.open.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.open.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.open.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">device</span></dt> +<dd><p> + The platform-specific device name. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_serial_port.open.overload1.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.open.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.open.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</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="../open.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../open.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/open/overload2.html b/doc/html/boost_asio/reference/basic_serial_port/open/overload2.html new file mode 100644 index 0000000000..8ac20feeff --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/open/overload2.html @@ -0,0 +1,72 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::open (2 of 2 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="../open.html" title="basic_serial_port::open"> +<link rel="prev" href="overload1.html" title="basic_serial_port::open (1 of 2 overloads)"> +<link rel="next" href="../operator_eq_.html" title="basic_serial_port::operator="> +</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../open.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="../operator_eq_.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.open.overload2"></a><a class="link" href="overload2.html" title="basic_serial_port::open (2 of 2 overloads)">basic_serial_port::open + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Open the serial port using the specified device name. + </p> +<pre class="programlisting">void open( + const std::string & device, + boost::system::error_code & ec); +</pre> +<p> + This function opens the serial port using the given platform-specific + device name. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.open.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.open.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_serial_port.open.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">device</span></dt> +<dd><p> + The platform-specific device name. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set the indicate what error occurred, if any. + </p></dd> +</dl> +</div> +</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../open.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="../operator_eq_.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/operator_eq_.html b/doc/html/boost_asio/reference/basic_serial_port/operator_eq_.html new file mode 100644 index 0000000000..70568007e2 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/operator_eq_.html @@ -0,0 +1,77 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::operator=</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="open/overload2.html" title="basic_serial_port::open (2 of 2 overloads)"> +<link rel="next" href="read_some.html" title="basic_serial_port::read_some"> +</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="open/overload2.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="read_some.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.basic_serial_port.operator_eq_"></a><a class="link" href="operator_eq_.html" title="basic_serial_port::operator=">basic_serial_port::operator=</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.operator_eq_"></a> +Move-assign + a <a class="link" href="../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> + from another. + </p> +<pre class="programlisting">basic_serial_port & operator=( + basic_serial_port && other); +</pre> +<p> + This assignment operator moves a serial port from one object to another. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.operator_eq_.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.operator_eq_.parameters"></a></span><a class="link" href="operator_eq_.html#boost_asio.reference.basic_serial_port.operator_eq_.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">other</span></dt> +<dd><p> + The other <a class="link" href="../basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> + object from which the move will occur. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_serial_port.operator_eq_.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.operator_eq_.remarks"></a></span><a class="link" href="operator_eq_.html#boost_asio.reference.basic_serial_port.operator_eq_.remarks">Remarks</a> + </h6> +<p> + Following the move, the moved-from object is in the same state as if constructed + using the <code class="computeroutput">basic_serial_port(const executor_type&)</code> constructor. + </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="open/overload2.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="read_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/read_some.html b/doc/html/boost_asio/reference/basic_serial_port/read_some.html new file mode 100644 index 0000000000..19780f4d09 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/read_some.html @@ -0,0 +1,61 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::read_some</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="operator_eq_.html" title="basic_serial_port::operator="> +<link rel="next" href="read_some/overload1.html" title="basic_serial_port::read_some (1 of 2 overloads)"> +</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="operator_eq_.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="read_some/overload1.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.basic_serial_port.read_some"></a><a class="link" href="read_some.html" title="basic_serial_port::read_some">basic_serial_port::read_some</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.read_some"></a> +Read + some data from the serial port. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>> +std::size_t <a class="link" href="read_some/overload1.html" title="basic_serial_port::read_some (1 of 2 overloads)">read_some</a>( + const MutableBufferSequence & buffers); + <span class="emphasis"><em>» <a class="link" href="read_some/overload1.html" title="basic_serial_port::read_some (1 of 2 overloads)">more...</a></em></span> + +template< + typename <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>> +std::size_t <a class="link" href="read_some/overload2.html" title="basic_serial_port::read_some (2 of 2 overloads)">read_some</a>( + const MutableBufferSequence & buffers, + boost::system::error_code & ec); + <span class="emphasis"><em>» <a class="link" href="read_some/overload2.html" title="basic_serial_port::read_some (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="operator_eq_.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="read_some/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/read_some/overload1.html b/doc/html/boost_asio/reference/basic_serial_port/read_some/overload1.html new file mode 100644 index 0000000000..6904c4389e --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/read_some/overload1.html @@ -0,0 +1,117 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::read_some (1 of 2 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="../read_some.html" title="basic_serial_port::read_some"> +<link rel="prev" href="../read_some.html" title="basic_serial_port::read_some"> +<link rel="next" href="overload2.html" title="basic_serial_port::read_some (2 of 2 overloads)"> +</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="../read_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.read_some.overload1"></a><a class="link" href="overload1.html" title="basic_serial_port::read_some (1 of 2 overloads)">basic_serial_port::read_some + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Read some data from the serial port. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>> +std::size_t read_some( + const MutableBufferSequence & buffers); +</pre> +<p> + This function is used to read data from the serial port. The function + call will block until one or more bytes of data has been read successfully, + or until an error occurs. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.read_some.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.read_some.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.read_some.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more buffers into which the data will be read. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_serial_port.read_some.overload1.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.read_some.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.read_some.overload1.return_value">Return + Value</a> + </h6> +<p> + The number of bytes read. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.read_some.overload1.h2"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.read_some.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.read_some.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. An error code of <code class="computeroutput">boost::asio::error::eof</code> + indicates that the connection was closed by the peer. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_serial_port.read_some.overload1.h3"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.read_some.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.read_some.overload1.remarks">Remarks</a> + </h6> +<p> + The read_some operation may not read all of the requested number of bytes. + Consider using the <a class="link" href="../../read.html" title="read"><code class="computeroutput">read</code></a> + function if you need to ensure that the requested amount of data is read + before the blocking operation completes. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.read_some.overload1.h4"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.read_some.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.read_some.overload1.example">Example</a> + </h6> +<p> + To read into a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a> + function as follows: + </p> +<pre class="programlisting">basic_serial_port.read_some(boost::asio::buffer(data, size)); +</pre> +<p> + See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a> + documentation for information on reading into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. + </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="../read_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/read_some/overload2.html b/doc/html/boost_asio/reference/basic_serial_port/read_some/overload2.html new file mode 100644 index 0000000000..462a43e17d --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/read_some/overload2.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::read_some (2 of 2 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="../read_some.html" title="basic_serial_port::read_some"> +<link rel="prev" href="overload1.html" title="basic_serial_port::read_some (1 of 2 overloads)"> +<link rel="next" href="../send_break.html" title="basic_serial_port::send_break"> +</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.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="../send_break.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.read_some.overload2"></a><a class="link" href="overload2.html" title="basic_serial_port::read_some (2 of 2 overloads)">basic_serial_port::read_some + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Read some data from the serial port. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>> +std::size_t read_some( + const MutableBufferSequence & buffers, + boost::system::error_code & ec); +</pre> +<p> + This function is used to read data from the serial port. The function + call will block until one or more bytes of data has been read successfully, + or until an error occurs. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.read_some.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.read_some.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_serial_port.read_some.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more buffers into which the data will be read. + </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.basic_serial_port.read_some.overload2.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.read_some.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_serial_port.read_some.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of bytes read. Returns 0 if an error occurred. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.read_some.overload2.h2"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.read_some.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_serial_port.read_some.overload2.remarks">Remarks</a> + </h6> +<p> + The read_some operation may not read all of the requested number of bytes. + Consider using the <a class="link" href="../../read.html" title="read"><code class="computeroutput">read</code></a> + function if you need to ensure that the requested amount of data is read + before the blocking 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-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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.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="../send_break.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/send_break.html b/doc/html/boost_asio/reference/basic_serial_port/send_break.html new file mode 100644 index 0000000000..93512cbe6b --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/send_break.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::send_break</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="read_some/overload2.html" title="basic_serial_port::read_some (2 of 2 overloads)"> +<link rel="next" href="send_break/overload1.html" title="basic_serial_port::send_break (1 of 2 overloads)"> +</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="read_some/overload2.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="send_break/overload1.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.basic_serial_port.send_break"></a><a class="link" href="send_break.html" title="basic_serial_port::send_break">basic_serial_port::send_break</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.send_break"></a> +Send + a break sequence to the serial port. + </p> +<pre class="programlisting">void <a class="link" href="send_break/overload1.html" title="basic_serial_port::send_break (1 of 2 overloads)">send_break</a>(); + <span class="emphasis"><em>» <a class="link" href="send_break/overload1.html" title="basic_serial_port::send_break (1 of 2 overloads)">more...</a></em></span> + +void <a class="link" href="send_break/overload2.html" title="basic_serial_port::send_break (2 of 2 overloads)">send_break</a>( + boost::system::error_code & ec); + <span class="emphasis"><em>» <a class="link" href="send_break/overload2.html" title="basic_serial_port::send_break (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="read_some/overload2.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="send_break/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/send_break/overload1.html b/doc/html/boost_asio/reference/basic_serial_port/send_break/overload1.html new file mode 100644 index 0000000000..22fb89107e --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/send_break/overload1.html @@ -0,0 +1,66 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::send_break (1 of 2 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="../send_break.html" title="basic_serial_port::send_break"> +<link rel="prev" href="../send_break.html" title="basic_serial_port::send_break"> +<link rel="next" href="overload2.html" title="basic_serial_port::send_break (2 of 2 overloads)"> +</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="../send_break.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../send_break.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.send_break.overload1"></a><a class="link" href="overload1.html" title="basic_serial_port::send_break (1 of 2 overloads)">basic_serial_port::send_break + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Send a break sequence to the serial port. + </p> +<pre class="programlisting">void send_break(); +</pre> +<p> + This function causes a break sequence of platform-specific duration to + be sent out the serial port. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.send_break.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.send_break.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.send_break.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</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="../send_break.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../send_break.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/send_break/overload2.html b/doc/html/boost_asio/reference/basic_serial_port/send_break/overload2.html new file mode 100644 index 0000000000..b8603fd13e --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/send_break/overload2.html @@ -0,0 +1,67 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::send_break (2 of 2 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="../send_break.html" title="basic_serial_port::send_break"> +<link rel="prev" href="overload1.html" title="basic_serial_port::send_break (1 of 2 overloads)"> +<link rel="next" href="../set_option.html" title="basic_serial_port::set_option"> +</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../send_break.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="../set_option.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.send_break.overload2"></a><a class="link" href="overload2.html" title="basic_serial_port::send_break (2 of 2 overloads)">basic_serial_port::send_break + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Send a break sequence to the serial port. + </p> +<pre class="programlisting">void send_break( + boost::system::error_code & ec); +</pre> +<p> + This function causes a break sequence of platform-specific duration to + be sent out the serial port. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.send_break.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.send_break.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_serial_port.send_break.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../send_break.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="../set_option.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/set_option.html b/doc/html/boost_asio/reference/basic_serial_port/set_option.html new file mode 100644 index 0000000000..0af767966b --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/set_option.html @@ -0,0 +1,61 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::set_option</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="send_break/overload2.html" title="basic_serial_port::send_break (2 of 2 overloads)"> +<link rel="next" href="set_option/overload1.html" title="basic_serial_port::set_option (1 of 2 overloads)"> +</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="send_break/overload2.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="set_option/overload1.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.basic_serial_port.set_option"></a><a class="link" href="set_option.html" title="basic_serial_port::set_option">basic_serial_port::set_option</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.set_option"></a> +Set + an option on the serial port. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../SettableSerialPortOption.html" title="Settable serial port option requirements">SettableSerialPortOption</a>> +void <a class="link" href="set_option/overload1.html" title="basic_serial_port::set_option (1 of 2 overloads)">set_option</a>( + const SettableSerialPortOption & option); + <span class="emphasis"><em>» <a class="link" href="set_option/overload1.html" title="basic_serial_port::set_option (1 of 2 overloads)">more...</a></em></span> + +template< + typename <a class="link" href="../SettableSerialPortOption.html" title="Settable serial port option requirements">SettableSerialPortOption</a>> +void <a class="link" href="set_option/overload2.html" title="basic_serial_port::set_option (2 of 2 overloads)">set_option</a>( + const SettableSerialPortOption & option, + boost::system::error_code & ec); + <span class="emphasis"><em>» <a class="link" href="set_option/overload2.html" title="basic_serial_port::set_option (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="send_break/overload2.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="set_option/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/set_option/overload1.html b/doc/html/boost_asio/reference/basic_serial_port/set_option/overload1.html new file mode 100644 index 0000000000..98792d9e7d --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/set_option/overload1.html @@ -0,0 +1,81 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::set_option (1 of 2 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="../set_option.html" title="basic_serial_port::set_option"> +<link rel="prev" href="../set_option.html" title="basic_serial_port::set_option"> +<link rel="next" href="overload2.html" title="basic_serial_port::set_option (2 of 2 overloads)"> +</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="../set_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set_option.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.set_option.overload1"></a><a class="link" href="overload1.html" title="basic_serial_port::set_option (1 of 2 overloads)">basic_serial_port::set_option + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Set an option on the serial port. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../../SettableSerialPortOption.html" title="Settable serial port option requirements">SettableSerialPortOption</a>> +void set_option( + const SettableSerialPortOption & option); +</pre> +<p> + This function is used to set an option on the serial port. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.set_option.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.set_option.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.set_option.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">option</span></dt> +<dd><p> + The option value to be set on the serial port. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_serial_port.set_option.overload1.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.set_option.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.set_option.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</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="../set_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set_option.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/set_option/overload2.html b/doc/html/boost_asio/reference/basic_serial_port/set_option/overload2.html new file mode 100644 index 0000000000..c32057cc03 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/set_option/overload2.html @@ -0,0 +1,73 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::set_option (2 of 2 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="../set_option.html" title="basic_serial_port::set_option"> +<link rel="prev" href="overload1.html" title="basic_serial_port::set_option (1 of 2 overloads)"> +<link rel="next" href="../write_some.html" title="basic_serial_port::write_some"> +</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set_option.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_some.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.set_option.overload2"></a><a class="link" href="overload2.html" title="basic_serial_port::set_option (2 of 2 overloads)">basic_serial_port::set_option + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Set an option on the serial port. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../../SettableSerialPortOption.html" title="Settable serial port option requirements">SettableSerialPortOption</a>> +void set_option( + const SettableSerialPortOption & option, + boost::system::error_code & ec); +</pre> +<p> + This function is used to set an option on the serial port. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.set_option.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.set_option.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_serial_port.set_option.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">option</span></dt> +<dd><p> + The option value to be set on the serial port. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +</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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set_option.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_some.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/write_some.html b/doc/html/boost_asio/reference/basic_serial_port/write_some.html new file mode 100644 index 0000000000..bb857edfaa --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/write_some.html @@ -0,0 +1,61 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::write_some</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="../basic_serial_port.html" title="basic_serial_port"> +<link rel="prev" href="set_option/overload2.html" title="basic_serial_port::set_option (2 of 2 overloads)"> +<link rel="next" href="write_some/overload1.html" title="basic_serial_port::write_some (1 of 2 overloads)"> +</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="set_option/overload2.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="write_some/overload1.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.basic_serial_port.write_some"></a><a class="link" href="write_some.html" title="basic_serial_port::write_some">basic_serial_port::write_some</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.write_some"></a> +Write + some data to the serial port. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>> +std::size_t <a class="link" href="write_some/overload1.html" title="basic_serial_port::write_some (1 of 2 overloads)">write_some</a>( + const ConstBufferSequence & buffers); + <span class="emphasis"><em>» <a class="link" href="write_some/overload1.html" title="basic_serial_port::write_some (1 of 2 overloads)">more...</a></em></span> + +template< + typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>> +std::size_t <a class="link" href="write_some/overload2.html" title="basic_serial_port::write_some (2 of 2 overloads)">write_some</a>( + const ConstBufferSequence & buffers, + boost::system::error_code & ec); + <span class="emphasis"><em>» <a class="link" href="write_some/overload2.html" title="basic_serial_port::write_some (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="set_option/overload2.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="write_some/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/write_some/overload1.html b/doc/html/boost_asio/reference/basic_serial_port/write_some/overload1.html new file mode 100644 index 0000000000..a5a81ea589 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/write_some/overload1.html @@ -0,0 +1,117 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::write_some (1 of 2 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_some.html" title="basic_serial_port::write_some"> +<link rel="prev" href="../write_some.html" title="basic_serial_port::write_some"> +<link rel="next" href="overload2.html" title="basic_serial_port::write_some (2 of 2 overloads)"> +</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="../write_some.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="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.write_some.overload1"></a><a class="link" href="overload1.html" title="basic_serial_port::write_some (1 of 2 overloads)">basic_serial_port::write_some + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Write some data to the serial port. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>> +std::size_t write_some( + const ConstBufferSequence & buffers); +</pre> +<p> + This function is used to write data to the serial port. The function + call will block until one or more bytes of the data has been written + successfully, or until an error occurs. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.write_some.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.write_some.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.write_some.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more data buffers to be written to the serial port. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_serial_port.write_some.overload1.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.write_some.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.write_some.overload1.return_value">Return + Value</a> + </h6> +<p> + The number of bytes written. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.write_some.overload1.h2"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.write_some.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.write_some.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. An error code of <code class="computeroutput">boost::asio::error::eof</code> + indicates that the connection was closed by the peer. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_serial_port.write_some.overload1.h3"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.write_some.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.write_some.overload1.remarks">Remarks</a> + </h6> +<p> + The write_some operation may not transmit all of the data to the peer. + Consider using the <a class="link" href="../../write.html" title="write"><code class="computeroutput">write</code></a> + function if you need to ensure that all data is written before the blocking + operation completes. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.write_some.overload1.h4"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.write_some.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_serial_port.write_some.overload1.example">Example</a> + </h6> +<p> + To write a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a> + function as follows: + </p> +<pre class="programlisting">basic_serial_port.write_some(boost::asio::buffer(data, size)); +</pre> +<p> + See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a> + documentation for information on writing multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. + </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="../write_some.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="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_serial_port/write_some/overload2.html b/doc/html/boost_asio/reference/basic_serial_port/write_some/overload2.html new file mode 100644 index 0000000000..ea73f927c0 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_serial_port/write_some/overload2.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_serial_port::write_some (2 of 2 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_some.html" title="basic_serial_port::write_some"> +<link rel="prev" href="overload1.html" title="basic_serial_port::write_some (1 of 2 overloads)"> +<link rel="next" href="../_basic_serial_port.html" title="basic_serial_port::~basic_serial_port"> +</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="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="../../../../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> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_serial_port.write_some.overload2"></a><a class="link" href="overload2.html" title="basic_serial_port::write_some (2 of 2 overloads)">basic_serial_port::write_some + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Write some data to the serial port. + </p> +<pre class="programlisting">template< + typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>> +std::size_t write_some( + const ConstBufferSequence & buffers, + boost::system::error_code & ec); +</pre> +<p> + This function is used to write data to the serial port. The function + call will block until one or more bytes of the data has been written + successfully, or until an error occurs. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.write_some.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.write_some.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_serial_port.write_some.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more data buffers to be written to the serial port. + </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.basic_serial_port.write_some.overload2.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.write_some.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_serial_port.write_some.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of bytes written. Returns 0 if an error occurred. + </p> +<h6> +<a name="boost_asio.reference.basic_serial_port.write_some.overload2.h2"></a> + <span class="phrase"><a name="boost_asio.reference.basic_serial_port.write_some.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_serial_port.write_some.overload2.remarks">Remarks</a> + </h6> +<p> + The write_some operation may not transmit all of the data to the peer. + Consider using the <a class="link" href="../../write.html" title="write"><code class="computeroutput">write</code></a> + function if you need to ensure that all data is written before the blocking + 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-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="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="../../../../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> +</div> +</body> +</html> |