doc/html/boost_asio/reference/async_connect/overload2.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>async_connect (2 of 6 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_connect.html" title="async_connect">
   9 <link rel="prev" href="overload1.html" title="async_connect (1 of 6 overloads)">
  10 <link rel="next" href="overload3.html" title="async_connect (3 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="overload1.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="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="boost_asio.reference.async_connect.overload2"></a><a class="link" href="overload2.html" title="async_connect (2 of 6 overloads)">async_connect
  28         (2 of 6 overloads)</a>
  29 </h4></div></div></div>
  30 <p>
  31           (Deprecated: Use range overload.) Asynchronously establishes a socket connection
  32           by trying each endpoint in a sequence.
  33         </p>
  34 <pre class="programlisting">template&lt;
  35     typename <a class="link" href="../Protocol.html" title="Protocol requirements">Protocol</a>,
  36     typename <a class="link" href="../Executor1.html" title="Executor requirements">Executor</a>,
  37     typename Iterator,
  38     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;
  39 <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_connect(
  40     basic_socket&lt; Protocol, Executor &gt; &amp; s,
  41     Iterator begin,
  42     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>,
  43     typename enable_if&lt;!is_endpoint_sequence&lt; Iterator &gt;::value &gt;::type *  = 0);
  44 </pre>
  45 <p>
  46           This function attempts to connect a socket to one of a sequence of endpoints.
  47           It does this by repeated calls to the socket's <code class="computeroutput">async_connect</code>
  48           member function, once for each endpoint in the sequence, until a connection
  49           is successfully established.
  50         </p>
  51 <h6>
  52 <a name="boost_asio.reference.async_connect.overload2.h0"></a>
  53           <span class="phrase"><a name="boost_asio.reference.async_connect.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.async_connect.overload2.parameters">Parameters</a>
  54         </h6>
  55 <div class="variablelist">
  56 <p class="title"><b></b></p>
  57 <dl class="variablelist">
  58 <dt><span class="term">s</span></dt>
  59 <dd><p>
  60                 The socket to be connected. If the socket is already open, it will
  61                 be closed.
  62               </p></dd>
  63 <dt><span class="term">begin</span></dt>
  64 <dd><p>
  65                 An iterator pointing to the start of a sequence of endpoints.
  66               </p></dd>
  67 <dt><span class="term">handler</span></dt>
  68 <dd>
  69 <p>
  70                 The handler to be called when the connect operation completes. Copies
  71                 will be made of the handler as required. The function signature of
  72                 the handler must be:
  73 </p>
  74 <pre class="programlisting">void handler(
  75   // Result of operation. if the sequence is empty, set to
  76   // boost::asio::error::not_found. Otherwise, contains the
  77   // error from the last connection attempt.
  78   const boost::system::error_code&amp; error,
  79
  80   // On success, an iterator denoting the successfully
  81   // connected endpoint. Otherwise, the end iterator.
  82   Iterator iterator
  83 );
  84 </pre>
  85 <p>
  86                 Regardless of whether the asynchronous operation completes immediately
  87                 or not, the handler will not be invoked from within this function.
  88                 On immediate completion, invocation of the handler will be performed
  89                 in a manner equivalent to using <a class="link" href="../post.html" title="post"><code class="computeroutput">post</code></a>.
  90               </p>
  91 </dd>
  92 </dl>
  93 </div>
  94 <h6>
  95 <a name="boost_asio.reference.async_connect.overload2.h1"></a>
  96           <span class="phrase"><a name="boost_asio.reference.async_connect.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.async_connect.overload2.remarks">Remarks</a>
  97         </h6>
  98 <p>
  99           This overload assumes that a default constructed object of type <code class="computeroutput">Iterator</code>
 100           represents the end of the sequence. This is a valid assumption for iterator
 101           types such as <code class="computeroutput">boost::asio::ip::tcp::resolver::iterator</code>.
 102         </p>
 103 </div>
 104 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 105 <td align="left"></td>
 106 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
 107         Distributed under the Boost Software License, Version 1.0. (See accompanying
 108         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>)
 109       </p>
 110 </div></td>
 111 </tr></table>
 112 <hr>
 113 <div class="spirit-nav">
 114 <a accesskey="p" href="overload1.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="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 115 </div>
 116 </body>
 117 </html>