doc/html/boost_asio/reference/windows__stream_handle.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>windows::stream_handle</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="windows__random_access_handle.html" title="windows::random_access_handle">
  10 <link rel="next" href="write.html" title="write">
  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="windows__random_access_handle.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="write.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.windows__stream_handle"></a><a class="link" href="windows__stream_handle.html" title="windows::stream_handle">windows::stream_handle</a>
  28 </h3></div></div></div>
  29 <p>
  30         <a class="indexterm" name="boost_asio.indexterm.windows__stream_handle"></a>
  31 Typedef
  32         for the typical usage of a stream-oriented handle.
  33       </p>
  34 <pre class="programlisting">typedef basic_stream_handle stream_handle;
  35 </pre>
  36 <h5>
  37 <a name="boost_asio.reference.windows__stream_handle.h0"></a>
  38         <span class="phrase"><a name="boost_asio.reference.windows__stream_handle.types"></a></span><a class="link" href="windows__stream_handle.html#boost_asio.reference.windows__stream_handle.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="windows__basic_stream_handle__rebind_executor.html" title="windows::basic_stream_handle::rebind_executor"><span class="bold"><strong>rebind_executor</strong></span></a>
  62                 </p>
  63               </td>
  64 <td>
  65                 <p>
  66                   Rebinds the handle type to another executor.
  67                 </p>
  68               </td>
  69 </tr>
  70 <tr>
  71 <td>
  72                 <p>
  73                   <a class="link" href="windows__basic_stream_handle/executor_type.html" title="windows::basic_stream_handle::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="windows__basic_stream_handle/lowest_layer_type.html" title="windows::basic_stream_handle::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a>
  86                 </p>
  87               </td>
  88 <td>
  89                 <p>
  90                   An overlapped_handle is always the lowest layer.
  91                 </p>
  92               </td>
  93 </tr>
  94 <tr>
  95 <td>
  96                 <p>
  97                   <a class="link" href="windows__basic_stream_handle/native_handle_type.html" title="windows::basic_stream_handle::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 handle.
 103                 </p>
 104               </td>
 105 </tr>
 106 </tbody>
 107 </table></div>
 108 <h5>
 109 <a name="boost_asio.reference.windows__stream_handle.h1"></a>
 110         <span class="phrase"><a name="boost_asio.reference.windows__stream_handle.member_functions"></a></span><a class="link" href="windows__stream_handle.html#boost_asio.reference.windows__stream_handle.member_functions">Member
 111         Functions</a>
 112       </h5>
 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="windows__basic_stream_handle/assign.html" title="windows::basic_stream_handle::assign"><span class="bold"><strong>assign</strong></span></a>
 135                 </p>
 136               </td>
 137 <td>
 138                 <p>
 139                   Assign an existing native handle to the handle.
 140                 </p>
 141               </td>
 142 </tr>
 143 <tr>
 144 <td>
 145                 <p>
 146                   <a class="link" href="windows__basic_stream_handle/async_read_some.html" title="windows::basic_stream_handle::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="windows__basic_stream_handle/async_write_some.html" title="windows::basic_stream_handle::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="windows__basic_stream_handle/basic_stream_handle.html" title="windows::basic_stream_handle::basic_stream_handle"><span class="bold"><strong>basic_stream_handle</strong></span></a>
 171                 </p>
 172               </td>
 173 <td>
 174                 <p>
 175                   Construct a stream handle without opening it. <br> <span class="silver"> &#8212;</span><br> Construct
 176                   a stream handle on an existing native handle. <br> <span class="silver"> &#8212;</span><br> Move-construct
 177                   a stream handle from another.
 178                 </p>
 179               </td>
 180 </tr>
 181 <tr>
 182 <td>
 183                 <p>
 184                   <a class="link" href="windows__basic_stream_handle/cancel.html" title="windows::basic_stream_handle::cancel"><span class="bold"><strong>cancel</strong></span></a>
 185                 </p>
 186               </td>
 187 <td>
 188                 <p>
 189                   Cancel all asynchronous operations associated with the handle.
 190                 </p>
 191               </td>
 192 </tr>
 193 <tr>
 194 <td>
 195                 <p>
 196                   <a class="link" href="windows__basic_stream_handle/close.html" title="windows::basic_stream_handle::close"><span class="bold"><strong>close</strong></span></a>
 197                 </p>
 198               </td>
 199 <td>
 200                 <p>
 201                   Close the handle.
 202                 </p>
 203               </td>
 204 </tr>
 205 <tr>
 206 <td>
 207                 <p>
 208                   <a class="link" href="windows__basic_stream_handle/get_executor.html" title="windows::basic_stream_handle::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
 209                 </p>
 210               </td>
 211 <td>
 212                 <p>
 213                   Get the executor associated with the object.
 214                 </p>
 215               </td>
 216 </tr>
 217 <tr>
 218 <td>
 219                 <p>
 220                   <a class="link" href="windows__basic_stream_handle/is_open.html" title="windows::basic_stream_handle::is_open"><span class="bold"><strong>is_open</strong></span></a>
 221                 </p>
 222               </td>
 223 <td>
 224                 <p>
 225                   Determine whether the handle is open.
 226                 </p>
 227               </td>
 228 </tr>
 229 <tr>
 230 <td>
 231                 <p>
 232                   <a class="link" href="windows__basic_stream_handle/lowest_layer.html" title="windows::basic_stream_handle::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a>
 233                 </p>
 234               </td>
 235 <td>
 236                 <p>
 237                   Get a reference to the lowest layer. <br> <span class="silver"> &#8212;</span><br> Get a const
 238                   reference to the lowest layer.
 239                 </p>
 240               </td>
 241 </tr>
 242 <tr>
 243 <td>
 244                 <p>
 245                   <a class="link" href="windows__basic_stream_handle/native_handle.html" title="windows::basic_stream_handle::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
 246                 </p>
 247               </td>
 248 <td>
 249                 <p>
 250                   Get the native handle representation.
 251                 </p>
 252               </td>
 253 </tr>
 254 <tr>
 255 <td>
 256                 <p>
 257                   <a class="link" href="windows__basic_stream_handle/operator_eq_.html" title="windows::basic_stream_handle::operator="><span class="bold"><strong>operator=</strong></span></a>
 258                 </p>
 259               </td>
 260 <td>
 261                 <p>
 262                   Move-assign a stream handle from another.
 263                 </p>
 264               </td>
 265 </tr>
 266 <tr>
 267 <td>
 268                 <p>
 269                   <a class="link" href="windows__basic_stream_handle/read_some.html" title="windows::basic_stream_handle::read_some"><span class="bold"><strong>read_some</strong></span></a>
 270                 </p>
 271               </td>
 272 <td>
 273                 <p>
 274                   Read some data from the handle.
 275                 </p>
 276               </td>
 277 </tr>
 278 <tr>
 279 <td>
 280                 <p>
 281                   <a class="link" href="windows__basic_stream_handle/write_some.html" title="windows::basic_stream_handle::write_some"><span class="bold"><strong>write_some</strong></span></a>
 282                 </p>
 283               </td>
 284 <td>
 285                 <p>
 286                   Write some data to the handle.
 287                 </p>
 288               </td>
 289 </tr>
 290 </tbody>
 291 </table></div>
 292 <h5>
 293 <a name="boost_asio.reference.windows__stream_handle.h2"></a>
 294         <span class="phrase"><a name="boost_asio.reference.windows__stream_handle.protected_data_members"></a></span><a class="link" href="windows__stream_handle.html#boost_asio.reference.windows__stream_handle.protected_data_members">Protected
 295         Data Members</a>
 296       </h5>
 297 <div class="informaltable"><table class="table">
 298 <colgroup>
 299 <col>
 300 <col>
 301 </colgroup>
 302 <thead><tr>
 303 <th>
 304                 <p>
 305                   Name
 306                 </p>
 307               </th>
 308 <th>
 309                 <p>
 310                   Description
 311                 </p>
 312               </th>
 313 </tr></thead>
 314 <tbody><tr>
 315 <td>
 316                 <p>
 317                   <a class="link" href="windows__basic_stream_handle/impl_.html" title="windows::basic_stream_handle::impl_"><span class="bold"><strong>impl_</strong></span></a>
 318                 </p>
 319               </td>
 320 <td>
 321               </td>
 322 </tr></tbody>
 323 </table></div>
 324 <p>
 325         The <a class="link" href="windows__basic_stream_handle.html" title="windows::basic_stream_handle"><code class="computeroutput">windows::basic_stream_handle</code></a>
 326         class provides asynchronous and blocking stream-oriented handle functionality.
 327       </p>
 328 <h5>
 329 <a name="boost_asio.reference.windows__stream_handle.h3"></a>
 330         <span class="phrase"><a name="boost_asio.reference.windows__stream_handle.thread_safety"></a></span><a class="link" href="windows__stream_handle.html#boost_asio.reference.windows__stream_handle.thread_safety">Thread
 331         Safety</a>
 332       </h5>
 333 <p>
 334         <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 335       </p>
 336 <p>
 337         <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
 338       </p>
 339 <h5>
 340 <a name="boost_asio.reference.windows__stream_handle.h4"></a>
 341         <span class="phrase"><a name="boost_asio.reference.windows__stream_handle.requirements"></a></span><a class="link" href="windows__stream_handle.html#boost_asio.reference.windows__stream_handle.requirements">Requirements</a>
 342       </h5>
 343 <p>
 344         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/stream_handle.hpp</code>
 345       </p>
 346 <p>
 347         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 348       </p>
 349 </div>
 350 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 351 <td align="left"></td>
 352 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
 353         Distributed under the Boost Software License, Version 1.0. (See accompanying
 354         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>)
 355       </p>
 356 </div></td>
 357 </tr></table>
 358 <hr>
 359 <div class="spirit-nav">
 360 <a accesskey="p" href="windows__random_access_handle.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="write.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 361 </div>
 362 </body>
 363 </html>