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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_socket_acceptor::async_accept (2 of 2 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="overload1.html" title="basic_socket_acceptor::async_accept (1 of 2 overloads)">
  10 <link rel="next" href="../basic_socket_acceptor.html" title="basic_socket_acceptor::basic_socket_acceptor">
  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="overload1.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="../basic_socket_acceptor.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.overload2"></a><a class="link" href="overload2.html" title="basic_socket_acceptor::async_accept (2 of 2 overloads)">basic_socket_acceptor::async_accept
  28           (2 of 2 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Start an asynchronous accept.
  32           </p>
  33 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  34     <span class="keyword">typename</span> <a class="link" href="../../SocketService.html" title="Socket service requirements">SocketService</a><span class="special">,</span>
  35     <span class="keyword">typename</span> <a class="link" href="../../AcceptHandler.html" title="Accept handler requirements">AcceptHandler</a><span class="special">&gt;</span>
  36 <a class="link" href="../../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function"><span class="emphasis"><em>void-or-deduced</em></span></a> <span class="identifier">async_accept</span><span class="special">(</span>
  37     <span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">protocol_type</span><span class="special">,</span> <span class="identifier">SocketService</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">peer</span><span class="special">,</span>
  38     <span class="identifier">endpoint_type</span> <span class="special">&amp;</span> <span class="identifier">peer_endpoint</span><span class="special">,</span>
  39     <span class="identifier">AcceptHandler</span> <span class="identifier">handler</span><span class="special">);</span>
  40 </pre>
  41 <p>
  42             This function is used to asynchronously accept a new connection into
  43             a socket, and additionally obtain the endpoint of the remote peer. The
  44             function call always returns immediately.
  45           </p>
  46 <h6>
  47 <a name="boost_asio.reference.basic_socket_acceptor.async_accept.overload2.h0"></a>
  48             <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.async_accept.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket_acceptor.async_accept.overload2.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">peer_endpoint</span></dt>
  60 <dd><p>
  61                   An endpoint object into which the endpoint of the remote peer will
  62                   be written. Ownership of the peer_endpoint object is retained by
  63                   the caller, which must guarantee that it is valid until the handler
  64                   is called.
  65                 </p></dd>
  66 <dt><span class="term">handler</span></dt>
  67 <dd>
  68 <p>
  69                   The handler to be called when the accept operation completes. Copies
  70                   will be made of the handler as required. The function signature
  71                   of the handler must be:
  72 </p>
  73 <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
  74   <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">error</span> <span class="comment">// Result of operation.</span>
  75 <span class="special">);</span>
  76 </pre>
  77 <p>
  78                   Regardless of whether the asynchronous operation completes immediately
  79                   or not, the handler will not be invoked from within this function.
  80                   Invocation of the handler will be performed in a manner equivalent
  81                   to using <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">post</span><span class="special">()</span></code>.
  82                 </p>
  83 </dd>
  84 </dl>
  85 </div>
  86 </div>
  87 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  88 <td align="left"></td>
  89 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
  90         Distributed under the Boost Software License, Version 1.0. (See accompanying
  91         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>)
  92       </p>
  93 </div></td>
  94 </tr></table>
  95 <hr>
  96 <div class="spirit-nav">
  97 <a accesskey="p" href="overload1.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="../basic_socket_acceptor.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  98 </div>
  99 </body>
 100 </html>