doc/html/boost_asio/reference/basic_socket_streambuf/enable_connection_aborted.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_socket_streambuf::enable_connection_aborted</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="../basic_socket_streambuf.html" title="basic_socket_streambuf">
   9 <link rel="prev" href="duration_type.html" title="basic_socket_streambuf::duration_type">
  10 <link rel="next" href="endpoint_type.html" title="basic_socket_streambuf::endpoint_type">
  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="duration_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket_streambuf.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="endpoint_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="boost_asio.reference.basic_socket_streambuf.enable_connection_aborted"></a><a class="link" href="enable_connection_aborted.html" title="basic_socket_streambuf::enable_connection_aborted">basic_socket_streambuf::enable_connection_aborted</a>
  28 </h4></div></div></div>
  29 <p>
  30           <span class="emphasis"><em>Inherited from socket_base.</em></span>
  31         </p>
  32 <p>
  33           <a class="indexterm" name="idp148340976"></a>
  34 Socket option to report
  35           aborted connections on accept.
  36         </p>
  37 <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">enable_connection_aborted</span><span class="special">;</span>
  38 </pre>
  39 <p>
  40           Implements a custom socket option that determines whether or not an accept
  41           operation is permitted to fail with <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">connection_aborted</span></code>.
  42           By default the option is false.
  43         </p>
  44 <h6>
  45 <a name="boost_asio.reference.basic_socket_streambuf.enable_connection_aborted.h0"></a>
  46           <span class="phrase"><a name="boost_asio.reference.basic_socket_streambuf.enable_connection_aborted.examples"></a></span><a class="link" href="enable_connection_aborted.html#boost_asio.reference.basic_socket_streambuf.enable_connection_aborted.examples">Examples</a>
  47         </h6>
  48 <p>
  49           Setting the option:
  50         </p>
  51 <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">acceptor</span> <span class="identifier">acceptor</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span>
  52 <span class="special">...</span>
  53 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">socket_base</span><span class="special">::</span><span class="identifier">enable_connection_aborted</span> <span class="identifier">option</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span>
  54 <span class="identifier">acceptor</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span>
  55 </pre>
  56 <p>
  57           Getting the current option value:
  58         </p>
  59 <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">acceptor</span> <span class="identifier">acceptor</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span>
  60 <span class="special">...</span>
  61 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">socket_base</span><span class="special">::</span><span class="identifier">enable_connection_aborted</span> <span class="identifier">option</span><span class="special">;</span>
  62 <span class="identifier">acceptor</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span>
  63 <span class="keyword">bool</span> <span class="identifier">is_set</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">value</span><span class="special">();</span>
  64 </pre>
  65 <h6>
  66 <a name="boost_asio.reference.basic_socket_streambuf.enable_connection_aborted.h1"></a>
  67           <span class="phrase"><a name="boost_asio.reference.basic_socket_streambuf.enable_connection_aborted.requirements"></a></span><a class="link" href="enable_connection_aborted.html#boost_asio.reference.basic_socket_streambuf.enable_connection_aborted.requirements">Requirements</a>
  68         </h6>
  69 <p>
  70           <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_socket_streambuf.hpp</code>
  71         </p>
  72 <p>
  73           <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
  74         </p>
  75 </div>
  76 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  77 <td align="left"></td>
  78 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  79         Distributed under the Boost Software License, Version 1.0. (See accompanying
  80         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>)
  81       </p>
  82 </div></td>
  83 </tr></table>
  84 <hr>
  85 <div class="spirit-nav">
  86 <a accesskey="p" href="duration_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket_streambuf.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="endpoint_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  87 </div>
  88 </body>
  89 </html>