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


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>basic_socket_acceptor::async_accept (1 of 8 overloads)</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../async_accept.html" title="basic_socket_acceptor::async_accept">
<link rel="prev" href="../async_accept.html" title="basic_socket_acceptor::async_accept">
<link rel="next" href="overload2.html" title="basic_socket_acceptor::async_accept (2 of 8 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<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
          (1 of 8 overloads)</a>
</h5></div></div></div>
<p>
            Start an asynchronous accept.
          </p>
<pre class="programlisting">template&lt;
    typename <a class="link" href="../../Protocol.html" title="Protocol requirements">Protocol1</a>,
    typename <a class="link" href="../../Executor1.html" title="Executor requirements">Executor1</a>,
    typename <a class="link" href="../../AcceptHandler.html" title="Accept handler requirements">AcceptHandler</a>&gt;
<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(
    basic_socket&lt; Protocol1, Executor1 &gt; &amp; peer,
    AcceptHandler &amp;&amp; handler,
    typename enable_if&lt; is_convertible&lt; Protocol, Protocol1 &gt;::value &gt;::type *  = 0);
</pre>
<p>
            This function is used to asynchronously accept a new connection into
            a socket. The function call always returns immediately.
          </p>
<h6>
<a name="boost_asio.reference.basic_socket_acceptor.async_accept.overload1.h0"></a>
            <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>
          </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">peer</span></dt>
<dd><p>
                  The socket into which the new connection will be accepted. Ownership
                  of the peer object is retained by the caller, which must guarantee
                  that it is valid until the handler is called.
                </p></dd>
<dt><span class="term">handler</span></dt>
<dd>
<p>
                  The handler to be called when the accept operation completes. Copies
                  will be made of the handler as required. The function signature
                  of the handler must be:
</p>
<pre class="programlisting">void handler(
  const boost::system::error_code&amp; error // Result of operation.
);
</pre>
<p>
                  Regardless of whether the asynchronous operation completes immediately
                  or not, the handler will not be invoked from within this function.
                  On immediate completion, invocation of the handler will be performed
                  in a manner equivalent to using <a class="link" href="../../post.html" title="post"><code class="computeroutput">post</code></a>.
                </p>
</dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.basic_socket_acceptor.async_accept.overload1.h1"></a>
            <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>
          </h6>
<pre class="programlisting">void accept_handler(const boost::system::error_code&amp; error)
{
  if (!error)
  {
    // Accept succeeded.
  }
}

...

boost::asio::ip::tcp::acceptor acceptor(my_context);
...
boost::asio::ip::tcp::socket socket(my_context);
acceptor.async_accept(socket, accept_handler);
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
</body>
</html>