doc/html/boost_asio/reference/stream_socket_service.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>stream_socket_service</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.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="strand.html" title="strand">
  10 <link rel="next" href="stream_socket_service/assign.html" title="stream_socket_service::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="strand.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="stream_socket_service/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.stream_socket_service"></a><a class="link" href="stream_socket_service.html" title="stream_socket_service">stream_socket_service</a>
  28 </h3></div></div></div>
  29 <p>
  30         Default service implementation for a stream socket.
  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="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">&gt;</span>
  34 <span class="keyword">class</span> <span class="identifier">stream_socket_service</span> <span class="special">:</span>
  35   <span class="keyword">public</span> <span class="identifier">io_service</span><span class="special">::</span><span class="identifier">service</span>
  36 </pre>
  37 <h5>
  38 <a name="boost_asio.reference.stream_socket_service.h0"></a>
  39         <span><a name="boost_asio.reference.stream_socket_service.types"></a></span><a class="link" href="stream_socket_service.html#boost_asio.reference.stream_socket_service.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="stream_socket_service/endpoint_type.html" title="stream_socket_service::endpoint_type"><span class="bold"><strong>endpoint_type</strong></span></a>
  63                 </p>
  64               </td>
  65 <td>
  66                 <p>
  67                   The endpoint type.
  68                 </p>
  69               </td>
  70 </tr>
  71 <tr>
  72 <td>
  73                 <p>
  74                   <a class="link" href="stream_socket_service/implementation_type.html" title="stream_socket_service::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a>
  75                 </p>
  76               </td>
  77 <td>
  78                 <p>
  79                   The type of a stream socket implementation.
  80                 </p>
  81               </td>
  82 </tr>
  83 <tr>
  84 <td>
  85                 <p>
  86                   <a class="link" href="stream_socket_service/native_handle_type.html" title="stream_socket_service::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a>
  87                 </p>
  88               </td>
  89 <td>
  90                 <p>
  91                   The native socket type.
  92                 </p>
  93               </td>
  94 </tr>
  95 <tr>
  96 <td>
  97                 <p>
  98                   <a class="link" href="stream_socket_service/native_type.html" title="stream_socket_service::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 socket type.
 104                 </p>
 105               </td>
 106 </tr>
 107 <tr>
 108 <td>
 109                 <p>
 110                   <a class="link" href="stream_socket_service/protocol_type.html" title="stream_socket_service::protocol_type"><span class="bold"><strong>protocol_type</strong></span></a>
 111                 </p>
 112               </td>
 113 <td>
 114                 <p>
 115                   The protocol type.
 116                 </p>
 117               </td>
 118 </tr>
 119 </tbody>
 120 </table></div>
 121 <h5>
 122 <a name="boost_asio.reference.stream_socket_service.h1"></a>
 123         <span><a name="boost_asio.reference.stream_socket_service.member_functions"></a></span><a class="link" href="stream_socket_service.html#boost_asio.reference.stream_socket_service.member_functions">Member
 124         Functions</a>
 125       </h5>
 126 <div class="informaltable"><table class="table">
 127 <colgroup>
 128 <col>
 129 <col>
 130 </colgroup>
 131 <thead><tr>
 132 <th>
 133                 <p>
 134                   Name
 135                 </p>
 136               </th>
 137 <th>
 138                 <p>
 139                   Description
 140                 </p>
 141               </th>
 142 </tr></thead>
 143 <tbody>
 144 <tr>
 145 <td>
 146                 <p>
 147                   <a class="link" href="stream_socket_service/assign.html" title="stream_socket_service::assign"><span class="bold"><strong>assign</strong></span></a>
 148                 </p>
 149               </td>
 150 <td>
 151                 <p>
 152                   Assign an existing native socket to a stream socket.
 153                 </p>
 154               </td>
 155 </tr>
 156 <tr>
 157 <td>
 158                 <p>
 159                   <a class="link" href="stream_socket_service/async_connect.html" title="stream_socket_service::async_connect"><span class="bold"><strong>async_connect</strong></span></a>
 160                 </p>
 161               </td>
 162 <td>
 163                 <p>
 164                   Start an asynchronous connect.
 165                 </p>
 166               </td>
 167 </tr>
 168 <tr>
 169 <td>
 170                 <p>
 171                   <a class="link" href="stream_socket_service/async_receive.html" title="stream_socket_service::async_receive"><span class="bold"><strong>async_receive</strong></span></a>
 172                 </p>
 173               </td>
 174 <td>
 175                 <p>
 176                   Start an asynchronous receive.
 177                 </p>
 178               </td>
 179 </tr>
 180 <tr>
 181 <td>
 182                 <p>
 183                   <a class="link" href="stream_socket_service/async_send.html" title="stream_socket_service::async_send"><span class="bold"><strong>async_send</strong></span></a>
 184                 </p>
 185               </td>
 186 <td>
 187                 <p>
 188                   Start an asynchronous send.
 189                 </p>
 190               </td>
 191 </tr>
 192 <tr>
 193 <td>
 194                 <p>
 195                   <a class="link" href="stream_socket_service/at_mark.html" title="stream_socket_service::at_mark"><span class="bold"><strong>at_mark</strong></span></a>
 196                 </p>
 197               </td>
 198 <td>
 199                 <p>
 200                   Determine whether the socket is at the out-of-band data mark.
 201                 </p>
 202               </td>
 203 </tr>
 204 <tr>
 205 <td>
 206                 <p>
 207                   <a class="link" href="stream_socket_service/available.html" title="stream_socket_service::available"><span class="bold"><strong>available</strong></span></a>
 208                 </p>
 209               </td>
 210 <td>
 211                 <p>
 212                   Determine the number of bytes available for reading.
 213                 </p>
 214               </td>
 215 </tr>
 216 <tr>
 217 <td>
 218                 <p>
 219                   <a class="link" href="stream_socket_service/bind.html" title="stream_socket_service::bind"><span class="bold"><strong>bind</strong></span></a>
 220                 </p>
 221               </td>
 222 <td>
 223                 <p>
 224                   Bind the stream socket to the specified local endpoint.
 225                 </p>
 226               </td>
 227 </tr>
 228 <tr>
 229 <td>
 230                 <p>
 231                   <a class="link" href="stream_socket_service/cancel.html" title="stream_socket_service::cancel"><span class="bold"><strong>cancel</strong></span></a>
 232                 </p>
 233               </td>
 234 <td>
 235                 <p>
 236                   Cancel all asynchronous operations associated with the socket.
 237                 </p>
 238               </td>
 239 </tr>
 240 <tr>
 241 <td>
 242                 <p>
 243                   <a class="link" href="stream_socket_service/close.html" title="stream_socket_service::close"><span class="bold"><strong>close</strong></span></a>
 244                 </p>
 245               </td>
 246 <td>
 247                 <p>
 248                   Close a stream socket implementation.
 249                 </p>
 250               </td>
 251 </tr>
 252 <tr>
 253 <td>
 254                 <p>
 255                   <a class="link" href="stream_socket_service/connect.html" title="stream_socket_service::connect"><span class="bold"><strong>connect</strong></span></a>
 256                 </p>
 257               </td>
 258 <td>
 259                 <p>
 260                   Connect the stream socket to the specified endpoint.
 261                 </p>
 262               </td>
 263 </tr>
 264 <tr>
 265 <td>
 266                 <p>
 267                   <a class="link" href="stream_socket_service/construct.html" title="stream_socket_service::construct"><span class="bold"><strong>construct</strong></span></a>
 268                 </p>
 269               </td>
 270 <td>
 271                 <p>
 272                   Construct a new stream socket implementation.
 273                 </p>
 274               </td>
 275 </tr>
 276 <tr>
 277 <td>
 278                 <p>
 279                   <a class="link" href="stream_socket_service/destroy.html" title="stream_socket_service::destroy"><span class="bold"><strong>destroy</strong></span></a>
 280                 </p>
 281               </td>
 282 <td>
 283                 <p>
 284                   Destroy a stream socket implementation.
 285                 </p>
 286               </td>
 287 </tr>
 288 <tr>
 289 <td>
 290                 <p>
 291                   <a class="link" href="stream_socket_service/get_io_service.html" title="stream_socket_service::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
 292                 </p>
 293               </td>
 294 <td>
 295                 <p>
 296                   Get the io_service object that owns the service.
 297                 </p>
 298               </td>
 299 </tr>
 300 <tr>
 301 <td>
 302                 <p>
 303                   <a class="link" href="stream_socket_service/get_option.html" title="stream_socket_service::get_option"><span class="bold"><strong>get_option</strong></span></a>
 304                 </p>
 305               </td>
 306 <td>
 307                 <p>
 308                   Get a socket option.
 309                 </p>
 310               </td>
 311 </tr>
 312 <tr>
 313 <td>
 314                 <p>
 315                   <a class="link" href="stream_socket_service/io_control.html" title="stream_socket_service::io_control"><span class="bold"><strong>io_control</strong></span></a>
 316                 </p>
 317               </td>
 318 <td>
 319                 <p>
 320                   Perform an IO control command on the socket.
 321                 </p>
 322               </td>
 323 </tr>
 324 <tr>
 325 <td>
 326                 <p>
 327                   <a class="link" href="stream_socket_service/is_open.html" title="stream_socket_service::is_open"><span class="bold"><strong>is_open</strong></span></a>
 328                 </p>
 329               </td>
 330 <td>
 331                 <p>
 332                   Determine whether the socket is open.
 333                 </p>
 334               </td>
 335 </tr>
 336 <tr>
 337 <td>
 338                 <p>
 339                   <a class="link" href="stream_socket_service/local_endpoint.html" title="stream_socket_service::local_endpoint"><span class="bold"><strong>local_endpoint</strong></span></a>
 340                 </p>
 341               </td>
 342 <td>
 343                 <p>
 344                   Get the local endpoint.
 345                 </p>
 346               </td>
 347 </tr>
 348 <tr>
 349 <td>
 350                 <p>
 351                   <a class="link" href="stream_socket_service/move_assign.html" title="stream_socket_service::move_assign"><span class="bold"><strong>move_assign</strong></span></a>
 352                 </p>
 353               </td>
 354 <td>
 355                 <p>
 356                   Move-assign from another stream socket implementation.
 357                 </p>
 358               </td>
 359 </tr>
 360 <tr>
 361 <td>
 362                 <p>
 363                   <a class="link" href="stream_socket_service/move_construct.html" title="stream_socket_service::move_construct"><span class="bold"><strong>move_construct</strong></span></a>
 364                 </p>
 365               </td>
 366 <td>
 367                 <p>
 368                   Move-construct a new stream socket implementation.
 369                 </p>
 370               </td>
 371 </tr>
 372 <tr>
 373 <td>
 374                 <p>
 375                   <a class="link" href="stream_socket_service/native.html" title="stream_socket_service::native"><span class="bold"><strong>native</strong></span></a>
 376                 </p>
 377               </td>
 378 <td>
 379                 <p>
 380                   (Deprecated: Use native_handle().) Get the native socket implementation.
 381                 </p>
 382               </td>
 383 </tr>
 384 <tr>
 385 <td>
 386                 <p>
 387                   <a class="link" href="stream_socket_service/native_handle.html" title="stream_socket_service::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
 388                 </p>
 389               </td>
 390 <td>
 391                 <p>
 392                   Get the native socket implementation.
 393                 </p>
 394               </td>
 395 </tr>
 396 <tr>
 397 <td>
 398                 <p>
 399                   <a class="link" href="stream_socket_service/native_non_blocking.html" title="stream_socket_service::native_non_blocking"><span class="bold"><strong>native_non_blocking</strong></span></a>
 400                 </p>
 401               </td>
 402 <td>
 403                 <p>
 404                   Gets the non-blocking mode of the native socket implementation.
 405                 </p>
 406                 <p>
 407                   Sets the non-blocking mode of the native socket implementation.
 408                 </p>
 409               </td>
 410 </tr>
 411 <tr>
 412 <td>
 413                 <p>
 414                   <a class="link" href="stream_socket_service/non_blocking.html" title="stream_socket_service::non_blocking"><span class="bold"><strong>non_blocking</strong></span></a>
 415                 </p>
 416               </td>
 417 <td>
 418                 <p>
 419                   Gets the non-blocking mode of the socket.
 420                 </p>
 421                 <p>
 422                   Sets the non-blocking mode of the socket.
 423                 </p>
 424               </td>
 425 </tr>
 426 <tr>
 427 <td>
 428                 <p>
 429                   <a class="link" href="stream_socket_service/open.html" title="stream_socket_service::open"><span class="bold"><strong>open</strong></span></a>
 430                 </p>
 431               </td>
 432 <td>
 433                 <p>
 434                   Open a stream socket.
 435                 </p>
 436               </td>
 437 </tr>
 438 <tr>
 439 <td>
 440                 <p>
 441                   <a class="link" href="stream_socket_service/receive.html" title="stream_socket_service::receive"><span class="bold"><strong>receive</strong></span></a>
 442                 </p>
 443               </td>
 444 <td>
 445                 <p>
 446                   Receive some data from the peer.
 447                 </p>
 448               </td>
 449 </tr>
 450 <tr>
 451 <td>
 452                 <p>
 453                   <a class="link" href="stream_socket_service/remote_endpoint.html" title="stream_socket_service::remote_endpoint"><span class="bold"><strong>remote_endpoint</strong></span></a>
 454                 </p>
 455               </td>
 456 <td>
 457                 <p>
 458                   Get the remote endpoint.
 459                 </p>
 460               </td>
 461 </tr>
 462 <tr>
 463 <td>
 464                 <p>
 465                   <a class="link" href="stream_socket_service/send.html" title="stream_socket_service::send"><span class="bold"><strong>send</strong></span></a>
 466                 </p>
 467               </td>
 468 <td>
 469                 <p>
 470                   Send the given data to the peer.
 471                 </p>
 472               </td>
 473 </tr>
 474 <tr>
 475 <td>
 476                 <p>
 477                   <a class="link" href="stream_socket_service/set_option.html" title="stream_socket_service::set_option"><span class="bold"><strong>set_option</strong></span></a>
 478                 </p>
 479               </td>
 480 <td>
 481                 <p>
 482                   Set a socket option.
 483                 </p>
 484               </td>
 485 </tr>
 486 <tr>
 487 <td>
 488                 <p>
 489                   <a class="link" href="stream_socket_service/shutdown.html" title="stream_socket_service::shutdown"><span class="bold"><strong>shutdown</strong></span></a>
 490                 </p>
 491               </td>
 492 <td>
 493                 <p>
 494                   Disable sends or receives on the socket.
 495                 </p>
 496               </td>
 497 </tr>
 498 <tr>
 499 <td>
 500                 <p>
 501                   <a class="link" href="stream_socket_service/stream_socket_service.html" title="stream_socket_service::stream_socket_service"><span class="bold"><strong>stream_socket_service</strong></span></a>
 502                 </p>
 503               </td>
 504 <td>
 505                 <p>
 506                   Construct a new stream socket service for the specified io_service.
 507                 </p>
 508               </td>
 509 </tr>
 510 </tbody>
 511 </table></div>
 512 <h5>
 513 <a name="boost_asio.reference.stream_socket_service.h2"></a>
 514         <span><a name="boost_asio.reference.stream_socket_service.data_members"></a></span><a class="link" href="stream_socket_service.html#boost_asio.reference.stream_socket_service.data_members">Data Members</a>
 515       </h5>
 516 <div class="informaltable"><table class="table">
 517 <colgroup>
 518 <col>
 519 <col>
 520 </colgroup>
 521 <thead><tr>
 522 <th>
 523                 <p>
 524                   Name
 525                 </p>
 526               </th>
 527 <th>
 528                 <p>
 529                   Description
 530                 </p>
 531               </th>
 532 </tr></thead>
 533 <tbody><tr>
 534 <td>
 535                 <p>
 536                   <a class="link" href="stream_socket_service/id.html" title="stream_socket_service::id"><span class="bold"><strong>id</strong></span></a>
 537                 </p>
 538               </td>
 539 <td>
 540                 <p>
 541                   The unique service identifier.
 542                 </p>
 543               </td>
 544 </tr></tbody>
 545 </table></div>
 546 <h5>
 547 <a name="boost_asio.reference.stream_socket_service.h3"></a>
 548         <span><a name="boost_asio.reference.stream_socket_service.requirements"></a></span><a class="link" href="stream_socket_service.html#boost_asio.reference.stream_socket_service.requirements">Requirements</a>
 549       </h5>
 550 <p>
 551         <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/stream_socket_service.hpp</code>
 552       </p>
 553 <p>
 554         <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code>
 555       </p>
 556 </div>
 557 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 558 <td align="left"></td>
 559 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2012 Christopher M. Kohlhoff<p>
 560         Distributed under the Boost Software License, Version 1.0. (See accompanying
 561         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>)
 562       </p>
 563 </div></td>
 564 </tr></table>
 565 <hr>
 566 <div class="spirit-nav">
 567 <a accesskey="p" href="strand.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="stream_socket_service/assign.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 568 </div>
 569 </body>
 570 </html>