1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>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="resolver_errc__try_again.html" title="resolver_errc::try_again"> 10<link rel="next" href="serial_port_base.html" title="serial_port_base"> 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="resolver_errc__try_again.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="serial_port_base.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.serial_port"></a><a class="link" href="serial_port.html" title="serial_port">serial_port</a> 28</h3></div></div></div> 29<p> 30 <a class="indexterm" name="boost_asio.indexterm.serial_port"></a> 31Typedef for the typical usage 32 of a serial port. 33 </p> 34<pre class="programlisting">typedef basic_serial_port serial_port; 35</pre> 36<h5> 37<a name="boost_asio.reference.serial_port.h0"></a> 38 <span class="phrase"><a name="boost_asio.reference.serial_port.types"></a></span><a class="link" href="serial_port.html#boost_asio.reference.serial_port.types">Types</a> 39 </h5> 40<div class="informaltable"><table class="table"> 41<colgroup> 42<col> 43<col> 44</colgroup> 45<thead><tr> 46<th> 47 <p> 48 Name 49 </p> 50 </th> 51<th> 52 <p> 53 Description 54 </p> 55 </th> 56</tr></thead> 57<tbody> 58<tr> 59<td> 60 <p> 61 <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> 62 </p> 63 </td> 64<td> 65 <p> 66 Rebinds the serial port type to another executor. 67 </p> 68 </td> 69</tr> 70<tr> 71<td> 72 <p> 73 <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> 74 </p> 75 </td> 76<td> 77 <p> 78 The type of the executor associated with the object. 79 </p> 80 </td> 81</tr> 82<tr> 83<td> 84 <p> 85 <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> 86 </p> 87 </td> 88<td> 89 <p> 90 A basic_basic_serial_port is always the lowest layer. 91 </p> 92 </td> 93</tr> 94<tr> 95<td> 96 <p> 97 <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> 98 </p> 99 </td> 100<td> 101 <p> 102 The native representation of a serial port. 103 </p> 104 </td> 105</tr> 106</tbody> 107</table></div> 108<h5> 109<a name="boost_asio.reference.serial_port.h1"></a> 110 <span class="phrase"><a name="boost_asio.reference.serial_port.member_functions"></a></span><a class="link" href="serial_port.html#boost_asio.reference.serial_port.member_functions">Member 111 Functions</a> 112 </h5> 113<div class="informaltable"><table class="table"> 114<colgroup> 115<col> 116<col> 117</colgroup> 118<thead><tr> 119<th> 120 <p> 121 Name 122 </p> 123 </th> 124<th> 125 <p> 126 Description 127 </p> 128 </th> 129</tr></thead> 130<tbody> 131<tr> 132<td> 133 <p> 134 <a class="link" href="basic_serial_port/assign.html" title="basic_serial_port::assign"><span class="bold"><strong>assign</strong></span></a> 135 </p> 136 </td> 137<td> 138 <p> 139 Assign an existing native serial port to the serial port. 140 </p> 141 </td> 142</tr> 143<tr> 144<td> 145 <p> 146 <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> 147 </p> 148 </td> 149<td> 150 <p> 151 Start an asynchronous read. 152 </p> 153 </td> 154</tr> 155<tr> 156<td> 157 <p> 158 <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> 159 </p> 160 </td> 161<td> 162 <p> 163 Start an asynchronous write. 164 </p> 165 </td> 166</tr> 167<tr> 168<td> 169 <p> 170 <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> 171 </p> 172 </td> 173<td> 174 <p> 175 Construct a basic_serial_port without opening it. <br> <span class="silver"> —</span><br> 176 Construct and open a basic_serial_port. <br> <span class="silver"> —</span><br> Construct 177 a basic_serial_port on an existing native serial port. <br> <span class="silver"> —</span> 178 <br> Move-construct a basic_serial_port from another. 179 </p> 180 </td> 181</tr> 182<tr> 183<td> 184 <p> 185 <a class="link" href="basic_serial_port/cancel.html" title="basic_serial_port::cancel"><span class="bold"><strong>cancel</strong></span></a> 186 </p> 187 </td> 188<td> 189 <p> 190 Cancel all asynchronous operations associated with the serial port. 191 </p> 192 </td> 193</tr> 194<tr> 195<td> 196 <p> 197 <a class="link" href="basic_serial_port/close.html" title="basic_serial_port::close"><span class="bold"><strong>close</strong></span></a> 198 </p> 199 </td> 200<td> 201 <p> 202 Close the serial port. 203 </p> 204 </td> 205</tr> 206<tr> 207<td> 208 <p> 209 <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> 210 </p> 211 </td> 212<td> 213 <p> 214 Get the executor associated with the object. 215 </p> 216 </td> 217</tr> 218<tr> 219<td> 220 <p> 221 <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> 222 </p> 223 </td> 224<td> 225 <p> 226 Get an option from the serial port. 227 </p> 228 </td> 229</tr> 230<tr> 231<td> 232 <p> 233 <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> 234 </p> 235 </td> 236<td> 237 <p> 238 Determine whether the serial port is open. 239 </p> 240 </td> 241</tr> 242<tr> 243<td> 244 <p> 245 <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> 246 </p> 247 </td> 248<td> 249 <p> 250 Get a reference to the lowest layer. <br> <span class="silver"> —</span><br> Get a const 251 reference to the lowest layer. 252 </p> 253 </td> 254</tr> 255<tr> 256<td> 257 <p> 258 <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> 259 </p> 260 </td> 261<td> 262 <p> 263 Get the native serial port representation. 264 </p> 265 </td> 266</tr> 267<tr> 268<td> 269 <p> 270 <a class="link" href="basic_serial_port/open.html" title="basic_serial_port::open"><span class="bold"><strong>open</strong></span></a> 271 </p> 272 </td> 273<td> 274 <p> 275 Open the serial port using the specified device name. 276 </p> 277 </td> 278</tr> 279<tr> 280<td> 281 <p> 282 <a class="link" href="basic_serial_port/operator_eq_.html" title="basic_serial_port::operator="><span class="bold"><strong>operator=</strong></span></a> 283 </p> 284 </td> 285<td> 286 <p> 287 Move-assign a basic_serial_port from another. 288 </p> 289 </td> 290</tr> 291<tr> 292<td> 293 <p> 294 <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> 295 </p> 296 </td> 297<td> 298 <p> 299 Read some data from the serial port. 300 </p> 301 </td> 302</tr> 303<tr> 304<td> 305 <p> 306 <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> 307 </p> 308 </td> 309<td> 310 <p> 311 Send a break sequence to the serial port. 312 </p> 313 </td> 314</tr> 315<tr> 316<td> 317 <p> 318 <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> 319 </p> 320 </td> 321<td> 322 <p> 323 Set an option on the serial port. 324 </p> 325 </td> 326</tr> 327<tr> 328<td> 329 <p> 330 <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> 331 </p> 332 </td> 333<td> 334 <p> 335 Write some data to the serial port. 336 </p> 337 </td> 338</tr> 339<tr> 340<td> 341 <p> 342 <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> 343 </p> 344 </td> 345<td> 346 <p> 347 Destroys the serial port. 348 </p> 349 </td> 350</tr> 351</tbody> 352</table></div> 353<p> 354 The <a class="link" href="basic_serial_port.html" title="basic_serial_port"><code class="computeroutput">basic_serial_port</code></a> 355 class provides a wrapper over serial port functionality. 356 </p> 357<h5> 358<a name="boost_asio.reference.serial_port.h2"></a> 359 <span class="phrase"><a name="boost_asio.reference.serial_port.thread_safety"></a></span><a class="link" href="serial_port.html#boost_asio.reference.serial_port.thread_safety">Thread 360 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.serial_port.h3"></a> 370 <span class="phrase"><a name="boost_asio.reference.serial_port.requirements"></a></span><a class="link" href="serial_port.html#boost_asio.reference.serial_port.requirements">Requirements</a> 371 </h5> 372<p> 373 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/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="resolver_errc__try_again.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="serial_port_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 391</div> 392</body> 393</html> 394
