blob: f19b7cc8308a0ad060b13670cf0d5e9341cdf6e4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>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="../reference.html" title="Reference">
<link rel="prev" href="resolver_errc__try_again.html" title="resolver_errc::try_again">
<link rel="next" href="serial_port_base.html" title="serial_port_base">
</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="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>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.serial_port"></a><a class="link" href="serial_port.html" title="serial_port">serial_port</a>
</h3></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.serial_port"></a>
Typedef for the typical usage
of a serial port.
</p>
<pre class="programlisting">typedef basic_serial_port serial_port;
</pre>
<h5>
<a name="boost_asio.reference.serial_port.h0"></a>
<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>
</h5>
<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="basic_serial_port/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="basic_serial_port/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="basic_serial_port/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>
<h5>
<a name="boost_asio.reference.serial_port.h1"></a>
<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
Functions</a>
</h5>
<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="basic_serial_port/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="basic_serial_port/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="basic_serial_port/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/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="basic_serial_port/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="basic_serial_port/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="basic_serial_port/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="basic_serial_port/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="basic_serial_port/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="basic_serial_port/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="basic_serial_port/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="basic_serial_port/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="basic_serial_port/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="basic_serial_port/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="basic_serial_port/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="basic_serial_port/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="basic_serial_port/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/_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>
<h5>
<a name="boost_asio.reference.serial_port.h2"></a>
<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
Safety</a>
</h5>
<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>
<h5>
<a name="boost_asio.reference.serial_port.h3"></a>
<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>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/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="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>
</div>
</body>
</html>
|
