• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>basic_io_object</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_deadline_timer__rebind_executor/other.html" title="basic_deadline_timer::rebind_executor::other">
10<link rel="next" href="basic_io_object/basic_io_object.html" title="basic_io_object::basic_io_object">
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_deadline_timer__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_io_object/basic_io_object.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_io_object"></a><a class="link" href="basic_io_object.html" title="basic_io_object">basic_io_object</a>
28</h3></div></div></div>
29<p>
30        Base class for all I/O objects.
31      </p>
32<pre class="programlisting">template&lt;
33    typename <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a>&gt;
34class basic_io_object
35</pre>
36<h5>
37<a name="boost_asio.reference.basic_io_object.h0"></a>
38        <span class="phrase"><a name="boost_asio.reference.basic_io_object.types"></a></span><a class="link" href="basic_io_object.html#boost_asio.reference.basic_io_object.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_io_object/executor_type.html" title="basic_io_object::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
62                </p>
63              </td>
64<td>
65                <p>
66                  The type of the executor associated with the object.
67                </p>
68              </td>
69</tr>
70<tr>
71<td>
72                <p>
73                  <a class="link" href="basic_io_object/implementation_type.html" title="basic_io_object::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a>
74                </p>
75              </td>
76<td>
77                <p>
78                  The underlying implementation type of I/O object.
79                </p>
80              </td>
81</tr>
82<tr>
83<td>
84                <p>
85                  <a class="link" href="basic_io_object/service_type.html" title="basic_io_object::service_type"><span class="bold"><strong>service_type</strong></span></a>
86                </p>
87              </td>
88<td>
89                <p>
90                  The type of the service that will be used to provide I/O operations.
91                </p>
92              </td>
93</tr>
94</tbody>
95</table></div>
96<h5>
97<a name="boost_asio.reference.basic_io_object.h1"></a>
98        <span class="phrase"><a name="boost_asio.reference.basic_io_object.member_functions"></a></span><a class="link" href="basic_io_object.html#boost_asio.reference.basic_io_object.member_functions">Member Functions</a>
99      </h5>
100<div class="informaltable"><table class="table">
101<colgroup>
102<col>
103<col>
104</colgroup>
105<thead><tr>
106<th>
107                <p>
108                  Name
109                </p>
110              </th>
111<th>
112                <p>
113                  Description
114                </p>
115              </th>
116</tr></thead>
117<tbody>
118<tr>
119<td>
120                <p>
121                  <a class="link" href="basic_io_object/get_executor.html" title="basic_io_object::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
122                </p>
123              </td>
124<td>
125                <p>
126                  Get the executor associated with the object.
127                </p>
128              </td>
129</tr>
130<tr>
131<td>
132                <p>
133                  <a class="link" href="basic_io_object/get_io_context.html" title="basic_io_object::get_io_context"><span class="bold"><strong>get_io_context</strong></span></a>
134                </p>
135              </td>
136<td>
137                <p>
138                  (Deprecated: Use get_executor().) Get the io_context associated
139                  with the object.
140                </p>
141              </td>
142</tr>
143<tr>
144<td>
145                <p>
146                  <a class="link" href="basic_io_object/get_io_service.html" title="basic_io_object::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
147                </p>
148              </td>
149<td>
150                <p>
151                  (Deprecated: Use get_executor().) Get the io_context associated
152                  with the object.
153                </p>
154              </td>
155</tr>
156</tbody>
157</table></div>
158<h5>
159<a name="boost_asio.reference.basic_io_object.h2"></a>
160        <span class="phrase"><a name="boost_asio.reference.basic_io_object.protected_member_functions"></a></span><a class="link" href="basic_io_object.html#boost_asio.reference.basic_io_object.protected_member_functions">Protected
161        Member Functions</a>
162      </h5>
163<div class="informaltable"><table class="table">
164<colgroup>
165<col>
166<col>
167</colgroup>
168<thead><tr>
169<th>
170                <p>
171                  Name
172                </p>
173              </th>
174<th>
175                <p>
176                  Description
177                </p>
178              </th>
179</tr></thead>
180<tbody>
181<tr>
182<td>
183                <p>
184                  <a class="link" href="basic_io_object/basic_io_object.html" title="basic_io_object::basic_io_object"><span class="bold"><strong>basic_io_object</strong></span></a> <span class="silver">[constructor]</span>
185                </p>
186              </td>
187<td>
188                <p>
189                  Construct a basic_io_object. <br> <span class="silver"> —</span><br> Move-construct a basic_io_object.
190                  <br> <span class="silver"> —</span><br> Perform a converting move-construction of a basic_io_object.
191                </p>
192              </td>
193</tr>
194<tr>
195<td>
196                <p>
197                  <a class="link" href="basic_io_object/get_implementation.html" title="basic_io_object::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a>
198                </p>
199              </td>
200<td>
201                <p>
202                  Get the underlying implementation of the I/O object.
203                </p>
204              </td>
205</tr>
206<tr>
207<td>
208                <p>
209                  <a class="link" href="basic_io_object/get_service.html" title="basic_io_object::get_service"><span class="bold"><strong>get_service</strong></span></a>
210                </p>
211              </td>
212<td>
213                <p>
214                  Get the service associated with the I/O object.
215                </p>
216              </td>
217</tr>
218<tr>
219<td>
220                <p>
221                  <a class="link" href="basic_io_object/operator_eq_.html" title="basic_io_object::operator="><span class="bold"><strong>operator=</strong></span></a>
222                </p>
223              </td>
224<td>
225                <p>
226                  Move-assign a basic_io_object.
227                </p>
228              </td>
229</tr>
230<tr>
231<td>
232                <p>
233                  <a class="link" href="basic_io_object/_basic_io_object.html" title="basic_io_object::~basic_io_object"><span class="bold"><strong>~basic_io_object</strong></span></a> <span class="silver">[destructor]</span>
234                </p>
235              </td>
236<td>
237                <p>
238                  Protected destructor to prevent deletion through this type.
239                </p>
240              </td>
241</tr>
242</tbody>
243</table></div>
244<h5>
245<a name="boost_asio.reference.basic_io_object.h3"></a>
246        <span class="phrase"><a name="boost_asio.reference.basic_io_object.remarks"></a></span><a class="link" href="basic_io_object.html#boost_asio.reference.basic_io_object.remarks">Remarks</a>
247      </h5>
248<p>
249        All I/O objects are non-copyable. However, when using C++0x, certain I/O
250        objects do support move construction and move assignment.
251      </p>
252<h5>
253<a name="boost_asio.reference.basic_io_object.h4"></a>
254        <span class="phrase"><a name="boost_asio.reference.basic_io_object.requirements"></a></span><a class="link" href="basic_io_object.html#boost_asio.reference.basic_io_object.requirements">Requirements</a>
255      </h5>
256<p>
257        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_io_object.hpp</code>
258      </p>
259<p>
260        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
261      </p>
262</div>
263<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
264<td align="left"></td>
265<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
266      Kohlhoff<p>
267        Distributed under the Boost Software License, Version 1.0. (See accompanying
268        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>)
269      </p>
270</div></td>
271</tr></table>
272<hr>
273<div class="spirit-nav">
274<a accesskey="p" href="basic_deadline_timer__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_io_object/basic_io_object.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
275</div>
276</body>
277</html>
278