doc/html/boost_asio/reference/socket_base.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>socket_base</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="socket_acceptor_service/socket_acceptor_service.html" title="socket_acceptor_service::socket_acceptor_service">
  10 <link rel="next" href="socket_base/broadcast.html" title="socket_base::broadcast">
  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="socket_acceptor_service/socket_acceptor_service.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="socket_base/broadcast.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.socket_base"></a><a class="link" href="socket_base.html" title="socket_base">socket_base</a>
  28 </h3></div></div></div>
  29 <p>
  30         The <a class="link" href="socket_base.html" title="socket_base"><code class="computeroutput"><span class="identifier">socket_base</span></code></a>
  31         class is used as a base for 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> and <a class="link" href="basic_datagram_socket.html" title="basic_datagram_socket"><code class="computeroutput"><span class="identifier">basic_datagram_socket</span></code></a> class templates
  32         so that we have a common place to define the shutdown_type and enum.
  33       </p>
  34 <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">socket_base</span>
  35 </pre>
  36 <h5>
  37 <a name="boost_asio.reference.socket_base.h0"></a>
  38         <span class="phrase"><a name="boost_asio.reference.socket_base.types"></a></span><a class="link" href="socket_base.html#boost_asio.reference.socket_base.types">Types</a>
  39       </h5>
  40 <div class="informaltable"><table class="table">
  41 <colgroup>
  42 <col>
  43 <col>
  44 </colgroup>
  45 <thead><tr>
  46 <th>
  47                 <p>
  48                   Name
  49                 </p>
  50               </th>
  51 <th>
  52                 <p>
  53                   Description
  54                 </p>
  55               </th>
  56 </tr></thead>
  57 <tbody>
  58 <tr>
  59 <td>
  60                 <p>
  61                   <a class="link" href="socket_base/broadcast.html" title="socket_base::broadcast"><span class="bold"><strong>broadcast</strong></span></a>
  62                 </p>
  63               </td>
  64 <td>
  65                 <p>
  66                   Socket option to permit sending of broadcast messages.
  67                 </p>
  68               </td>
  69 </tr>
  70 <tr>
  71 <td>
  72                 <p>
  73                   <a class="link" href="socket_base/bytes_readable.html" title="socket_base::bytes_readable"><span class="bold"><strong>bytes_readable</strong></span></a>
  74                 </p>
  75               </td>
  76 <td>
  77                 <p>
  78                   IO control command to get the amount of data that can be read without
  79                   blocking.
  80                 </p>
  81               </td>
  82 </tr>
  83 <tr>
  84 <td>
  85                 <p>
  86                   <a class="link" href="socket_base/debug.html" title="socket_base::debug"><span class="bold"><strong>debug</strong></span></a>
  87                 </p>
  88               </td>
  89 <td>
  90                 <p>
  91                   Socket option to enable socket-level debugging.
  92                 </p>
  93               </td>
  94 </tr>
  95 <tr>
  96 <td>
  97                 <p>
  98                   <a class="link" href="socket_base/do_not_route.html" title="socket_base::do_not_route"><span class="bold"><strong>do_not_route</strong></span></a>
  99                 </p>
 100               </td>
 101 <td>
 102                 <p>
 103                   Socket option to prevent routing, use local interfaces only.
 104                 </p>
 105               </td>
 106 </tr>
 107 <tr>
 108 <td>
 109                 <p>
 110                   <a class="link" href="socket_base/enable_connection_aborted.html" title="socket_base::enable_connection_aborted"><span class="bold"><strong>enable_connection_aborted</strong></span></a>
 111                 </p>
 112               </td>
 113 <td>
 114                 <p>
 115                   Socket option to report aborted connections on accept.
 116                 </p>
 117               </td>
 118 </tr>
 119 <tr>
 120 <td>
 121                 <p>
 122                   <a class="link" href="socket_base/keep_alive.html" title="socket_base::keep_alive"><span class="bold"><strong>keep_alive</strong></span></a>
 123                 </p>
 124               </td>
 125 <td>
 126                 <p>
 127                   Socket option to send keep-alives.
 128                 </p>
 129               </td>
 130 </tr>
 131 <tr>
 132 <td>
 133                 <p>
 134                   <a class="link" href="socket_base/linger.html" title="socket_base::linger"><span class="bold"><strong>linger</strong></span></a>
 135                 </p>
 136               </td>
 137 <td>
 138                 <p>
 139                   Socket option to specify whether the socket lingers on close if
 140                   unsent data is present.
 141                 </p>
 142               </td>
 143 </tr>
 144 <tr>
 145 <td>
 146                 <p>
 147                   <a class="link" href="socket_base/message_flags.html" title="socket_base::message_flags"><span class="bold"><strong>message_flags</strong></span></a>
 148                 </p>
 149               </td>
 150 <td>
 151                 <p>
 152                   Bitmask type for flags that can be passed to send and receive operations.
 153                 </p>
 154               </td>
 155 </tr>
 156 <tr>
 157 <td>
 158                 <p>
 159                   <a class="link" href="socket_base/non_blocking_io.html" title="socket_base::non_blocking_io"><span class="bold"><strong>non_blocking_io</strong></span></a>
 160                 </p>
 161               </td>
 162 <td>
 163                 <p>
 164                   (Deprecated: Use non_blocking().) IO control command to set the
 165                   blocking mode of the socket.
 166                 </p>
 167               </td>
 168 </tr>
 169 <tr>
 170 <td>
 171                 <p>
 172                   <a class="link" href="socket_base/receive_buffer_size.html" title="socket_base::receive_buffer_size"><span class="bold"><strong>receive_buffer_size</strong></span></a>
 173                 </p>
 174               </td>
 175 <td>
 176                 <p>
 177                   Socket option for the receive buffer size of a socket.
 178                 </p>
 179               </td>
 180 </tr>
 181 <tr>
 182 <td>
 183                 <p>
 184                   <a class="link" href="socket_base/receive_low_watermark.html" title="socket_base::receive_low_watermark"><span class="bold"><strong>receive_low_watermark</strong></span></a>
 185                 </p>
 186               </td>
 187 <td>
 188                 <p>
 189                   Socket option for the receive low watermark.
 190                 </p>
 191               </td>
 192 </tr>
 193 <tr>
 194 <td>
 195                 <p>
 196                   <a class="link" href="socket_base/reuse_address.html" title="socket_base::reuse_address"><span class="bold"><strong>reuse_address</strong></span></a>
 197                 </p>
 198               </td>
 199 <td>
 200                 <p>
 201                   Socket option to allow the socket to be bound to an address that
 202                   is already in use.
 203                 </p>
 204               </td>
 205 </tr>
 206 <tr>
 207 <td>
 208                 <p>
 209                   <a class="link" href="socket_base/send_buffer_size.html" title="socket_base::send_buffer_size"><span class="bold"><strong>send_buffer_size</strong></span></a>
 210                 </p>
 211               </td>
 212 <td>
 213                 <p>
 214                   Socket option for the send buffer size of a socket.
 215                 </p>
 216               </td>
 217 </tr>
 218 <tr>
 219 <td>
 220                 <p>
 221                   <a class="link" href="socket_base/send_low_watermark.html" title="socket_base::send_low_watermark"><span class="bold"><strong>send_low_watermark</strong></span></a>
 222                 </p>
 223               </td>
 224 <td>
 225                 <p>
 226                   Socket option for the send low watermark.
 227                 </p>
 228               </td>
 229 </tr>
 230 <tr>
 231 <td>
 232                 <p>
 233                   <a class="link" href="socket_base/shutdown_type.html" title="socket_base::shutdown_type"><span class="bold"><strong>shutdown_type</strong></span></a>
 234                 </p>
 235               </td>
 236 <td>
 237                 <p>
 238                   Different ways a socket may be shutdown.
 239                 </p>
 240               </td>
 241 </tr>
 242 </tbody>
 243 </table></div>
 244 <h5>
 245 <a name="boost_asio.reference.socket_base.h1"></a>
 246         <span class="phrase"><a name="boost_asio.reference.socket_base.protected_member_functions"></a></span><a class="link" href="socket_base.html#boost_asio.reference.socket_base.protected_member_functions">Protected
 247         Member Functions</a>
 248       </h5>
 249 <div class="informaltable"><table class="table">
 250 <colgroup>
 251 <col>
 252 <col>
 253 </colgroup>
 254 <thead><tr>
 255 <th>
 256                 <p>
 257                   Name
 258                 </p>
 259               </th>
 260 <th>
 261                 <p>
 262                   Description
 263                 </p>
 264               </th>
 265 </tr></thead>
 266 <tbody><tr>
 267 <td>
 268                 <p>
 269                   <a class="link" href="socket_base/_socket_base.html" title="socket_base::~socket_base"><span class="bold"><strong>~socket_base</strong></span></a>
 270                 </p>
 271               </td>
 272 <td>
 273                 <p>
 274                   Protected destructor to prevent deletion through this type.
 275                 </p>
 276               </td>
 277 </tr></tbody>
 278 </table></div>
 279 <h5>
 280 <a name="boost_asio.reference.socket_base.h2"></a>
 281         <span class="phrase"><a name="boost_asio.reference.socket_base.data_members"></a></span><a class="link" href="socket_base.html#boost_asio.reference.socket_base.data_members">Data
 282         Members</a>
 283       </h5>
 284 <div class="informaltable"><table class="table">
 285 <colgroup>
 286 <col>
 287 <col>
 288 </colgroup>
 289 <thead><tr>
 290 <th>
 291                 <p>
 292                   Name
 293                 </p>
 294               </th>
 295 <th>
 296                 <p>
 297                   Description
 298                 </p>
 299               </th>
 300 </tr></thead>
 301 <tbody>
 302 <tr>
 303 <td>
 304                 <p>
 305                   <a class="link" href="socket_base/max_connections.html" title="socket_base::max_connections"><span class="bold"><strong>max_connections</strong></span></a>
 306                 </p>
 307               </td>
 308 <td>
 309                 <p>
 310                   The maximum length of the queue of pending incoming connections.
 311                 </p>
 312               </td>
 313 </tr>
 314 <tr>
 315 <td>
 316                 <p>
 317                   <a class="link" href="socket_base/message_do_not_route.html" title="socket_base::message_do_not_route"><span class="bold"><strong>message_do_not_route</strong></span></a>
 318                 </p>
 319               </td>
 320 <td>
 321                 <p>
 322                   Specify that the data should not be subject to routing.
 323                 </p>
 324               </td>
 325 </tr>
 326 <tr>
 327 <td>
 328                 <p>
 329                   <a class="link" href="socket_base/message_end_of_record.html" title="socket_base::message_end_of_record"><span class="bold"><strong>message_end_of_record</strong></span></a>
 330                 </p>
 331               </td>
 332 <td>
 333                 <p>
 334                   Specifies that the data marks the end of a record.
 335                 </p>
 336               </td>
 337 </tr>
 338 <tr>
 339 <td>
 340                 <p>
 341                   <a class="link" href="socket_base/message_out_of_band.html" title="socket_base::message_out_of_band"><span class="bold"><strong>message_out_of_band</strong></span></a>
 342                 </p>
 343               </td>
 344 <td>
 345                 <p>
 346                   Process out-of-band data.
 347                 </p>
 348               </td>
 349 </tr>
 350 <tr>
 351 <td>
 352                 <p>
 353                   <a class="link" href="socket_base/message_peek.html" title="socket_base::message_peek"><span class="bold"><strong>message_peek</strong></span></a>
 354                 </p>
 355               </td>
 356 <td>
 357                 <p>
 358                   Peek at incoming data without removing it from the input queue.
 359                 </p>
 360               </td>
 361 </tr>
 362 </tbody>
 363 </table></div>
 364 <h5>
 365 <a name="boost_asio.reference.socket_base.h3"></a>
 366         <span class="phrase"><a name="boost_asio.reference.socket_base.requirements"></a></span><a class="link" href="socket_base.html#boost_asio.reference.socket_base.requirements">Requirements</a>
 367       </h5>
 368 <p>
 369         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/socket_base.hpp</code>
 370       </p>
 371 <p>
 372         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 373       </p>
 374 </div>
 375 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 376 <td align="left"></td>
 377 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
 378         Distributed under the Boost Software License, Version 1.0. (See accompanying
 379         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>)
 380       </p>
 381 </div></td>
 382 </tr></table>
 383 <hr>
 384 <div class="spirit-nav">
 385 <a accesskey="p" href="socket_acceptor_service/socket_acceptor_service.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="socket_base/broadcast.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 386 </div>
 387 </body>
 388 </html>