1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_stream::async_connect (1 of 5 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="../../../../index.html" title="Chapter 1. Boost.Beast"> 8<link rel="up" href="../async_connect.html" title="basic_stream::async_connect"> 9<link rel="prev" href="../async_connect.html" title="basic_stream::async_connect"> 10<link rel="next" href="overload2.html" title="basic_stream::async_connect (2 of 5 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_connect.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_connect.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.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><h6 class="title"> 27<a name="beast.ref.boost__beast__basic_stream.async_connect.overload1"></a><a class="link" href="overload1.html" title="basic_stream::async_connect (1 of 5 overloads)">basic_stream::async_connect 28 (1 of 5 overloads)</a> 29</h6></div></div></div> 30<p> 31 Connect the stream to the specified endpoint asynchronously. 32 </p> 33<h7><a name="beast.ref.boost__beast__basic_stream.async_connect.overload1.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.async_connect.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__basic_stream.async_connect.overload1.synopsis">Synopsis</a> 35 </h7><pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 36 <span class="keyword">class</span> <a href="../../../../../../../../doc/html/boost_asio/reference/ConnectHandler.html" target="_top"><span class="emphasis"><em>ConnectHandler</em></span></a> <span class="special">=</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">default_completion_token_t</span><span class="special"><</span><a class="link" href="../executor_type.html" title="basic_stream::executor_type">executor_type</a><span class="special">>></span> 37<a href="../../../../../../../../doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type" target="_top"><span class="emphasis"><em>DEDUCED</em></span></a> 38<span class="identifier">async_connect</span><span class="special">(</span> 39 <span class="identifier">endpoint_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">ep</span><span class="special">,</span> 40 <span class="identifier">ConnectHandler</span><span class="special">&&</span> <span class="identifier">handler</span> <span class="special">=</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">default_completion_token_t</span><span class="special"><</span> <a class="link" href="../executor_type.html" title="basic_stream::executor_type">executor_type</a> <span class="special">>{});</span> 41</pre> 42<h7><a name="beast.ref.boost__beast__basic_stream.async_connect.overload1.h1"></a> 43 <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.async_connect.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__basic_stream.async_connect.overload1.description">Description</a> 44 </h7><p> 45 This function is used to asynchronously connect the underlying socket 46 to the specified remote endpoint. The function call always returns immediately. 47 The underlying socket is automatically opened if needed. An automatically 48 opened socket is not returned to the closed state upon failure. If the 49 timeout timer expires while the operation is outstanding, the operation 50 will be canceled and the completion handler will be invoked with the 51 error <a class="link" href="../../boost__beast__error.html" title="error"><code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">timeout</span></code></a>. 52 </p> 53<h7><a name="beast.ref.boost__beast__basic_stream.async_connect.overload1.h2"></a> 54 <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.async_connect.overload1.parameters"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__basic_stream.async_connect.overload1.parameters">Parameters</a> 55 </h7><div class="informaltable"><table class="table"> 56<colgroup> 57<col> 58<col> 59</colgroup> 60<thead><tr> 61<th> 62 <p> 63 Name 64 </p> 65 </th> 66<th> 67 <p> 68 Description 69 </p> 70 </th> 71</tr></thead> 72<tbody> 73<tr> 74<td> 75 <p> 76 <code class="computeroutput"><span class="identifier">ep</span></code> 77 </p> 78 </td> 79<td> 80 <p> 81 The remote endpoint to which the underlying socket will be 82 connected. Copies will be made of the endpoint object as required. 83 </p> 84 </td> 85</tr> 86<tr> 87<td> 88 <p> 89 <code class="computeroutput"><span class="identifier">handler</span></code> 90 </p> 91 </td> 92<td> 93 <p> 94 The completion handler to invoke when the operation completes. 95 The implementation takes ownership of the handler by performing 96 a decay-copy. The equivalent function signature of the handler 97 must be: 98 </p> 99<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span> 100 <span class="identifier">error_code</span> <span class="identifier">ec</span> <span class="comment">// Result of operation</span> 101<span class="special">);</span> 102</pre> 103 <p> 104 Regardless of whether the asynchronous operation completes 105 immediately or not, the handler will not be invoked from within 106 this function. Invocation of the handler will be performed 107 in a manner equivalent to using <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">post</span></code>. 108 </p> 109 </td> 110</tr> 111</tbody> 112</table></div> 113<h7><a name="beast.ref.boost__beast__basic_stream.async_connect.overload1.h3"></a> 114 <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.async_connect.overload1.see_also"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__basic_stream.async_connect.overload1.see_also">See 115 Also</a> 116 </h7><p> 117 <a class="link" href="overload1.html" title="basic_stream::async_connect (1 of 5 overloads)"><code class="computeroutput"><span class="identifier">async_connect</span></code></a> 118 </p> 119</div> 120<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 121<td align="left"></td> 122<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 123 Falco<p> 124 Distributed under the Boost Software License, Version 1.0. (See accompanying 125 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>) 126 </p> 127</div></td> 128</tr></table> 129<hr> 130<div class="spirit-nav"> 131<a accesskey="p" href="../async_connect.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_connect.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.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> 132</div> 133</body> 134</html> 135
