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

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