blob: e7e81ebdf70ee9f3654b70f5540c7c75069701d6 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>basic_io_object</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="basic_deadline_timer/wait/overload2.html" title="basic_deadline_timer::wait (2 of 2 overloads)">
<link rel="next" href="basic_io_object/basic_io_object.html" title="basic_io_object::basic_io_object">
</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="basic_deadline_timer/wait/overload2.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>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<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>
</h3></div></div></div>
<p>
Base class for all I/O objects.
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a><span class="special">&gt;</span>
<span class="keyword">class</span> <span class="identifier">basic_io_object</span>
</pre>
<a name="boost_asio.reference.basic_io_object.types"></a><h5>
<a name="boost_asio.reference.basic_io_object.types-heading"></a>
<a class="link" href="basic_io_object.html#boost_asio.reference.basic_io_object.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_io_object/implementation_type.html" title="basic_io_object::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a>
</p>
</td>
<td>
<p>
The underlying implementation type of I/O object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
The type of the service that will be used to provide I/O operations.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="boost_asio.reference.basic_io_object.member_functions"></a><h5>
<a name="boost_asio.reference.basic_io_object.member_functions-heading"></a>
<a class="link" href="basic_io_object.html#boost_asio.reference.basic_io_object.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_io_object/get_io_service.html" title="basic_io_object::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
</p>
</td>
<td>
<p>
Get the io_service associated with the object.
</p>
</td>
</tr></tbody>
</table></div>
<a name="boost_asio.reference.basic_io_object.protected_member_functions"></a><h5>
<a name="boost_asio.reference.basic_io_object.protected_member_functions-heading"></a>
<a class="link" href="basic_io_object.html#boost_asio.reference.basic_io_object.protected_member_functions">Protected
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_io_object/basic_io_object.html" title="basic_io_object::basic_io_object"><span class="bold"><strong>basic_io_object</strong></span></a>
</p>
</td>
<td>
<p>
Construct a basic_io_object.
</p>
<p>
Move-construct a basic_io_object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Get the underlying implementation of the I/O object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Get the service associated with the I/O object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_io_object/operator_eq_.html" title="basic_io_object::operator="><span class="bold"><strong>operator=</strong></span></a>
</p>
</td>
<td>
<p>
Move-assign a basic_io_object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Protected destructor to prevent deletion through this type.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="boost_asio.reference.basic_io_object.protected_data_members"></a><h5>
<a name="boost_asio.reference.basic_io_object.protected_data_members-heading"></a>
<a class="link" href="basic_io_object.html#boost_asio.reference.basic_io_object.protected_data_members">Protected
Data Members</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_io_object/implementation.html" title="basic_io_object::implementation"><span class="bold"><strong>implementation</strong></span></a>
</p>
</td>
<td>
<p>
(Deprecated: Use get_implementation().) The underlying implementation
of the I/O object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_io_object/service.html" title="basic_io_object::service"><span class="bold"><strong>service</strong></span></a>
</p>
</td>
<td>
<p>
(Deprecated: Use get_service().) The service associated with the
I/O object.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="boost_asio.reference.basic_io_object.remarks"></a><h5>
<a name="boost_asio.reference.basic_io_object.remarks-heading"></a>
<a class="link" href="basic_io_object.html#boost_asio.reference.basic_io_object.remarks">Remarks</a>
</h5>
<p>
All I/O objects are non-copyable. However, when using C++0x, certain I/O
objects do support move construction and move assignment.
</p>
<a name="boost_asio.reference.basic_io_object.requirements"></a><h5>
<a name="boost_asio.reference.basic_io_object.requirements-heading"></a>
<a class="link" href="basic_io_object.html#boost_asio.reference.basic_io_object.requirements">Requirements</a>
</h5>
<p>
<span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_io_object.hpp</code>
</p>
<p>
<span class="bold"><strong>Convenience header: </strong></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 &#169; 2003-2011 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="basic_deadline_timer/wait/overload2.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>
</div>
</body>
</html>