Imported Upstream version 1.72.0
[platform/upstream/boost.git] / doc / html / boost_asio / reference / basic_serial_port / lowest_layer_type.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>basic_serial_port::lowest_layer_type</title>
5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
8 <link rel="up" href="../basic_serial_port.html" title="basic_serial_port">
9 <link rel="prev" href="lowest_layer/overload2.html" title="basic_serial_port::lowest_layer (2 of 2 overloads)">
10 <link rel="next" href="native_handle.html" title="basic_serial_port::native_handle">
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="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>
24 </div>
25 <div class="section">
26 <div class="titlepage"><div><div><h4 class="title">
27 <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>
28 </h4></div></div></div>
29 <p>
30           <a class="indexterm" name="boost_asio.indexterm.basic_serial_port.lowest_layer_type"></a> 
31 A
32           basic_basic_serial_port is always the lowest layer.
33         </p>
34 <pre class="programlisting">typedef basic_serial_port lowest_layer_type;
35 </pre>
36 <h6>
37 <a name="boost_asio.reference.basic_serial_port.lowest_layer_type.h0"></a>
38           <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>
39         </h6>
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="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="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="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 <h6>
109 <a name="boost_asio.reference.basic_serial_port.lowest_layer_type.h1"></a>
110           <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
111           Functions</a>
112         </h6>
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="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="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="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.html" title="basic_serial_port::basic_serial_port"><span class="bold"><strong>basic_serial_port</strong></span></a>
171                   </p>
172                 </td>
173 <td>
174                   <p>
175                     Construct a basic_serial_port without opening it. <br> <span class="silver"> &#8212;</span><br>
176                     Construct and open a basic_serial_port. <br> <span class="silver"> &#8212;</span><br> Construct
177                     a basic_serial_port on an existing native serial port. <br>
178                     <span class="silver"> &#8212;</span><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="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
191                     port.
192                   </p>
193                 </td>
194 </tr>
195 <tr>
196 <td>
197                   <p>
198                     <a class="link" href="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="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="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="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="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"> &#8212;</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="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="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="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="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="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="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="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.html" title="basic_serial_port::~basic_serial_port"><span class="bold"><strong>~basic_serial_port</strong></span></a>
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 <h6>
359 <a name="boost_asio.reference.basic_serial_port.lowest_layer_type.h2"></a>
360           <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
361           Safety</a>
362         </h6>
363 <p>
364           <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
365         </p>
366 <p>
367           <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
368         </p>
369 <h6>
370 <a name="boost_asio.reference.basic_serial_port.lowest_layer_type.h3"></a>
371           <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>
372         </h6>
373 <p>
374           <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_serial_port.hpp</code>
375         </p>
376 <p>
377           <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
378         </p>
379 </div>
380 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
381 <td align="left"></td>
382 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. 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="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>
391 </div>
392 </body>
393 </html>