1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_serial_port</title> 5<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../reference.html" title="Reference"> 9<link rel="prev" href="basic_seq_packet_socket__rebind_executor/other.html" title="basic_seq_packet_socket::rebind_executor::other"> 10<link rel="next" href="basic_serial_port/assign.html" title="basic_serial_port::assign"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 15<td align="center"><a href="../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="basic_seq_packet_socket__rebind_executor/other.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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/assign.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h3 class="title"> 27<a name="boost_asio.reference.basic_serial_port"></a><a class="link" href="basic_serial_port.html" title="basic_serial_port">basic_serial_port</a> 28</h3></div></div></div> 29<p> 30 Provides serial port functionality. 31 </p> 32<pre class="programlisting">template< 33 typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a> = any_io_executor> 34class basic_serial_port : 35 public serial_port_base 36</pre> 37<h5> 38<a name="boost_asio.reference.basic_serial_port.h0"></a> 39 <span class="phrase"><a name="boost_asio.reference.basic_serial_port.types"></a></span><a class="link" href="basic_serial_port.html#boost_asio.reference.basic_serial_port.types">Types</a> 40 </h5> 41<div class="informaltable"><table class="table"> 42<colgroup> 43<col> 44<col> 45</colgroup> 46<thead><tr> 47<th> 48 <p> 49 Name 50 </p> 51 </th> 52<th> 53 <p> 54 Description 55 </p> 56 </th> 57</tr></thead> 58<tbody> 59<tr> 60<td> 61 <p> 62 <a class="link" href="basic_serial_port__rebind_executor.html" title="basic_serial_port::rebind_executor"><span class="bold"><strong>rebind_executor</strong></span></a> 63 </p> 64 </td> 65<td> 66 <p> 67 Rebinds the serial port type to another executor. 68 </p> 69 </td> 70</tr> 71<tr> 72<td> 73 <p> 74 <a class="link" href="basic_serial_port/executor_type.html" title="basic_serial_port::executor_type"><span class="bold"><strong>executor_type</strong></span></a> 75 </p> 76 </td> 77<td> 78 <p> 79 The type of the executor associated with the object. 80 </p> 81 </td> 82</tr> 83<tr> 84<td> 85 <p> 86 <a class="link" href="basic_serial_port/lowest_layer_type.html" title="basic_serial_port::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a> 87 </p> 88 </td> 89<td> 90 <p> 91 A basic_basic_serial_port is always the lowest layer. 92 </p> 93 </td> 94</tr> 95<tr> 96<td> 97 <p> 98 <a class="link" href="basic_serial_port/native_handle_type.html" title="basic_serial_port::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a> 99 </p> 100 </td> 101<td> 102 <p> 103 The native representation of a serial port. 104 </p> 105 </td> 106</tr> 107</tbody> 108</table></div> 109<h5> 110<a name="boost_asio.reference.basic_serial_port.h1"></a> 111 <span class="phrase"><a name="boost_asio.reference.basic_serial_port.member_functions"></a></span><a class="link" href="basic_serial_port.html#boost_asio.reference.basic_serial_port.member_functions">Member 112 Functions</a> 113 </h5> 114<div class="informaltable"><table class="table"> 115<colgroup> 116<col> 117<col> 118</colgroup> 119<thead><tr> 120<th> 121 <p> 122 Name 123 </p> 124 </th> 125<th> 126 <p> 127 Description 128 </p> 129 </th> 130</tr></thead> 131<tbody> 132<tr> 133<td> 134 <p> 135 <a class="link" href="basic_serial_port/assign.html" title="basic_serial_port::assign"><span class="bold"><strong>assign</strong></span></a> 136 </p> 137 </td> 138<td> 139 <p> 140 Assign an existing native serial port to the serial port. 141 </p> 142 </td> 143</tr> 144<tr> 145<td> 146 <p> 147 <a class="link" href="basic_serial_port/async_read_some.html" title="basic_serial_port::async_read_some"><span class="bold"><strong>async_read_some</strong></span></a> 148 </p> 149 </td> 150<td> 151 <p> 152 Start an asynchronous read. 153 </p> 154 </td> 155</tr> 156<tr> 157<td> 158 <p> 159 <a class="link" href="basic_serial_port/async_write_some.html" title="basic_serial_port::async_write_some"><span class="bold"><strong>async_write_some</strong></span></a> 160 </p> 161 </td> 162<td> 163 <p> 164 Start an asynchronous write. 165 </p> 166 </td> 167</tr> 168<tr> 169<td> 170 <p> 171 <a class="link" href="basic_serial_port/basic_serial_port.html" title="basic_serial_port::basic_serial_port"><span class="bold"><strong>basic_serial_port</strong></span></a> <span class="silver">[constructor]</span> 172 </p> 173 </td> 174<td> 175 <p> 176 Construct a basic_serial_port without opening it. <br> <span class="silver"> —</span><br> 177 Construct and open a basic_serial_port. <br> <span class="silver"> —</span><br> Construct 178 a basic_serial_port on an existing native serial port. <br> <span class="silver"> —</span> 179 <br> Move-construct a basic_serial_port from another. 180 </p> 181 </td> 182</tr> 183<tr> 184<td> 185 <p> 186 <a class="link" href="basic_serial_port/cancel.html" title="basic_serial_port::cancel"><span class="bold"><strong>cancel</strong></span></a> 187 </p> 188 </td> 189<td> 190 <p> 191 Cancel all asynchronous operations associated with the serial port. 192 </p> 193 </td> 194</tr> 195<tr> 196<td> 197 <p> 198 <a class="link" href="basic_serial_port/close.html" title="basic_serial_port::close"><span class="bold"><strong>close</strong></span></a> 199 </p> 200 </td> 201<td> 202 <p> 203 Close the serial port. 204 </p> 205 </td> 206</tr> 207<tr> 208<td> 209 <p> 210 <a class="link" href="basic_serial_port/get_executor.html" title="basic_serial_port::get_executor"><span class="bold"><strong>get_executor</strong></span></a> 211 </p> 212 </td> 213<td> 214 <p> 215 Get the executor associated with the object. 216 </p> 217 </td> 218</tr> 219<tr> 220<td> 221 <p> 222 <a class="link" href="basic_serial_port/get_option.html" title="basic_serial_port::get_option"><span class="bold"><strong>get_option</strong></span></a> 223 </p> 224 </td> 225<td> 226 <p> 227 Get an option from the serial port. 228 </p> 229 </td> 230</tr> 231<tr> 232<td> 233 <p> 234 <a class="link" href="basic_serial_port/is_open.html" title="basic_serial_port::is_open"><span class="bold"><strong>is_open</strong></span></a> 235 </p> 236 </td> 237<td> 238 <p> 239 Determine whether the serial port is open. 240 </p> 241 </td> 242</tr> 243<tr> 244<td> 245 <p> 246 <a class="link" href="basic_serial_port/lowest_layer.html" title="basic_serial_port::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a> 247 </p> 248 </td> 249<td> 250 <p> 251 Get a reference to the lowest layer. <br> <span class="silver"> —</span><br> Get a const 252 reference to the lowest layer. 253 </p> 254 </td> 255</tr> 256<tr> 257<td> 258 <p> 259 <a class="link" href="basic_serial_port/native_handle.html" title="basic_serial_port::native_handle"><span class="bold"><strong>native_handle</strong></span></a> 260 </p> 261 </td> 262<td> 263 <p> 264 Get the native serial port representation. 265 </p> 266 </td> 267</tr> 268<tr> 269<td> 270 <p> 271 <a class="link" href="basic_serial_port/open.html" title="basic_serial_port::open"><span class="bold"><strong>open</strong></span></a> 272 </p> 273 </td> 274<td> 275 <p> 276 Open the serial port using the specified device name. 277 </p> 278 </td> 279</tr> 280<tr> 281<td> 282 <p> 283 <a class="link" href="basic_serial_port/operator_eq_.html" title="basic_serial_port::operator="><span class="bold"><strong>operator=</strong></span></a> 284 </p> 285 </td> 286<td> 287 <p> 288 Move-assign a basic_serial_port from another. 289 </p> 290 </td> 291</tr> 292<tr> 293<td> 294 <p> 295 <a class="link" href="basic_serial_port/read_some.html" title="basic_serial_port::read_some"><span class="bold"><strong>read_some</strong></span></a> 296 </p> 297 </td> 298<td> 299 <p> 300 Read some data from the serial port. 301 </p> 302 </td> 303</tr> 304<tr> 305<td> 306 <p> 307 <a class="link" href="basic_serial_port/send_break.html" title="basic_serial_port::send_break"><span class="bold"><strong>send_break</strong></span></a> 308 </p> 309 </td> 310<td> 311 <p> 312 Send a break sequence to the serial port. 313 </p> 314 </td> 315</tr> 316<tr> 317<td> 318 <p> 319 <a class="link" href="basic_serial_port/set_option.html" title="basic_serial_port::set_option"><span class="bold"><strong>set_option</strong></span></a> 320 </p> 321 </td> 322<td> 323 <p> 324 Set an option on the serial port. 325 </p> 326 </td> 327</tr> 328<tr> 329<td> 330 <p> 331 <a class="link" href="basic_serial_port/write_some.html" title="basic_serial_port::write_some"><span class="bold"><strong>write_some</strong></span></a> 332 </p> 333 </td> 334<td> 335 <p> 336 Write some data to the serial port. 337 </p> 338 </td> 339</tr> 340<tr> 341<td> 342 <p> 343 <a class="link" href="basic_serial_port/_basic_serial_port.html" title="basic_serial_port::~basic_serial_port"><span class="bold"><strong>~basic_serial_port</strong></span></a> <span class="silver">[destructor]</span> 344 </p> 345 </td> 346<td> 347 <p> 348 Destroys the serial port. 349 </p> 350 </td> 351</tr> 352</tbody> 353</table></div> 354<p> 355 The <a class="link" href="basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> 356 class provides a wrapper over serial port functionality. 357 </p> 358<h5> 359<a name="boost_asio.reference.basic_serial_port.h2"></a> 360 <span class="phrase"><a name="boost_asio.reference.basic_serial_port.thread_safety"></a></span><a class="link" href="basic_serial_port.html#boost_asio.reference.basic_serial_port.thread_safety">Thread Safety</a> 361 </h5> 362<p> 363 <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe. 364 </p> 365<p> 366 <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe. 367 </p> 368<h5> 369<a name="boost_asio.reference.basic_serial_port.h3"></a> 370 <span class="phrase"><a name="boost_asio.reference.basic_serial_port.requirements"></a></span><a class="link" href="basic_serial_port.html#boost_asio.reference.basic_serial_port.requirements">Requirements</a> 371 </h5> 372<p> 373 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_serial_port.hpp</code> 374 </p> 375<p> 376 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> 377 </p> 378</div> 379<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 380<td align="left"></td> 381<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 382 Kohlhoff<p> 383 Distributed under the Boost Software License, Version 1.0. (See accompanying 384 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>) 385 </p> 386</div></td> 387</tr></table> 388<hr> 389<div class="spirit-nav"> 390<a accesskey="p" href="basic_seq_packet_socket__rebind_executor/other.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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/assign.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 391</div> 392</body> 393</html> 394
