doc/html/boost_asio/reference/basic_socket_acceptor/async_accept/overload5.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_socket_acceptor::async_accept (5 of 8 overloads)</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="../async_accept.html" title="basic_socket_acceptor::async_accept">
   9 <link rel="prev" href="overload4.html" title="basic_socket_acceptor::async_accept (4 of 8 overloads)">
  10 <link rel="next" href="overload6.html" title="basic_socket_acceptor::async_accept (6 of 8 overloads)">
  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="overload4.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_accept.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="overload6.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="boost_asio.reference.basic_socket_acceptor.async_accept.overload5"></a><a class="link" href="overload5.html" title="basic_socket_acceptor::async_accept (5 of 8 overloads)">basic_socket_acceptor::async_accept
  28           (5 of 8 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Start an asynchronous accept.
  32           </p>
  33 <pre class="programlisting">template&lt;
  34     typename ExecutionContext,
  35     typename <a class="link" href="../../MoveAcceptHandler.html" title="Move accept handler requirements">MoveAcceptHandler</a> = <a class="link" href="../../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
  36 <a class="link" href="../../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_accept(
  37     ExecutionContext &amp; context,
  38     MoveAcceptHandler &amp;&amp; handler = <a class="link" href="../../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
  39     typename enable_if&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &gt;::type *  = 0);
  40 </pre>
  41 <p>
  42             This function is used to asynchronously accept a new connection. The
  43             function call always returns immediately.
  44           </p>
  45 <p>
  46             This overload requires that the Protocol template parameter satisfy the
  47             AcceptableProtocol type requirements.
  48           </p>
  49 <h6>
  50 <a name="boost_asio.reference.basic_socket_acceptor.async_accept.overload5.h0"></a>
  51             <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.async_accept.overload5.parameters"></a></span><a class="link" href="overload5.html#boost_asio.reference.basic_socket_acceptor.async_accept.overload5.parameters">Parameters</a>
  52           </h6>
  53 <div class="variablelist">
  54 <p class="title"><b></b></p>
  55 <dl class="variablelist">
  56 <dt><span class="term">context</span></dt>
  57 <dd><p>
  58                   The I/O execution context object to be used for the newly accepted
  59                   socket.
  60                 </p></dd>
  61 <dt><span class="term">handler</span></dt>
  62 <dd>
  63 <p>
  64                   The handler to be called when the accept operation completes. Copies
  65                   will be made of the handler as required. The function signature
  66                   of the handler must be:
  67 </p>
  68 <pre class="programlisting">void handler(
  69   const boost::system::error_code&amp; error, // Result of operation.
  70   typename Protocol::socket::template rebind_executor&lt;
  71     typename ExecutionContext::executor_type&gt;::other peer
  72       // On success, the newly accepted socket.
  73 );
  74 </pre>
  75 <p>
  76                   Regardless of whether the asynchronous operation completes immediately
  77                   or not, the handler will not be invoked from within this function.
  78                   On immediate completion, invocation of the handler will be performed
  79                   in a manner equivalent to using <a class="link" href="../../post.html" title="post"><code class="computeroutput">post</code></a>.
  80                 </p>
  81 </dd>
  82 </dl>
  83 </div>
  84 <h6>
  85 <a name="boost_asio.reference.basic_socket_acceptor.async_accept.overload5.h1"></a>
  86             <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.async_accept.overload5.example"></a></span><a class="link" href="overload5.html#boost_asio.reference.basic_socket_acceptor.async_accept.overload5.example">Example</a>
  87           </h6>
  88 <pre class="programlisting">void accept_handler(const boost::system::error_code&amp; error,
  89     boost::asio::ip::tcp::socket peer)
  90 {
  91   if (!error)
  92   {
  93     // Accept succeeded.
  94   }
  95 }
  96
  97 ...
  98
  99 boost::asio::ip::tcp::acceptor acceptor(my_context);
 100 ...
 101 acceptor.async_accept(my_context2, accept_handler);
 102 </pre>
 103 </div>
 104 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 105 <td align="left"></td>
 106 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
 107         Distributed under the Boost Software License, Version 1.0. (See accompanying
 108         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>)
 109       </p>
 110 </div></td>
 111 </tr></table>
 112 <hr>
 113 <div class="spirit-nav">
 114 <a accesskey="p" href="overload4.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_accept.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="overload6.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 115 </div>
 116 </body>
 117 </html>