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

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