PageRenderTime 129ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/doc/asio/reference/basic_socket/enable_connection_aborted.html

http://github.com/barrbrain/asio
HTML | 82 lines | 82 code | 0 blank | 0 comment | 0 complexity | ef36d375522e327fc0b3e122ec87f803 MD5 | raw file
    

  1. <html>
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
    4. 

  4. <title>basic_socket::enable_connection_aborted</title>
    5. 

  5. <link rel="stylesheet" href="../../../boostbook.css" type="text/css">
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
    7. 

  7. <link rel="start" href="../../../index.html" title="Asio">
    8. 

  8. <link rel="up" href="../basic_socket.html" title="basic_socket">
    9. 

  9. <link rel="prev" href="do_not_route.html" title="basic_socket::do_not_route">
    10. 

  10. <link rel="next" href="endpoint_type.html" title="basic_socket::endpoint_type">
    11. 

  11. </head>
    12. 

  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    13. 

  13. <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
    14. 

  14. <hr>
    15. 

  15. <div class="spirit-nav">
    16. 

  16. <a accesskey="p" href="do_not_route.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="endpoint_type.html"><img src="../../../next.png" alt="Next"></a>
    17. 

  17. </div>
    18. 

  18. <div class="section" lang="en">
    19. 

  19. <div class="titlepage"><div><div><h4 class="title">
    20. 

  20. <a name="asio.reference.basic_socket.enable_connection_aborted"></a><a class="link" href="enable_connection_aborted.html" title="basic_socket::enable_connection_aborted">basic_socket::enable_connection_aborted</a>
    21. 

  21. </h4></div></div></div>
    22. 

  22. <p>
    23. 

  23.           <span class="emphasis"><em>Inherited from socket_base.</em></span>
    24. 

  24.         </p>
    25. 

  25. <p>
    26. 

  26.           <a class="indexterm" name="id913336"></a> 
    27. 

  27. Socket option to report aborted connections
    28. 

  28.           on accept.
    29. 

  29.         </p>
    30. 

  30. <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>
    31. 

  31. </pre>
    32. 

  32. <p>
    33. 

  33.           Implements a custom socket option that determines whether or not an accept
    34. 

  34.           operation is permitted to fail with <code class="computeroutput"><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>.
    35. 

  35.           By default the option is false.
    36. 

  36.         </p>
    37. 

  37. <a name="asio.reference.basic_socket.enable_connection_aborted.examples"></a><h6>
    38. 

  38. <a name="id913415"></a>
    39. 

  39.           <a class="link" href="enable_connection_aborted.html#asio.reference.basic_socket.enable_connection_aborted.examples">Examples</a>
    40. 

  40.         </h6>
    41. 

  41. <p>
    42. 

  42.           Setting the option:
    43. 

  43.         </p>
    44. 

  44. <pre class="programlisting"><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> 
    45. 

  45. <span class="special">...</span>
    46. 

  46. <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>
    47. 

  47. <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>
    48. 

  48. </pre>
    49. 

  49. <p>
    50. 

  50.           Getting the current option value:
    51. 

  51.         </p>
    52. 

  52. <pre class="programlisting"><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> 
    53. 

  53. <span class="special">...</span>
    54. 

  54. <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>
    55. 

  55. <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>
    56. 

  56. <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>
    57. 

  57. </pre>
    58. 

  58. <a name="asio.reference.basic_socket.enable_connection_aborted.requirements"></a><h6>
    59. 

  59. <a name="id913737"></a>
    60. 

  60.           <a class="link" href="enable_connection_aborted.html#asio.reference.basic_socket.enable_connection_aborted.requirements">Requirements</a>
    61. 

  61.         </h6>
    62. 

  62. <p>
    63. 

  63.           <span class="bold"><strong>Header: </strong></span><code class="literal">asio/basic_socket.hpp</code>
    64. 

  64.         </p>
    65. 

  65. <p>
    66. 

  66.           <span class="bold"><strong>Convenience header: </strong></span><code class="literal">asio.hpp</code>
    67. 

  67.         </p>
    68. 

  68. </div>
    69. 

  69. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    70. 

  70. <td align="left"></td>
    71. 

  71. <td align="right"><div class="copyright-footer">Copyright &#169; 2003 - 2010 Christopher M. Kohlhoff<p>
    72. 

  72.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    73. 

  73.         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>)
    74. 

  74.       </p>
    75. 

  75. </div></td>
    76. 

  76. </tr></table>
    77. 

  77. <hr>
    78. 

  78. <div class="spirit-nav">
    79. 

  79. <a accesskey="p" href="do_not_route.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="endpoint_type.html"><img src="../../../next.png" alt="Next"></a>
    80. 

  80. </div>
    81. 

  81. </body>
    82. 

  82. </html>
    83. 

  83.