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