doc/html/boost_asio/reference/basic_stream_socket.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_stream_socket</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="basic_socket_streambuf/_basic_socket_streambuf.html" title="basic_socket_streambuf::~basic_socket_streambuf">
  10 <link rel="next" href="basic_stream_socket/assign.html" title="basic_stream_socket::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="basic_socket_streambuf/_basic_socket_streambuf.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_stream_socket/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.basic_stream_socket"></a><a class="link" href="basic_stream_socket.html" title="basic_stream_socket">basic_stream_socket</a>
  28 </h3></div></div></div>
  29 <p>
  30         Provides stream-oriented socket 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="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">,</span>
  34     <span class="keyword">typename</span> <a class="link" href="StreamSocketService.html" title="Stream socket service requirements">StreamSocketService</a> <span class="special">=</span> <span class="identifier">stream_socket_service</span><span class="special">&lt;</span><span class="identifier">Protocol</span><span class="special">&gt;&gt;</span>
  35 <span class="keyword">class</span> <span class="identifier">basic_stream_socket</span> <span class="special">:</span>
  36   <span class="keyword">public</span> <span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">StreamSocketService</span> <span class="special">&gt;</span>
  37 </pre>
  38 <h5>
  39 <a name="boost_asio.reference.basic_stream_socket.h0"></a>
  40         <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.types"></a></span><a class="link" href="basic_stream_socket.html#boost_asio.reference.basic_stream_socket.types">Types</a>
  41       </h5>
  42 <div class="informaltable"><table class="table">
  43 <colgroup>
  44 <col>
  45 <col>
  46 </colgroup>
  47 <thead><tr>
  48 <th>
  49                 <p>
  50                   Name
  51                 </p>
  52               </th>
  53 <th>
  54                 <p>
  55                   Description
  56                 </p>
  57               </th>
  58 </tr></thead>
  59 <tbody>
  60 <tr>
  61 <td>
  62                 <p>
  63                   <a class="link" href="basic_stream_socket/broadcast.html" title="basic_stream_socket::broadcast"><span class="bold"><strong>broadcast</strong></span></a>
  64                 </p>
  65               </td>
  66 <td>
  67                 <p>
  68                   Socket option to permit sending of broadcast messages.
  69                 </p>
  70               </td>
  71 </tr>
  72 <tr>
  73 <td>
  74                 <p>
  75                   <a class="link" href="basic_stream_socket/bytes_readable.html" title="basic_stream_socket::bytes_readable"><span class="bold"><strong>bytes_readable</strong></span></a>
  76                 </p>
  77               </td>
  78 <td>
  79                 <p>
  80                   IO control command to get the amount of data that can be read without
  81                   blocking.
  82                 </p>
  83               </td>
  84 </tr>
  85 <tr>
  86 <td>
  87                 <p>
  88                   <a class="link" href="basic_stream_socket/debug.html" title="basic_stream_socket::debug"><span class="bold"><strong>debug</strong></span></a>
  89                 </p>
  90               </td>
  91 <td>
  92                 <p>
  93                   Socket option to enable socket-level debugging.
  94                 </p>
  95               </td>
  96 </tr>
  97 <tr>
  98 <td>
  99                 <p>
 100                   <a class="link" href="basic_stream_socket/do_not_route.html" title="basic_stream_socket::do_not_route"><span class="bold"><strong>do_not_route</strong></span></a>
 101                 </p>
 102               </td>
 103 <td>
 104                 <p>
 105                   Socket option to prevent routing, use local interfaces only.
 106                 </p>
 107               </td>
 108 </tr>
 109 <tr>
 110 <td>
 111                 <p>
 112                   <a class="link" href="basic_stream_socket/enable_connection_aborted.html" title="basic_stream_socket::enable_connection_aborted"><span class="bold"><strong>enable_connection_aborted</strong></span></a>
 113                 </p>
 114               </td>
 115 <td>
 116                 <p>
 117                   Socket option to report aborted connections on accept.
 118                 </p>
 119               </td>
 120 </tr>
 121 <tr>
 122 <td>
 123                 <p>
 124                   <a class="link" href="basic_stream_socket/endpoint_type.html" title="basic_stream_socket::endpoint_type"><span class="bold"><strong>endpoint_type</strong></span></a>
 125                 </p>
 126               </td>
 127 <td>
 128                 <p>
 129                   The endpoint type.
 130                 </p>
 131               </td>
 132 </tr>
 133 <tr>
 134 <td>
 135                 <p>
 136                   <a class="link" href="basic_stream_socket/implementation_type.html" title="basic_stream_socket::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a>
 137                 </p>
 138               </td>
 139 <td>
 140                 <p>
 141                   The underlying implementation type of I/O object.
 142                 </p>
 143               </td>
 144 </tr>
 145 <tr>
 146 <td>
 147                 <p>
 148                   <a class="link" href="basic_stream_socket/keep_alive.html" title="basic_stream_socket::keep_alive"><span class="bold"><strong>keep_alive</strong></span></a>
 149                 </p>
 150               </td>
 151 <td>
 152                 <p>
 153                   Socket option to send keep-alives.
 154                 </p>
 155               </td>
 156 </tr>
 157 <tr>
 158 <td>
 159                 <p>
 160                   <a class="link" href="basic_stream_socket/linger.html" title="basic_stream_socket::linger"><span class="bold"><strong>linger</strong></span></a>
 161                 </p>
 162               </td>
 163 <td>
 164                 <p>
 165                   Socket option to specify whether the socket lingers on close if
 166                   unsent data is present.
 167                 </p>
 168               </td>
 169 </tr>
 170 <tr>
 171 <td>
 172                 <p>
 173                   <a class="link" href="basic_stream_socket/lowest_layer_type.html" title="basic_stream_socket::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a>
 174                 </p>
 175               </td>
 176 <td>
 177                 <p>
 178                   A basic_socket is always the lowest layer.
 179                 </p>
 180               </td>
 181 </tr>
 182 <tr>
 183 <td>
 184                 <p>
 185                   <a class="link" href="basic_stream_socket/message_flags.html" title="basic_stream_socket::message_flags"><span class="bold"><strong>message_flags</strong></span></a>
 186                 </p>
 187               </td>
 188 <td>
 189                 <p>
 190                   Bitmask type for flags that can be passed to send and receive operations.
 191                 </p>
 192               </td>
 193 </tr>
 194 <tr>
 195 <td>
 196                 <p>
 197                   <a class="link" href="basic_stream_socket/native_handle_type.html" title="basic_stream_socket::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a>
 198                 </p>
 199               </td>
 200 <td>
 201                 <p>
 202                   The native representation of a socket.
 203                 </p>
 204               </td>
 205 </tr>
 206 <tr>
 207 <td>
 208                 <p>
 209                   <a class="link" href="basic_stream_socket/native_type.html" title="basic_stream_socket::native_type"><span class="bold"><strong>native_type</strong></span></a>
 210                 </p>
 211               </td>
 212 <td>
 213                 <p>
 214                   (Deprecated: Use native_handle_type.) The native representation
 215                   of a socket.
 216                 </p>
 217               </td>
 218 </tr>
 219 <tr>
 220 <td>
 221                 <p>
 222                   <a class="link" href="basic_stream_socket/non_blocking_io.html" title="basic_stream_socket::non_blocking_io"><span class="bold"><strong>non_blocking_io</strong></span></a>
 223                 </p>
 224               </td>
 225 <td>
 226                 <p>
 227                   (Deprecated: Use non_blocking().) IO control command to set the
 228                   blocking mode of the socket.
 229                 </p>
 230               </td>
 231 </tr>
 232 <tr>
 233 <td>
 234                 <p>
 235                   <a class="link" href="basic_stream_socket/protocol_type.html" title="basic_stream_socket::protocol_type"><span class="bold"><strong>protocol_type</strong></span></a>
 236                 </p>
 237               </td>
 238 <td>
 239                 <p>
 240                   The protocol type.
 241                 </p>
 242               </td>
 243 </tr>
 244 <tr>
 245 <td>
 246                 <p>
 247                   <a class="link" href="basic_stream_socket/receive_buffer_size.html" title="basic_stream_socket::receive_buffer_size"><span class="bold"><strong>receive_buffer_size</strong></span></a>
 248                 </p>
 249               </td>
 250 <td>
 251                 <p>
 252                   Socket option for the receive buffer size of a socket.
 253                 </p>
 254               </td>
 255 </tr>
 256 <tr>
 257 <td>
 258                 <p>
 259                   <a class="link" href="basic_stream_socket/receive_low_watermark.html" title="basic_stream_socket::receive_low_watermark"><span class="bold"><strong>receive_low_watermark</strong></span></a>
 260                 </p>
 261               </td>
 262 <td>
 263                 <p>
 264                   Socket option for the receive low watermark.
 265                 </p>
 266               </td>
 267 </tr>
 268 <tr>
 269 <td>
 270                 <p>
 271                   <a class="link" href="basic_stream_socket/reuse_address.html" title="basic_stream_socket::reuse_address"><span class="bold"><strong>reuse_address</strong></span></a>
 272                 </p>
 273               </td>
 274 <td>
 275                 <p>
 276                   Socket option to allow the socket to be bound to an address that
 277                   is already in use.
 278                 </p>
 279               </td>
 280 </tr>
 281 <tr>
 282 <td>
 283                 <p>
 284                   <a class="link" href="basic_stream_socket/send_buffer_size.html" title="basic_stream_socket::send_buffer_size"><span class="bold"><strong>send_buffer_size</strong></span></a>
 285                 </p>
 286               </td>
 287 <td>
 288                 <p>
 289                   Socket option for the send buffer size of a socket.
 290                 </p>
 291               </td>
 292 </tr>
 293 <tr>
 294 <td>
 295                 <p>
 296                   <a class="link" href="basic_stream_socket/send_low_watermark.html" title="basic_stream_socket::send_low_watermark"><span class="bold"><strong>send_low_watermark</strong></span></a>
 297                 </p>
 298               </td>
 299 <td>
 300                 <p>
 301                   Socket option for the send low watermark.
 302                 </p>
 303               </td>
 304 </tr>
 305 <tr>
 306 <td>
 307                 <p>
 308                   <a class="link" href="basic_stream_socket/service_type.html" title="basic_stream_socket::service_type"><span class="bold"><strong>service_type</strong></span></a>
 309                 </p>
 310               </td>
 311 <td>
 312                 <p>
 313                   The type of the service that will be used to provide I/O operations.
 314                 </p>
 315               </td>
 316 </tr>
 317 <tr>
 318 <td>
 319                 <p>
 320                   <a class="link" href="basic_stream_socket/shutdown_type.html" title="basic_stream_socket::shutdown_type"><span class="bold"><strong>shutdown_type</strong></span></a>
 321                 </p>
 322               </td>
 323 <td>
 324                 <p>
 325                   Different ways a socket may be shutdown.
 326                 </p>
 327               </td>
 328 </tr>
 329 </tbody>
 330 </table></div>
 331 <h5>
 332 <a name="boost_asio.reference.basic_stream_socket.h1"></a>
 333         <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.member_functions"></a></span><a class="link" href="basic_stream_socket.html#boost_asio.reference.basic_stream_socket.member_functions">Member
 334         Functions</a>
 335       </h5>
 336 <div class="informaltable"><table class="table">
 337 <colgroup>
 338 <col>
 339 <col>
 340 </colgroup>
 341 <thead><tr>
 342 <th>
 343                 <p>
 344                   Name
 345                 </p>
 346               </th>
 347 <th>
 348                 <p>
 349                   Description
 350                 </p>
 351               </th>
 352 </tr></thead>
 353 <tbody>
 354 <tr>
 355 <td>
 356                 <p>
 357                   <a class="link" href="basic_stream_socket/assign.html" title="basic_stream_socket::assign"><span class="bold"><strong>assign</strong></span></a>
 358                 </p>
 359               </td>
 360 <td>
 361                 <p>
 362                   Assign an existing native socket to the socket.
 363                 </p>
 364               </td>
 365 </tr>
 366 <tr>
 367 <td>
 368                 <p>
 369                   <a class="link" href="basic_stream_socket/async_connect.html" title="basic_stream_socket::async_connect"><span class="bold"><strong>async_connect</strong></span></a>
 370                 </p>
 371               </td>
 372 <td>
 373                 <p>
 374                   Start an asynchronous connect.
 375                 </p>
 376               </td>
 377 </tr>
 378 <tr>
 379 <td>
 380                 <p>
 381                   <a class="link" href="basic_stream_socket/async_read_some.html" title="basic_stream_socket::async_read_some"><span class="bold"><strong>async_read_some</strong></span></a>
 382                 </p>
 383               </td>
 384 <td>
 385                 <p>
 386                   Start an asynchronous read.
 387                 </p>
 388               </td>
 389 </tr>
 390 <tr>
 391 <td>
 392                 <p>
 393                   <a class="link" href="basic_stream_socket/async_receive.html" title="basic_stream_socket::async_receive"><span class="bold"><strong>async_receive</strong></span></a>
 394                 </p>
 395               </td>
 396 <td>
 397                 <p>
 398                   Start an asynchronous receive.
 399                 </p>
 400               </td>
 401 </tr>
 402 <tr>
 403 <td>
 404                 <p>
 405                   <a class="link" href="basic_stream_socket/async_send.html" title="basic_stream_socket::async_send"><span class="bold"><strong>async_send</strong></span></a>
 406                 </p>
 407               </td>
 408 <td>
 409                 <p>
 410                   Start an asynchronous send.
 411                 </p>
 412               </td>
 413 </tr>
 414 <tr>
 415 <td>
 416                 <p>
 417                   <a class="link" href="basic_stream_socket/async_write_some.html" title="basic_stream_socket::async_write_some"><span class="bold"><strong>async_write_some</strong></span></a>
 418                 </p>
 419               </td>
 420 <td>
 421                 <p>
 422                   Start an asynchronous write.
 423                 </p>
 424               </td>
 425 </tr>
 426 <tr>
 427 <td>
 428                 <p>
 429                   <a class="link" href="basic_stream_socket/at_mark.html" title="basic_stream_socket::at_mark"><span class="bold"><strong>at_mark</strong></span></a>
 430                 </p>
 431               </td>
 432 <td>
 433                 <p>
 434                   Determine whether the socket is at the out-of-band data mark.
 435                 </p>
 436               </td>
 437 </tr>
 438 <tr>
 439 <td>
 440                 <p>
 441                   <a class="link" href="basic_stream_socket/available.html" title="basic_stream_socket::available"><span class="bold"><strong>available</strong></span></a>
 442                 </p>
 443               </td>
 444 <td>
 445                 <p>
 446                   Determine the number of bytes available for reading.
 447                 </p>
 448               </td>
 449 </tr>
 450 <tr>
 451 <td>
 452                 <p>
 453                   <a class="link" href="basic_stream_socket/basic_stream_socket.html" title="basic_stream_socket::basic_stream_socket"><span class="bold"><strong>basic_stream_socket</strong></span></a>
 454                 </p>
 455               </td>
 456 <td>
 457                 <p>
 458                   Construct a basic_stream_socket without opening it.
 459                 </p>
 460                 <p>
 461                   Construct and open a basic_stream_socket.
 462                 </p>
 463                 <p>
 464                   Construct a basic_stream_socket, opening it and binding it to the
 465                   given local endpoint.
 466                 </p>
 467                 <p>
 468                   Construct a basic_stream_socket on an existing native socket.
 469                 </p>
 470                 <p>
 471                   Move-construct a basic_stream_socket from another.
 472                 </p>
 473                 <p>
 474                   Move-construct a basic_stream_socket from a socket of another protocol
 475                   type.
 476                 </p>
 477               </td>
 478 </tr>
 479 <tr>
 480 <td>
 481                 <p>
 482                   <a class="link" href="basic_stream_socket/bind.html" title="basic_stream_socket::bind"><span class="bold"><strong>bind</strong></span></a>
 483                 </p>
 484               </td>
 485 <td>
 486                 <p>
 487                   Bind the socket to the given local endpoint.
 488                 </p>
 489               </td>
 490 </tr>
 491 <tr>
 492 <td>
 493                 <p>
 494                   <a class="link" href="basic_stream_socket/cancel.html" title="basic_stream_socket::cancel"><span class="bold"><strong>cancel</strong></span></a>
 495                 </p>
 496               </td>
 497 <td>
 498                 <p>
 499                   Cancel all asynchronous operations associated with the socket.
 500                 </p>
 501               </td>
 502 </tr>
 503 <tr>
 504 <td>
 505                 <p>
 506                   <a class="link" href="basic_stream_socket/close.html" title="basic_stream_socket::close"><span class="bold"><strong>close</strong></span></a>
 507                 </p>
 508               </td>
 509 <td>
 510                 <p>
 511                   Close the socket.
 512                 </p>
 513               </td>
 514 </tr>
 515 <tr>
 516 <td>
 517                 <p>
 518                   <a class="link" href="basic_stream_socket/connect.html" title="basic_stream_socket::connect"><span class="bold"><strong>connect</strong></span></a>
 519                 </p>
 520               </td>
 521 <td>
 522                 <p>
 523                   Connect the socket to the specified endpoint.
 524                 </p>
 525               </td>
 526 </tr>
 527 <tr>
 528 <td>
 529                 <p>
 530                   <a class="link" href="basic_stream_socket/get_io_service.html" title="basic_stream_socket::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
 531                 </p>
 532               </td>
 533 <td>
 534                 <p>
 535                   Get the io_service associated with the object.
 536                 </p>
 537               </td>
 538 </tr>
 539 <tr>
 540 <td>
 541                 <p>
 542                   <a class="link" href="basic_stream_socket/get_option.html" title="basic_stream_socket::get_option"><span class="bold"><strong>get_option</strong></span></a>
 543                 </p>
 544               </td>
 545 <td>
 546                 <p>
 547                   Get an option from the socket.
 548                 </p>
 549               </td>
 550 </tr>
 551 <tr>
 552 <td>
 553                 <p>
 554                   <a class="link" href="basic_stream_socket/io_control.html" title="basic_stream_socket::io_control"><span class="bold"><strong>io_control</strong></span></a>
 555                 </p>
 556               </td>
 557 <td>
 558                 <p>
 559                   Perform an IO control command on the socket.
 560                 </p>
 561               </td>
 562 </tr>
 563 <tr>
 564 <td>
 565                 <p>
 566                   <a class="link" href="basic_stream_socket/is_open.html" title="basic_stream_socket::is_open"><span class="bold"><strong>is_open</strong></span></a>
 567                 </p>
 568               </td>
 569 <td>
 570                 <p>
 571                   Determine whether the socket is open.
 572                 </p>
 573               </td>
 574 </tr>
 575 <tr>
 576 <td>
 577                 <p>
 578                   <a class="link" href="basic_stream_socket/local_endpoint.html" title="basic_stream_socket::local_endpoint"><span class="bold"><strong>local_endpoint</strong></span></a>
 579                 </p>
 580               </td>
 581 <td>
 582                 <p>
 583                   Get the local endpoint of the socket.
 584                 </p>
 585               </td>
 586 </tr>
 587 <tr>
 588 <td>
 589                 <p>
 590                   <a class="link" href="basic_stream_socket/lowest_layer.html" title="basic_stream_socket::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a>
 591                 </p>
 592               </td>
 593 <td>
 594                 <p>
 595                   Get a reference to the lowest layer.
 596                 </p>
 597                 <p>
 598                   Get a const reference to the lowest layer.
 599                 </p>
 600               </td>
 601 </tr>
 602 <tr>
 603 <td>
 604                 <p>
 605                   <a class="link" href="basic_stream_socket/native.html" title="basic_stream_socket::native"><span class="bold"><strong>native</strong></span></a>
 606                 </p>
 607               </td>
 608 <td>
 609                 <p>
 610                   (Deprecated: Use native_handle().) Get the native socket representation.
 611                 </p>
 612               </td>
 613 </tr>
 614 <tr>
 615 <td>
 616                 <p>
 617                   <a class="link" href="basic_stream_socket/native_handle.html" title="basic_stream_socket::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
 618                 </p>
 619               </td>
 620 <td>
 621                 <p>
 622                   Get the native socket representation.
 623                 </p>
 624               </td>
 625 </tr>
 626 <tr>
 627 <td>
 628                 <p>
 629                   <a class="link" href="basic_stream_socket/native_non_blocking.html" title="basic_stream_socket::native_non_blocking"><span class="bold"><strong>native_non_blocking</strong></span></a>
 630                 </p>
 631               </td>
 632 <td>
 633                 <p>
 634                   Gets the non-blocking mode of the native socket implementation.
 635                 </p>
 636                 <p>
 637                   Sets the non-blocking mode of the native socket implementation.
 638                 </p>
 639               </td>
 640 </tr>
 641 <tr>
 642 <td>
 643                 <p>
 644                   <a class="link" href="basic_stream_socket/non_blocking.html" title="basic_stream_socket::non_blocking"><span class="bold"><strong>non_blocking</strong></span></a>
 645                 </p>
 646               </td>
 647 <td>
 648                 <p>
 649                   Gets the non-blocking mode of the socket.
 650                 </p>
 651                 <p>
 652                   Sets the non-blocking mode of the socket.
 653                 </p>
 654               </td>
 655 </tr>
 656 <tr>
 657 <td>
 658                 <p>
 659                   <a class="link" href="basic_stream_socket/open.html" title="basic_stream_socket::open"><span class="bold"><strong>open</strong></span></a>
 660                 </p>
 661               </td>
 662 <td>
 663                 <p>
 664                   Open the socket using the specified protocol.
 665                 </p>
 666               </td>
 667 </tr>
 668 <tr>
 669 <td>
 670                 <p>
 671                   <a class="link" href="basic_stream_socket/operator_eq_.html" title="basic_stream_socket::operator="><span class="bold"><strong>operator=</strong></span></a>
 672                 </p>
 673               </td>
 674 <td>
 675                 <p>
 676                   Move-assign a basic_stream_socket from another.
 677                 </p>
 678                 <p>
 679                   Move-assign a basic_stream_socket from a socket of another protocol
 680                   type.
 681                 </p>
 682               </td>
 683 </tr>
 684 <tr>
 685 <td>
 686                 <p>
 687                   <a class="link" href="basic_stream_socket/read_some.html" title="basic_stream_socket::read_some"><span class="bold"><strong>read_some</strong></span></a>
 688                 </p>
 689               </td>
 690 <td>
 691                 <p>
 692                   Read some data from the socket.
 693                 </p>
 694               </td>
 695 </tr>
 696 <tr>
 697 <td>
 698                 <p>
 699                   <a class="link" href="basic_stream_socket/receive.html" title="basic_stream_socket::receive"><span class="bold"><strong>receive</strong></span></a>
 700                 </p>
 701               </td>
 702 <td>
 703                 <p>
 704                   Receive some data on the socket.
 705                 </p>
 706                 <p>
 707                   Receive some data on a connected socket.
 708                 </p>
 709               </td>
 710 </tr>
 711 <tr>
 712 <td>
 713                 <p>
 714                   <a class="link" href="basic_stream_socket/remote_endpoint.html" title="basic_stream_socket::remote_endpoint"><span class="bold"><strong>remote_endpoint</strong></span></a>
 715                 </p>
 716               </td>
 717 <td>
 718                 <p>
 719                   Get the remote endpoint of the socket.
 720                 </p>
 721               </td>
 722 </tr>
 723 <tr>
 724 <td>
 725                 <p>
 726                   <a class="link" href="basic_stream_socket/send.html" title="basic_stream_socket::send"><span class="bold"><strong>send</strong></span></a>
 727                 </p>
 728               </td>
 729 <td>
 730                 <p>
 731                   Send some data on the socket.
 732                 </p>
 733               </td>
 734 </tr>
 735 <tr>
 736 <td>
 737                 <p>
 738                   <a class="link" href="basic_stream_socket/set_option.html" title="basic_stream_socket::set_option"><span class="bold"><strong>set_option</strong></span></a>
 739                 </p>
 740               </td>
 741 <td>
 742                 <p>
 743                   Set an option on the socket.
 744                 </p>
 745               </td>
 746 </tr>
 747 <tr>
 748 <td>
 749                 <p>
 750                   <a class="link" href="basic_stream_socket/shutdown.html" title="basic_stream_socket::shutdown"><span class="bold"><strong>shutdown</strong></span></a>
 751                 </p>
 752               </td>
 753 <td>
 754                 <p>
 755                   Disable sends or receives on the socket.
 756                 </p>
 757               </td>
 758 </tr>
 759 <tr>
 760 <td>
 761                 <p>
 762                   <a class="link" href="basic_stream_socket/write_some.html" title="basic_stream_socket::write_some"><span class="bold"><strong>write_some</strong></span></a>
 763                 </p>
 764               </td>
 765 <td>
 766                 <p>
 767                   Write some data to the socket.
 768                 </p>
 769               </td>
 770 </tr>
 771 </tbody>
 772 </table></div>
 773 <h5>
 774 <a name="boost_asio.reference.basic_stream_socket.h2"></a>
 775         <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.protected_member_functions"></a></span><a class="link" href="basic_stream_socket.html#boost_asio.reference.basic_stream_socket.protected_member_functions">Protected
 776         Member Functions</a>
 777       </h5>
 778 <div class="informaltable"><table class="table">
 779 <colgroup>
 780 <col>
 781 <col>
 782 </colgroup>
 783 <thead><tr>
 784 <th>
 785                 <p>
 786                   Name
 787                 </p>
 788               </th>
 789 <th>
 790                 <p>
 791                   Description
 792                 </p>
 793               </th>
 794 </tr></thead>
 795 <tbody>
 796 <tr>
 797 <td>
 798                 <p>
 799                   <a class="link" href="basic_stream_socket/get_implementation.html" title="basic_stream_socket::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a>
 800                 </p>
 801               </td>
 802 <td>
 803                 <p>
 804                   Get the underlying implementation of the I/O object.
 805                 </p>
 806               </td>
 807 </tr>
 808 <tr>
 809 <td>
 810                 <p>
 811                   <a class="link" href="basic_stream_socket/get_service.html" title="basic_stream_socket::get_service"><span class="bold"><strong>get_service</strong></span></a>
 812                 </p>
 813               </td>
 814 <td>
 815                 <p>
 816                   Get the service associated with the I/O object.
 817                 </p>
 818               </td>
 819 </tr>
 820 </tbody>
 821 </table></div>
 822 <h5>
 823 <a name="boost_asio.reference.basic_stream_socket.h3"></a>
 824         <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.data_members"></a></span><a class="link" href="basic_stream_socket.html#boost_asio.reference.basic_stream_socket.data_members">Data Members</a>
 825       </h5>
 826 <div class="informaltable"><table class="table">
 827 <colgroup>
 828 <col>
 829 <col>
 830 </colgroup>
 831 <thead><tr>
 832 <th>
 833                 <p>
 834                   Name
 835                 </p>
 836               </th>
 837 <th>
 838                 <p>
 839                   Description
 840                 </p>
 841               </th>
 842 </tr></thead>
 843 <tbody>
 844 <tr>
 845 <td>
 846                 <p>
 847                   <a class="link" href="basic_stream_socket/max_connections.html" title="basic_stream_socket::max_connections"><span class="bold"><strong>max_connections</strong></span></a>
 848                 </p>
 849               </td>
 850 <td>
 851                 <p>
 852                   The maximum length of the queue of pending incoming connections.
 853                 </p>
 854               </td>
 855 </tr>
 856 <tr>
 857 <td>
 858                 <p>
 859                   <a class="link" href="basic_stream_socket/message_do_not_route.html" title="basic_stream_socket::message_do_not_route"><span class="bold"><strong>message_do_not_route</strong></span></a>
 860                 </p>
 861               </td>
 862 <td>
 863                 <p>
 864                   Specify that the data should not be subject to routing.
 865                 </p>
 866               </td>
 867 </tr>
 868 <tr>
 869 <td>
 870                 <p>
 871                   <a class="link" href="basic_stream_socket/message_end_of_record.html" title="basic_stream_socket::message_end_of_record"><span class="bold"><strong>message_end_of_record</strong></span></a>
 872                 </p>
 873               </td>
 874 <td>
 875                 <p>
 876                   Specifies that the data marks the end of a record.
 877                 </p>
 878               </td>
 879 </tr>
 880 <tr>
 881 <td>
 882                 <p>
 883                   <a class="link" href="basic_stream_socket/message_out_of_band.html" title="basic_stream_socket::message_out_of_band"><span class="bold"><strong>message_out_of_band</strong></span></a>
 884                 </p>
 885               </td>
 886 <td>
 887                 <p>
 888                   Process out-of-band data.
 889                 </p>
 890               </td>
 891 </tr>
 892 <tr>
 893 <td>
 894                 <p>
 895                   <a class="link" href="basic_stream_socket/message_peek.html" title="basic_stream_socket::message_peek"><span class="bold"><strong>message_peek</strong></span></a>
 896                 </p>
 897               </td>
 898 <td>
 899                 <p>
 900                   Peek at incoming data without removing it from the input queue.
 901                 </p>
 902               </td>
 903 </tr>
 904 </tbody>
 905 </table></div>
 906 <h5>
 907 <a name="boost_asio.reference.basic_stream_socket.h4"></a>
 908         <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.protected_data_members"></a></span><a class="link" href="basic_stream_socket.html#boost_asio.reference.basic_stream_socket.protected_data_members">Protected
 909         Data Members</a>
 910       </h5>
 911 <div class="informaltable"><table class="table">
 912 <colgroup>
 913 <col>
 914 <col>
 915 </colgroup>
 916 <thead><tr>
 917 <th>
 918                 <p>
 919                   Name
 920                 </p>
 921               </th>
 922 <th>
 923                 <p>
 924                   Description
 925                 </p>
 926               </th>
 927 </tr></thead>
 928 <tbody>
 929 <tr>
 930 <td>
 931                 <p>
 932                   <a class="link" href="basic_stream_socket/implementation.html" title="basic_stream_socket::implementation"><span class="bold"><strong>implementation</strong></span></a>
 933                 </p>
 934               </td>
 935 <td>
 936                 <p>
 937                   (Deprecated: Use get_implementation().) The underlying implementation
 938                   of the I/O object.
 939                 </p>
 940               </td>
 941 </tr>
 942 <tr>
 943 <td>
 944                 <p>
 945                   <a class="link" href="basic_stream_socket/service.html" title="basic_stream_socket::service"><span class="bold"><strong>service</strong></span></a>
 946                 </p>
 947               </td>
 948 <td>
 949                 <p>
 950                   (Deprecated: Use get_service().) The service associated with the
 951                   I/O object.
 952                 </p>
 953               </td>
 954 </tr>
 955 </tbody>
 956 </table></div>
 957 <p>
 958         The <a class="link" href="basic_stream_socket.html" title="basic_stream_socket"><code class="computeroutput"><span class="identifier">basic_stream_socket</span></code></a> class template
 959         provides asynchronous and blocking stream-oriented socket functionality.
 960       </p>
 961 <h5>
 962 <a name="boost_asio.reference.basic_stream_socket.h5"></a>
 963         <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.thread_safety"></a></span><a class="link" href="basic_stream_socket.html#boost_asio.reference.basic_stream_socket.thread_safety">Thread Safety</a>
 964       </h5>
 965 <p>
 966         <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 967       </p>
 968 <p>
 969         <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
 970       </p>
 971 <h5>
 972 <a name="boost_asio.reference.basic_stream_socket.h6"></a>
 973         <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.requirements"></a></span><a class="link" href="basic_stream_socket.html#boost_asio.reference.basic_stream_socket.requirements">Requirements</a>
 974       </h5>
 975 <p>
 976         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_stream_socket.hpp</code>
 977       </p>
 978 <p>
 979         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 980       </p>
 981 </div>
 982 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 983 <td align="left"></td>
 984 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
 985         Distributed under the Boost Software License, Version 1.0. (See accompanying
 986         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>)
 987       </p>
 988 </div></td>
 989 </tr></table>
 990 <hr>
 991 <div class="spirit-nav">
 992 <a accesskey="p" href="basic_socket_streambuf/_basic_socket_streambuf.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_stream_socket/assign.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 993 </div>
 994 </body>
 995 </html>