doc/html/boost_asio/reference/posix__descriptor_base.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>posix::descriptor_base</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="posix__basic_stream_descriptor/write_some/overload2.html" title="posix::basic_stream_descriptor::write_some (2 of 2 overloads)">
  10 <link rel="next" href="posix__descriptor_base/bytes_readable.html" title="posix::descriptor_base::bytes_readable">
  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="posix__basic_stream_descriptor/write_some/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="posix__descriptor_base/bytes_readable.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.posix__descriptor_base"></a><a class="link" href="posix__descriptor_base.html" title="posix::descriptor_base">posix::descriptor_base</a>
  28 </h3></div></div></div>
  29 <p>
  30         The <a class="link" href="posix__descriptor_base.html" title="posix::descriptor_base"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">descriptor_base</span></code></a> class is used as
  31         a base for the <a class="link" href="posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">basic_stream_descriptor</span></code></a> class template
  32         so that we have a common place to define the associated IO control commands.
  33       </p>
  34 <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">descriptor_base</span>
  35 </pre>
  36 <h5>
  37 <a name="boost_asio.reference.posix__descriptor_base.h0"></a>
  38         <span class="phrase"><a name="boost_asio.reference.posix__descriptor_base.types"></a></span><a class="link" href="posix__descriptor_base.html#boost_asio.reference.posix__descriptor_base.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="posix__descriptor_base/bytes_readable.html" title="posix::descriptor_base::bytes_readable"><span class="bold"><strong>bytes_readable</strong></span></a>
  62                 </p>
  63               </td>
  64 <td>
  65                 <p>
  66                   IO control command to get the amount of data that can be read without
  67                   blocking.
  68                 </p>
  69               </td>
  70 </tr>
  71 <tr>
  72 <td>
  73                 <p>
  74                   <a class="link" href="posix__descriptor_base/non_blocking_io.html" title="posix::descriptor_base::non_blocking_io"><span class="bold"><strong>non_blocking_io</strong></span></a>
  75                 </p>
  76               </td>
  77 <td>
  78                 <p>
  79                   (Deprecated: Use non_blocking().) IO control command to set the
  80                   blocking mode of the descriptor.
  81                 </p>
  82               </td>
  83 </tr>
  84 </tbody>
  85 </table></div>
  86 <h5>
  87 <a name="boost_asio.reference.posix__descriptor_base.h1"></a>
  88         <span class="phrase"><a name="boost_asio.reference.posix__descriptor_base.protected_member_functions"></a></span><a class="link" href="posix__descriptor_base.html#boost_asio.reference.posix__descriptor_base.protected_member_functions">Protected
  89         Member Functions</a>
  90       </h5>
  91 <div class="informaltable"><table class="table">
  92 <colgroup>
  93 <col>
  94 <col>
  95 </colgroup>
  96 <thead><tr>
  97 <th>
  98                 <p>
  99                   Name
 100                 </p>
 101               </th>
 102 <th>
 103                 <p>
 104                   Description
 105                 </p>
 106               </th>
 107 </tr></thead>
 108 <tbody><tr>
 109 <td>
 110                 <p>
 111                   <a class="link" href="posix__descriptor_base/_descriptor_base.html" title="posix::descriptor_base::~descriptor_base"><span class="bold"><strong>~descriptor_base</strong></span></a>
 112                 </p>
 113               </td>
 114 <td>
 115                 <p>
 116                   Protected destructor to prevent deletion through this type.
 117                 </p>
 118               </td>
 119 </tr></tbody>
 120 </table></div>
 121 <h5>
 122 <a name="boost_asio.reference.posix__descriptor_base.h2"></a>
 123         <span class="phrase"><a name="boost_asio.reference.posix__descriptor_base.requirements"></a></span><a class="link" href="posix__descriptor_base.html#boost_asio.reference.posix__descriptor_base.requirements">Requirements</a>
 124       </h5>
 125 <p>
 126         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/posix/descriptor_base.hpp</code>
 127       </p>
 128 <p>
 129         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 130       </p>
 131 </div>
 132 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 133 <td align="left"></td>
 134 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
 135         Distributed under the Boost Software License, Version 1.0. (See accompanying
 136         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>)
 137       </p>
 138 </div></td>
 139 </tr></table>
 140 <hr>
 141 <div class="spirit-nav">
 142 <a accesskey="p" href="posix__basic_stream_descriptor/write_some/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="posix__descriptor_base/bytes_readable.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 143 </div>
 144 </body>
 145 </html>