1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 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">template< 33 typename <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a>, 34 typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>> 35class basic_stream_socket : 36 public basic_socket< Protocol, Executor > 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__rebind_executor.html" title="basic_stream_socket::rebind_executor"><span class="bold"><strong>rebind_executor</strong></span></a> 64 </p> 65 </td> 66<td> 67 <p> 68 Rebinds the socket type to another executor. 69 </p> 70 </td> 71</tr> 72<tr> 73<td> 74 <p> 75 <a class="link" href="basic_stream_socket/broadcast.html" title="basic_stream_socket::broadcast"><span class="bold"><strong>broadcast</strong></span></a> 76 </p> 77 </td> 78<td> 79 <p> 80 Socket option to permit sending of broadcast messages. 81 </p> 82 </td> 83</tr> 84<tr> 85<td> 86 <p> 87 <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> 88 </p> 89 </td> 90<td> 91 <p> 92 IO control command to get the amount of data that can be read without 93 blocking. 94 </p> 95 </td> 96</tr> 97<tr> 98<td> 99 <p> 100 <a class="link" href="basic_stream_socket/debug.html" title="basic_stream_socket::debug"><span class="bold"><strong>debug</strong></span></a> 101 </p> 102 </td> 103<td> 104 <p> 105 Socket option to enable socket-level debugging. 106 </p> 107 </td> 108</tr> 109<tr> 110<td> 111 <p> 112 <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> 113 </p> 114 </td> 115<td> 116 <p> 117 Socket option to prevent routing, use local interfaces only. 118 </p> 119 </td> 120</tr> 121<tr> 122<td> 123 <p> 124 <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> 125 </p> 126 </td> 127<td> 128 <p> 129 Socket option to report aborted connections on accept. 130 </p> 131 </td> 132</tr> 133<tr> 134<td> 135 <p> 136 <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> 137 </p> 138 </td> 139<td> 140 <p> 141 The endpoint type. 142 </p> 143 </td> 144</tr> 145<tr> 146<td> 147 <p> 148 <a class="link" href="basic_stream_socket/executor_type.html" title="basic_stream_socket::executor_type"><span class="bold"><strong>executor_type</strong></span></a> 149 </p> 150 </td> 151<td> 152 <p> 153 The type of the executor associated with the object. 154 </p> 155 </td> 156</tr> 157<tr> 158<td> 159 <p> 160 <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> 161 </p> 162 </td> 163<td> 164 <p> 165 Socket option to send keep-alives. 166 </p> 167 </td> 168</tr> 169<tr> 170<td> 171 <p> 172 <a class="link" href="basic_stream_socket/linger.html" title="basic_stream_socket::linger"><span class="bold"><strong>linger</strong></span></a> 173 </p> 174 </td> 175<td> 176 <p> 177 Socket option to specify whether the socket lingers on close if 178 unsent data is present. 179 </p> 180 </td> 181</tr> 182<tr> 183<td> 184 <p> 185 <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> 186 </p> 187 </td> 188<td> 189 <p> 190 A basic_socket is always the lowest layer. 191 </p> 192 </td> 193</tr> 194<tr> 195<td> 196 <p> 197 <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> 198 </p> 199 </td> 200<td> 201 <p> 202 Bitmask type for flags that can be passed to send and receive operations. 203 </p> 204 </td> 205</tr> 206<tr> 207<td> 208 <p> 209 <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> 210 </p> 211 </td> 212<td> 213 <p> 214 The native representation of a socket. 215 </p> 216 </td> 217</tr> 218<tr> 219<td> 220 <p> 221 <a class="link" href="basic_stream_socket/out_of_band_inline.html" title="basic_stream_socket::out_of_band_inline"><span class="bold"><strong>out_of_band_inline</strong></span></a> 222 </p> 223 </td> 224<td> 225 <p> 226 Socket option for putting received out-of-band data inline. 227 </p> 228 </td> 229</tr> 230<tr> 231<td> 232 <p> 233 <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> 234 </p> 235 </td> 236<td> 237 <p> 238 The protocol type. 239 </p> 240 </td> 241</tr> 242<tr> 243<td> 244 <p> 245 <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> 246 </p> 247 </td> 248<td> 249 <p> 250 Socket option for the receive buffer size of a socket. 251 </p> 252 </td> 253</tr> 254<tr> 255<td> 256 <p> 257 <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> 258 </p> 259 </td> 260<td> 261 <p> 262 Socket option for the receive low watermark. 263 </p> 264 </td> 265</tr> 266<tr> 267<td> 268 <p> 269 <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> 270 </p> 271 </td> 272<td> 273 <p> 274 Socket option to allow the socket to be bound to an address that 275 is already in use. 276 </p> 277 </td> 278</tr> 279<tr> 280<td> 281 <p> 282 <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> 283 </p> 284 </td> 285<td> 286 <p> 287 Socket option for the send buffer size of a socket. 288 </p> 289 </td> 290</tr> 291<tr> 292<td> 293 <p> 294 <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> 295 </p> 296 </td> 297<td> 298 <p> 299 Socket option for the send low watermark. 300 </p> 301 </td> 302</tr> 303<tr> 304<td> 305 <p> 306 <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> 307 </p> 308 </td> 309<td> 310 <p> 311 Different ways a socket may be shutdown. 312 </p> 313 </td> 314</tr> 315<tr> 316<td> 317 <p> 318 <a class="link" href="basic_stream_socket/wait_type.html" title="basic_stream_socket::wait_type"><span class="bold"><strong>wait_type</strong></span></a> 319 </p> 320 </td> 321<td> 322 <p> 323 Wait types. 324 </p> 325 </td> 326</tr> 327</tbody> 328</table></div> 329<h5> 330<a name="boost_asio.reference.basic_stream_socket.h1"></a> 331 <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 332 Functions</a> 333 </h5> 334<div class="informaltable"><table class="table"> 335<colgroup> 336<col> 337<col> 338</colgroup> 339<thead><tr> 340<th> 341 <p> 342 Name 343 </p> 344 </th> 345<th> 346 <p> 347 Description 348 </p> 349 </th> 350</tr></thead> 351<tbody> 352<tr> 353<td> 354 <p> 355 <a class="link" href="basic_stream_socket/assign.html" title="basic_stream_socket::assign"><span class="bold"><strong>assign</strong></span></a> 356 </p> 357 </td> 358<td> 359 <p> 360 Assign an existing native socket to the socket. 361 </p> 362 </td> 363</tr> 364<tr> 365<td> 366 <p> 367 <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> 368 </p> 369 </td> 370<td> 371 <p> 372 Start an asynchronous connect. 373 </p> 374 </td> 375</tr> 376<tr> 377<td> 378 <p> 379 <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> 380 </p> 381 </td> 382<td> 383 <p> 384 Start an asynchronous read. 385 </p> 386 </td> 387</tr> 388<tr> 389<td> 390 <p> 391 <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> 392 </p> 393 </td> 394<td> 395 <p> 396 Start an asynchronous receive. 397 </p> 398 </td> 399</tr> 400<tr> 401<td> 402 <p> 403 <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> 404 </p> 405 </td> 406<td> 407 <p> 408 Start an asynchronous send. 409 </p> 410 </td> 411</tr> 412<tr> 413<td> 414 <p> 415 <a class="link" href="basic_stream_socket/async_wait.html" title="basic_stream_socket::async_wait"><span class="bold"><strong>async_wait</strong></span></a> 416 </p> 417 </td> 418<td> 419 <p> 420 Asynchronously wait for the socket to become ready to read, ready 421 to write, or to have pending error conditions. 422 </p> 423 </td> 424</tr> 425<tr> 426<td> 427 <p> 428 <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> 429 </p> 430 </td> 431<td> 432 <p> 433 Start an asynchronous write. 434 </p> 435 </td> 436</tr> 437<tr> 438<td> 439 <p> 440 <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> 441 </p> 442 </td> 443<td> 444 <p> 445 Determine whether the socket is at the out-of-band data mark. 446 </p> 447 </td> 448</tr> 449<tr> 450<td> 451 <p> 452 <a class="link" href="basic_stream_socket/available.html" title="basic_stream_socket::available"><span class="bold"><strong>available</strong></span></a> 453 </p> 454 </td> 455<td> 456 <p> 457 Determine the number of bytes available for reading. 458 </p> 459 </td> 460</tr> 461<tr> 462<td> 463 <p> 464 <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> <span class="silver">[constructor]</span> 465 </p> 466 </td> 467<td> 468 <p> 469 Construct a basic_stream_socket without opening it. <br> <span class="silver"> —</span><br> 470 Construct and open a basic_stream_socket. <br> <span class="silver"> —</span><br> Construct 471 a basic_stream_socket, opening it and binding it to the given local 472 endpoint. <br> <span class="silver"> —</span><br> Construct a basic_stream_socket on an existing 473 native socket. <br> <span class="silver"> —</span><br> Move-construct a basic_stream_socket 474 from another. <br> <span class="silver"> —</span><br> Move-construct a basic_stream_socket 475 from a socket of another protocol 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_executor.html" title="basic_stream_socket::get_executor"><span class="bold"><strong>get_executor</strong></span></a> 531 </p> 532 </td> 533<td> 534 <p> 535 Get the executor 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. <br> <span class="silver"> —</span><br> Get a const 596 reference to the lowest layer. 597 </p> 598 </td> 599</tr> 600<tr> 601<td> 602 <p> 603 <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> 604 </p> 605 </td> 606<td> 607 <p> 608 Get the native socket representation. 609 </p> 610 </td> 611</tr> 612<tr> 613<td> 614 <p> 615 <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> 616 </p> 617 </td> 618<td> 619 <p> 620 Gets the non-blocking mode of the native socket implementation. 621 <br> <span class="silver"> —</span><br> Sets the non-blocking mode of the native socket implementation. 622 </p> 623 </td> 624</tr> 625<tr> 626<td> 627 <p> 628 <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> 629 </p> 630 </td> 631<td> 632 <p> 633 Gets the non-blocking mode of the socket. <br> <span class="silver"> —</span><br> Sets the 634 non-blocking mode of the socket. 635 </p> 636 </td> 637</tr> 638<tr> 639<td> 640 <p> 641 <a class="link" href="basic_stream_socket/open.html" title="basic_stream_socket::open"><span class="bold"><strong>open</strong></span></a> 642 </p> 643 </td> 644<td> 645 <p> 646 Open the socket using the specified protocol. 647 </p> 648 </td> 649</tr> 650<tr> 651<td> 652 <p> 653 <a class="link" href="basic_stream_socket/operator_eq_.html" title="basic_stream_socket::operator="><span class="bold"><strong>operator=</strong></span></a> 654 </p> 655 </td> 656<td> 657 <p> 658 Move-assign a basic_stream_socket from another. <br> <span class="silver"> —</span><br> Move-assign 659 a basic_stream_socket from a socket of another protocol type. 660 </p> 661 </td> 662</tr> 663<tr> 664<td> 665 <p> 666 <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> 667 </p> 668 </td> 669<td> 670 <p> 671 Read some data from the socket. 672 </p> 673 </td> 674</tr> 675<tr> 676<td> 677 <p> 678 <a class="link" href="basic_stream_socket/receive.html" title="basic_stream_socket::receive"><span class="bold"><strong>receive</strong></span></a> 679 </p> 680 </td> 681<td> 682 <p> 683 Receive some data on the socket. <br> <span class="silver"> —</span><br> Receive some data 684 on a connected socket. 685 </p> 686 </td> 687</tr> 688<tr> 689<td> 690 <p> 691 <a class="link" href="basic_stream_socket/release.html" title="basic_stream_socket::release"><span class="bold"><strong>release</strong></span></a> 692 </p> 693 </td> 694<td> 695 <p> 696 Release ownership of the underlying native socket. 697 </p> 698 </td> 699</tr> 700<tr> 701<td> 702 <p> 703 <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> 704 </p> 705 </td> 706<td> 707 <p> 708 Get the remote endpoint of the socket. 709 </p> 710 </td> 711</tr> 712<tr> 713<td> 714 <p> 715 <a class="link" href="basic_stream_socket/send.html" title="basic_stream_socket::send"><span class="bold"><strong>send</strong></span></a> 716 </p> 717 </td> 718<td> 719 <p> 720 Send some data on the socket. 721 </p> 722 </td> 723</tr> 724<tr> 725<td> 726 <p> 727 <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> 728 </p> 729 </td> 730<td> 731 <p> 732 Set an option on the socket. 733 </p> 734 </td> 735</tr> 736<tr> 737<td> 738 <p> 739 <a class="link" href="basic_stream_socket/shutdown.html" title="basic_stream_socket::shutdown"><span class="bold"><strong>shutdown</strong></span></a> 740 </p> 741 </td> 742<td> 743 <p> 744 Disable sends or receives on the socket. 745 </p> 746 </td> 747</tr> 748<tr> 749<td> 750 <p> 751 <a class="link" href="basic_stream_socket/wait.html" title="basic_stream_socket::wait"><span class="bold"><strong>wait</strong></span></a> 752 </p> 753 </td> 754<td> 755 <p> 756 Wait for the socket to become ready to read, ready to write, or 757 to have pending error conditions. 758 </p> 759 </td> 760</tr> 761<tr> 762<td> 763 <p> 764 <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> 765 </p> 766 </td> 767<td> 768 <p> 769 Write some data to the socket. 770 </p> 771 </td> 772</tr> 773<tr> 774<td> 775 <p> 776 <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> <span class="silver">[destructor]</span> 777 </p> 778 </td> 779<td> 780 <p> 781 Destroys the socket. 782 </p> 783 </td> 784</tr> 785</tbody> 786</table></div> 787<h5> 788<a name="boost_asio.reference.basic_stream_socket.h2"></a> 789 <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> 790 </h5> 791<div class="informaltable"><table class="table"> 792<colgroup> 793<col> 794<col> 795</colgroup> 796<thead><tr> 797<th> 798 <p> 799 Name 800 </p> 801 </th> 802<th> 803 <p> 804 Description 805 </p> 806 </th> 807</tr></thead> 808<tbody> 809<tr> 810<td> 811 <p> 812 <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> <span class="silver">[static]</span> 813 </p> 814 </td> 815<td> 816 <p> 817 (Deprecated: Use max_listen_connections.) The maximum length of 818 the queue of pending incoming connections. 819 </p> 820 </td> 821</tr> 822<tr> 823<td> 824 <p> 825 <a class="link" href="basic_stream_socket/max_listen_connections.html" title="basic_stream_socket::max_listen_connections"><span class="bold"><strong>max_listen_connections</strong></span></a> <span class="silver">[static]</span> 826 </p> 827 </td> 828<td> 829 <p> 830 The maximum length of the queue of pending incoming connections. 831 </p> 832 </td> 833</tr> 834<tr> 835<td> 836 <p> 837 <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> <span class="silver">[static]</span> 838 </p> 839 </td> 840<td> 841 <p> 842 Specify that the data should not be subject to routing. 843 </p> 844 </td> 845</tr> 846<tr> 847<td> 848 <p> 849 <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> <span class="silver">[static]</span> 850 </p> 851 </td> 852<td> 853 <p> 854 Specifies that the data marks the end of a record. 855 </p> 856 </td> 857</tr> 858<tr> 859<td> 860 <p> 861 <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> <span class="silver">[static]</span> 862 </p> 863 </td> 864<td> 865 <p> 866 Process out-of-band data. 867 </p> 868 </td> 869</tr> 870<tr> 871<td> 872 <p> 873 <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> <span class="silver">[static]</span> 874 </p> 875 </td> 876<td> 877 <p> 878 Peek at incoming data without removing it from the input queue. 879 </p> 880 </td> 881</tr> 882</tbody> 883</table></div> 884<p> 885 The <a class="link" href="basic_stream_socket.html" title="basic_stream_socket"><code class="computeroutput">basic_stream_socket</code></a> 886 class template provides asynchronous and blocking stream-oriented socket 887 functionality. 888 </p> 889<h5> 890<a name="boost_asio.reference.basic_stream_socket.h3"></a> 891 <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> 892 </h5> 893<p> 894 <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe. 895 </p> 896<p> 897 <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe. 898 </p> 899<h5> 900<a name="boost_asio.reference.basic_stream_socket.h4"></a> 901 <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> 902 </h5> 903<p> 904 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_stream_socket.hpp</code> 905 </p> 906<p> 907 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> 908 </p> 909</div> 910<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 911<td align="left"></td> 912<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 913 Kohlhoff<p> 914 Distributed under the Boost Software License, Version 1.0. (See accompanying 915 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>) 916 </p> 917</div></td> 918</tr></table> 919<hr> 920<div class="spirit-nav"> 921<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> 922</div> 923</body> 924</html> 925
