doc/html/boost_asio/reference/windows__basic_stream_handle.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>windows::basic_stream_handle</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.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__basic_random_access_handle/write_some_at/overload2.html" title="windows::basic_random_access_handle::write_some_at (2 of 2 overloads)">
  10 <link rel="next" href="windows__basic_stream_handle/assign.html" title="windows::basic_stream_handle::assign">
  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__basic_random_access_handle/write_some_at/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="windows__basic_stream_handle/assign.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__basic_stream_handle"></a><a class="link" href="windows__basic_stream_handle.html" title="windows::basic_stream_handle">windows::basic_stream_handle</a>
  28 </h3></div></div></div>
  29 <p>
  30         Provides stream-oriented handle functionality.
  31       </p>
  32 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  33     <span class="keyword">typename</span> <a class="link" href="StreamHandleService.html" title="Stream handle service requirements">StreamHandleService</a> <span class="special">=</span> <span class="identifier">stream_handle_service</span><span class="special">&gt;</span>
  34 <span class="keyword">class</span> <span class="identifier">basic_stream_handle</span> <span class="special">:</span>
  35   <span class="keyword">public</span> <span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_handle</span><span class="special">&lt;</span> <span class="identifier">StreamHandleService</span> <span class="special">&gt;</span>
  36 </pre>
  37 <h5>
  38 <a name="boost_asio.reference.windows__basic_stream_handle.h0"></a>
  39         <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.types"></a></span><a class="link" href="windows__basic_stream_handle.html#boost_asio.reference.windows__basic_stream_handle.types">Types</a>
  40       </h5>
  41 <div class="informaltable"><table class="table">
  42 <colgroup>
  43 <col>
  44 <col>
  45 </colgroup>
  46 <thead><tr>
  47 <th>
  48                 <p>
  49                   Name
  50                 </p>
  51               </th>
  52 <th>
  53                 <p>
  54                   Description
  55                 </p>
  56               </th>
  57 </tr></thead>
  58 <tbody>
  59 <tr>
  60 <td>
  61                 <p>
  62                   <a class="link" href="windows__basic_stream_handle/implementation_type.html" title="windows::basic_stream_handle::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a>
  63                 </p>
  64               </td>
  65 <td>
  66                 <p>
  67                   The underlying implementation type of I/O object.
  68                 </p>
  69               </td>
  70 </tr>
  71 <tr>
  72 <td>
  73                 <p>
  74                   <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>
  75                 </p>
  76               </td>
  77 <td>
  78                 <p>
  79                   A basic_handle is always the lowest layer.
  80                 </p>
  81               </td>
  82 </tr>
  83 <tr>
  84 <td>
  85                 <p>
  86                   <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>
  87                 </p>
  88               </td>
  89 <td>
  90                 <p>
  91                   The native representation of a handle.
  92                 </p>
  93               </td>
  94 </tr>
  95 <tr>
  96 <td>
  97                 <p>
  98                   <a class="link" href="windows__basic_stream_handle/native_type.html" title="windows::basic_stream_handle::native_type"><span class="bold"><strong>native_type</strong></span></a>
  99                 </p>
 100               </td>
 101 <td>
 102                 <p>
 103                   (Deprecated: Use native_handle_type.) The native representation
 104                   of a handle.
 105                 </p>
 106               </td>
 107 </tr>
 108 <tr>
 109 <td>
 110                 <p>
 111                   <a class="link" href="windows__basic_stream_handle/service_type.html" title="windows::basic_stream_handle::service_type"><span class="bold"><strong>service_type</strong></span></a>
 112                 </p>
 113               </td>
 114 <td>
 115                 <p>
 116                   The type of the service that will be used to provide I/O operations.
 117                 </p>
 118               </td>
 119 </tr>
 120 </tbody>
 121 </table></div>
 122 <h5>
 123 <a name="boost_asio.reference.windows__basic_stream_handle.h1"></a>
 124         <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.member_functions"></a></span><a class="link" href="windows__basic_stream_handle.html#boost_asio.reference.windows__basic_stream_handle.member_functions">Member
 125         Functions</a>
 126       </h5>
 127 <div class="informaltable"><table class="table">
 128 <colgroup>
 129 <col>
 130 <col>
 131 </colgroup>
 132 <thead><tr>
 133 <th>
 134                 <p>
 135                   Name
 136                 </p>
 137               </th>
 138 <th>
 139                 <p>
 140                   Description
 141                 </p>
 142               </th>
 143 </tr></thead>
 144 <tbody>
 145 <tr>
 146 <td>
 147                 <p>
 148                   <a class="link" href="windows__basic_stream_handle/assign.html" title="windows::basic_stream_handle::assign"><span class="bold"><strong>assign</strong></span></a>
 149                 </p>
 150               </td>
 151 <td>
 152                 <p>
 153                   Assign an existing native handle to the handle.
 154                 </p>
 155               </td>
 156 </tr>
 157 <tr>
 158 <td>
 159                 <p>
 160                   <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>
 161                 </p>
 162               </td>
 163 <td>
 164                 <p>
 165                   Start an asynchronous read.
 166                 </p>
 167               </td>
 168 </tr>
 169 <tr>
 170 <td>
 171                 <p>
 172                   <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>
 173                 </p>
 174               </td>
 175 <td>
 176                 <p>
 177                   Start an asynchronous write.
 178                 </p>
 179               </td>
 180 </tr>
 181 <tr>
 182 <td>
 183                 <p>
 184                   <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>
 185                 </p>
 186               </td>
 187 <td>
 188                 <p>
 189                   Construct a basic_stream_handle without opening it.
 190                 </p>
 191                 <p>
 192                   Construct a basic_stream_handle on an existing native handle.
 193                 </p>
 194                 <p>
 195                   Move-construct a basic_stream_handle from another.
 196                 </p>
 197               </td>
 198 </tr>
 199 <tr>
 200 <td>
 201                 <p>
 202                   <a class="link" href="windows__basic_stream_handle/cancel.html" title="windows::basic_stream_handle::cancel"><span class="bold"><strong>cancel</strong></span></a>
 203                 </p>
 204               </td>
 205 <td>
 206                 <p>
 207                   Cancel all asynchronous operations associated with the handle.
 208                 </p>
 209               </td>
 210 </tr>
 211 <tr>
 212 <td>
 213                 <p>
 214                   <a class="link" href="windows__basic_stream_handle/close.html" title="windows::basic_stream_handle::close"><span class="bold"><strong>close</strong></span></a>
 215                 </p>
 216               </td>
 217 <td>
 218                 <p>
 219                   Close the handle.
 220                 </p>
 221               </td>
 222 </tr>
 223 <tr>
 224 <td>
 225                 <p>
 226                   <a class="link" href="windows__basic_stream_handle/get_io_service.html" title="windows::basic_stream_handle::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
 227                 </p>
 228               </td>
 229 <td>
 230                 <p>
 231                   Get the io_service associated with the object.
 232                 </p>
 233               </td>
 234 </tr>
 235 <tr>
 236 <td>
 237                 <p>
 238                   <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>
 239                 </p>
 240               </td>
 241 <td>
 242                 <p>
 243                   Determine whether the handle is open.
 244                 </p>
 245               </td>
 246 </tr>
 247 <tr>
 248 <td>
 249                 <p>
 250                   <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>
 251                 </p>
 252               </td>
 253 <td>
 254                 <p>
 255                   Get a reference to the lowest layer.
 256                 </p>
 257                 <p>
 258                   Get a const reference to the lowest layer.
 259                 </p>
 260               </td>
 261 </tr>
 262 <tr>
 263 <td>
 264                 <p>
 265                   <a class="link" href="windows__basic_stream_handle/native.html" title="windows::basic_stream_handle::native"><span class="bold"><strong>native</strong></span></a>
 266                 </p>
 267               </td>
 268 <td>
 269                 <p>
 270                   (Deprecated: Use native_handle().) Get the native handle representation.
 271                 </p>
 272               </td>
 273 </tr>
 274 <tr>
 275 <td>
 276                 <p>
 277                   <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>
 278                 </p>
 279               </td>
 280 <td>
 281                 <p>
 282                   Get the native handle representation.
 283                 </p>
 284               </td>
 285 </tr>
 286 <tr>
 287 <td>
 288                 <p>
 289                   <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>
 290                 </p>
 291               </td>
 292 <td>
 293                 <p>
 294                   Move-assign a basic_stream_handle from another.
 295                 </p>
 296               </td>
 297 </tr>
 298 <tr>
 299 <td>
 300                 <p>
 301                   <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>
 302                 </p>
 303               </td>
 304 <td>
 305                 <p>
 306                   Read some data from the handle.
 307                 </p>
 308               </td>
 309 </tr>
 310 <tr>
 311 <td>
 312                 <p>
 313                   <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>
 314                 </p>
 315               </td>
 316 <td>
 317                 <p>
 318                   Write some data to the handle.
 319                 </p>
 320               </td>
 321 </tr>
 322 </tbody>
 323 </table></div>
 324 <h5>
 325 <a name="boost_asio.reference.windows__basic_stream_handle.h2"></a>
 326         <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.protected_member_functions"></a></span><a class="link" href="windows__basic_stream_handle.html#boost_asio.reference.windows__basic_stream_handle.protected_member_functions">Protected
 327         Member Functions</a>
 328       </h5>
 329 <div class="informaltable"><table class="table">
 330 <colgroup>
 331 <col>
 332 <col>
 333 </colgroup>
 334 <thead><tr>
 335 <th>
 336                 <p>
 337                   Name
 338                 </p>
 339               </th>
 340 <th>
 341                 <p>
 342                   Description
 343                 </p>
 344               </th>
 345 </tr></thead>
 346 <tbody>
 347 <tr>
 348 <td>
 349                 <p>
 350                   <a class="link" href="windows__basic_stream_handle/get_implementation.html" title="windows::basic_stream_handle::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a>
 351                 </p>
 352               </td>
 353 <td>
 354                 <p>
 355                   Get the underlying implementation of the I/O object.
 356                 </p>
 357               </td>
 358 </tr>
 359 <tr>
 360 <td>
 361                 <p>
 362                   <a class="link" href="windows__basic_stream_handle/get_service.html" title="windows::basic_stream_handle::get_service"><span class="bold"><strong>get_service</strong></span></a>
 363                 </p>
 364               </td>
 365 <td>
 366                 <p>
 367                   Get the service associated with the I/O object.
 368                 </p>
 369               </td>
 370 </tr>
 371 </tbody>
 372 </table></div>
 373 <h5>
 374 <a name="boost_asio.reference.windows__basic_stream_handle.h3"></a>
 375         <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.protected_data_members"></a></span><a class="link" href="windows__basic_stream_handle.html#boost_asio.reference.windows__basic_stream_handle.protected_data_members">Protected
 376         Data Members</a>
 377       </h5>
 378 <div class="informaltable"><table class="table">
 379 <colgroup>
 380 <col>
 381 <col>
 382 </colgroup>
 383 <thead><tr>
 384 <th>
 385                 <p>
 386                   Name
 387                 </p>
 388               </th>
 389 <th>
 390                 <p>
 391                   Description
 392                 </p>
 393               </th>
 394 </tr></thead>
 395 <tbody>
 396 <tr>
 397 <td>
 398                 <p>
 399                   <a class="link" href="windows__basic_stream_handle/implementation.html" title="windows::basic_stream_handle::implementation"><span class="bold"><strong>implementation</strong></span></a>
 400                 </p>
 401               </td>
 402 <td>
 403                 <p>
 404                   (Deprecated: Use get_implementation().) The underlying implementation
 405                   of the I/O object.
 406                 </p>
 407               </td>
 408 </tr>
 409 <tr>
 410 <td>
 411                 <p>
 412                   <a class="link" href="windows__basic_stream_handle/service.html" title="windows::basic_stream_handle::service"><span class="bold"><strong>service</strong></span></a>
 413                 </p>
 414               </td>
 415 <td>
 416                 <p>
 417                   (Deprecated: Use get_service().) The service associated with the
 418                   I/O object.
 419                 </p>
 420               </td>
 421 </tr>
 422 </tbody>
 423 </table></div>
 424 <p>
 425         The <a class="link" href="windows__basic_stream_handle.html" title="windows::basic_stream_handle"><code class="computeroutput"><span class="identifier">windows</span><span class="special">::</span><span class="identifier">basic_stream_handle</span></code></a> class template
 426         provides asynchronous and blocking stream-oriented handle functionality.
 427       </p>
 428 <h5>
 429 <a name="boost_asio.reference.windows__basic_stream_handle.h4"></a>
 430         <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.thread_safety"></a></span><a class="link" href="windows__basic_stream_handle.html#boost_asio.reference.windows__basic_stream_handle.thread_safety">Thread
 431         Safety</a>
 432       </h5>
 433 <p>
 434         <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 435       </p>
 436 <p>
 437         <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
 438       </p>
 439 <h5>
 440 <a name="boost_asio.reference.windows__basic_stream_handle.h5"></a>
 441         <span class="phrase"><a name="boost_asio.reference.windows__basic_stream_handle.requirements"></a></span><a class="link" href="windows__basic_stream_handle.html#boost_asio.reference.windows__basic_stream_handle.requirements">Requirements</a>
 442       </h5>
 443 <p>
 444         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/basic_stream_handle.hpp</code>
 445       </p>
 446 <p>
 447         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 448       </p>
 449 </div>
 450 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 451 <td align="left"></td>
 452 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
 453         Distributed under the Boost Software License, Version 1.0. (See accompanying
 454         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>)
 455       </p>
 456 </div></td>
 457 </tr></table>
 458 <hr>
 459 <div class="spirit-nav">
 460 <a accesskey="p" href="windows__basic_random_access_handle/write_some_at/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="windows__basic_stream_handle/assign.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 461 </div>
 462 </body>
 463 </html>