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

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