doc/html/boost_asio/reference/async_connect.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>async_connect</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="../reference.html" title="Reference">
   9 <link rel="prev" href="async_compose.html" title="async_compose">
  10 <link rel="next" href="async_connect/overload1.html" title="async_connect (1 of 6 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_compose.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="async_connect/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_asio.reference.async_connect"></a><a class="link" href="async_connect.html" title="async_connect">async_connect</a>
  28 </h3></div></div></div>
  29 <p>
  30         <a class="indexterm" name="boost_asio.indexterm.async_connect"></a>
  31 The <code class="computeroutput">async_connect</code>
  32         function is a composed asynchronous operation that establishes a socket connection
  33         by trying each endpoint in a sequence.
  34       </p>
  35 <p>
  36         Asynchronously establishes a socket connection by trying each endpoint in
  37         a sequence.
  38       </p>
  39 <pre class="programlisting">template&lt;
  40     typename <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a>,
  41     typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>,
  42     typename <a class="link" href="EndpointSequence.html" title="Endpoint sequence requirements">EndpointSequence</a>,
  43     typename <a class="link" href="RangeConnectHandler.html" title="Range connect handler requirements">RangeConnectHandler</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;
  44 <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> <a class="link" href="async_connect/overload1.html" title="async_connect (1 of 6 overloads)">async_connect</a>(
  45     basic_socket&lt; Protocol, Executor &gt; &amp; s,
  46     const EndpointSequence &amp; endpoints,
  47     RangeConnectHandler &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>,
  48     typename enable_if&lt; is_endpoint_sequence&lt; EndpointSequence &gt;::value &gt;::type *  = 0);
  49   <span class="emphasis"><em>&#187; <a class="link" href="async_connect/overload1.html" title="async_connect (1 of 6 overloads)">more...</a></em></span>
  50 </pre>
  51 <p>
  52         (Deprecated: Use range overload.) Asynchronously establishes a socket connection
  53         by trying each endpoint in a sequence.
  54       </p>
  55 <pre class="programlisting">template&lt;
  56     typename <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a>,
  57     typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>,
  58     typename Iterator,
  59     typename <a class="link" href="IteratorConnectHandler.html" title="Iterator connect handler requirements">IteratorConnectHandler</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;
  60 <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> <a class="link" href="async_connect/overload2.html" title="async_connect (2 of 6 overloads)">async_connect</a>(
  61     basic_socket&lt; Protocol, Executor &gt; &amp; s,
  62     Iterator begin,
  63     IteratorConnectHandler &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>,
  64     typename enable_if&lt;!is_endpoint_sequence&lt; Iterator &gt;::value &gt;::type *  = 0);
  65   <span class="emphasis"><em>&#187; <a class="link" href="async_connect/overload2.html" title="async_connect (2 of 6 overloads)">more...</a></em></span>
  66 </pre>
  67 <p>
  68         Asynchronously establishes a socket connection by trying each endpoint in
  69         a sequence.
  70       </p>
  71 <pre class="programlisting">template&lt;
  72     typename <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a>,
  73     typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>,
  74     typename Iterator,
  75     typename <a class="link" href="IteratorConnectHandler.html" title="Iterator connect handler requirements">IteratorConnectHandler</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;
  76 <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> <a class="link" href="async_connect/overload3.html" title="async_connect (3 of 6 overloads)">async_connect</a>(
  77     basic_socket&lt; Protocol, Executor &gt; &amp; s,
  78     Iterator begin,
  79     Iterator end,
  80     IteratorConnectHandler &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>);
  81   <span class="emphasis"><em>&#187; <a class="link" href="async_connect/overload3.html" title="async_connect (3 of 6 overloads)">more...</a></em></span>
  82
  83 template&lt;
  84     typename <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a>,
  85     typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>,
  86     typename <a class="link" href="EndpointSequence.html" title="Endpoint sequence requirements">EndpointSequence</a>,
  87     typename <a class="link" href="ConnectCondition.html" title="Connect condition requirements">ConnectCondition</a>,
  88     typename <a class="link" href="RangeConnectHandler.html" title="Range connect handler requirements">RangeConnectHandler</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;
  89 <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> <a class="link" href="async_connect/overload4.html" title="async_connect (4 of 6 overloads)">async_connect</a>(
  90     basic_socket&lt; Protocol, Executor &gt; &amp; s,
  91     const EndpointSequence &amp; endpoints,
  92     ConnectCondition connect_condition,
  93     RangeConnectHandler &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>,
  94     typename enable_if&lt; is_endpoint_sequence&lt; EndpointSequence &gt;::value &gt;::type *  = 0);
  95   <span class="emphasis"><em>&#187; <a class="link" href="async_connect/overload4.html" title="async_connect (4 of 6 overloads)">more...</a></em></span>
  96 </pre>
  97 <p>
  98         (Deprecated: Use range overload.) Asynchronously establishes a socket connection
  99         by trying each endpoint in a sequence.
 100       </p>
 101 <pre class="programlisting">template&lt;
 102     typename <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a>,
 103     typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>,
 104     typename Iterator,
 105     typename <a class="link" href="ConnectCondition.html" title="Connect condition requirements">ConnectCondition</a>,
 106     typename <a class="link" href="IteratorConnectHandler.html" title="Iterator connect handler requirements">IteratorConnectHandler</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;
 107 <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> <a class="link" href="async_connect/overload5.html" title="async_connect (5 of 6 overloads)">async_connect</a>(
 108     basic_socket&lt; Protocol, Executor &gt; &amp; s,
 109     Iterator begin,
 110     ConnectCondition connect_condition,
 111     IteratorConnectHandler &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>,
 112     typename enable_if&lt;!is_endpoint_sequence&lt; Iterator &gt;::value &gt;::type *  = 0);
 113   <span class="emphasis"><em>&#187; <a class="link" href="async_connect/overload5.html" title="async_connect (5 of 6 overloads)">more...</a></em></span>
 114 </pre>
 115 <p>
 116         Asynchronously establishes a socket connection by trying each endpoint in
 117         a sequence.
 118       </p>
 119 <pre class="programlisting">template&lt;
 120     typename <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a>,
 121     typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>,
 122     typename Iterator,
 123     typename <a class="link" href="ConnectCondition.html" title="Connect condition requirements">ConnectCondition</a>,
 124     typename <a class="link" href="IteratorConnectHandler.html" title="Iterator connect handler requirements">IteratorConnectHandler</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;
 125 <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> <a class="link" href="async_connect/overload6.html" title="async_connect (6 of 6 overloads)">async_connect</a>(
 126     basic_socket&lt; Protocol, Executor &gt; &amp; s,
 127     Iterator begin,
 128     Iterator end,
 129     ConnectCondition connect_condition,
 130     IteratorConnectHandler &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>);
 131   <span class="emphasis"><em>&#187; <a class="link" href="async_connect/overload6.html" title="async_connect (6 of 6 overloads)">more...</a></em></span>
 132 </pre>
 133 <h5>
 134 <a name="boost_asio.reference.async_connect.h0"></a>
 135         <span class="phrase"><a name="boost_asio.reference.async_connect.requirements"></a></span><a class="link" href="async_connect.html#boost_asio.reference.async_connect.requirements">Requirements</a>
 136       </h5>
 137 <p>
 138         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/connect.hpp</code>
 139       </p>
 140 <p>
 141         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 142       </p>
 143 </div>
 144 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 145 <td align="left"></td>
 146 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
 147         Distributed under the Boost Software License, Version 1.0. (See accompanying
 148         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>)
 149       </p>
 150 </div></td>
 151 </tr></table>
 152 <hr>
 153 <div class="spirit-nav">
 154 <a accesskey="p" href="async_compose.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="async_connect/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 155 </div>
 156 </body>
 157 </html>