1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>connect (10 of 12 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="../connect.html" title="connect"> 9<link rel="prev" href="overload9.html" title="connect (9 of 12 overloads)"> 10<link rel="next" href="overload11.html" title="connect (11 of 12 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="overload9.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../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="overload11.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.connect.overload10"></a><a class="link" href="overload10.html" title="connect (10 of 12 overloads)">connect (10 28 of 12 overloads)</a> 29</h4></div></div></div> 30<p> 31 (Deprecated: Use range overload.) Establishes a socket connection by trying 32 each endpoint in a sequence. 33 </p> 34<pre class="programlisting">template< 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="../ConnectCondition.html" title="Connect condition requirements">ConnectCondition</a>> 39Iterator connect( 40 basic_socket< Protocol, Executor > & s, 41 Iterator begin, 42 ConnectCondition connect_condition, 43 boost::system::error_code & ec, 44 typename enable_if<!is_endpoint_sequence< Iterator >::value >::type * = 0); 45</pre> 46<p> 47 This function attempts to connect a socket to one of a sequence of endpoints. 48 It does this by repeated calls to the socket's <code class="computeroutput">connect</code> member 49 function, once for each endpoint in the sequence, until a connection is 50 successfully established. 51 </p> 52<h6> 53<a name="boost_asio.reference.connect.overload10.h0"></a> 54 <span class="phrase"><a name="boost_asio.reference.connect.overload10.parameters"></a></span><a class="link" href="overload10.html#boost_asio.reference.connect.overload10.parameters">Parameters</a> 55 </h6> 56<div class="variablelist"> 57<p class="title"><b></b></p> 58<dl class="variablelist"> 59<dt><span class="term">s</span></dt> 60<dd><p> 61 The socket to be connected. If the socket is already open, it will 62 be closed. 63 </p></dd> 64<dt><span class="term">begin</span></dt> 65<dd><p> 66 An iterator pointing to the start of a sequence of endpoints. 67 </p></dd> 68<dt><span class="term">connect_condition</span></dt> 69<dd> 70<p> 71 A function object that is called prior to each connection attempt. 72 The signature of the function object must be: 73</p> 74<pre class="programlisting">bool connect_condition( 75 const boost::system::error_code& ec, 76 const typename Protocol::endpoint& next); 77</pre> 78<p> 79 The <code class="computeroutput">ec</code> parameter contains the result from the most recent 80 connect operation. Before the first connection attempt, <code class="computeroutput">ec</code> 81 is always set to indicate success. The <code class="computeroutput">next</code> parameter 82 is the next endpoint to be tried. The function object should return 83 true if the next endpoint should be tried, and false if it should 84 be skipped. 85 </p> 86</dd> 87<dt><span class="term">ec</span></dt> 88<dd><p> 89 Set to indicate what error occurred, if any. If the sequence is empty, 90 set to <code class="computeroutput">boost::asio::error::not_found</code>. Otherwise, contains 91 the error from the last connection attempt. 92 </p></dd> 93</dl> 94</div> 95<h6> 96<a name="boost_asio.reference.connect.overload10.h1"></a> 97 <span class="phrase"><a name="boost_asio.reference.connect.overload10.return_value"></a></span><a class="link" href="overload10.html#boost_asio.reference.connect.overload10.return_value">Return Value</a> 98 </h6> 99<p> 100 On success, an iterator denoting the successfully connected endpoint. Otherwise, 101 the end iterator. 102 </p> 103<h6> 104<a name="boost_asio.reference.connect.overload10.h2"></a> 105 <span class="phrase"><a name="boost_asio.reference.connect.overload10.remarks"></a></span><a class="link" href="overload10.html#boost_asio.reference.connect.overload10.remarks">Remarks</a> 106 </h6> 107<p> 108 This overload assumes that a default constructed object of type <code class="computeroutput">Iterator</code> 109 represents the end of the sequence. This is a valid assumption for iterator 110 types such as <code class="computeroutput">boost::asio::ip::tcp::resolver::iterator</code>. 111 </p> 112</div> 113<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 114<td align="left"></td> 115<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 116 Kohlhoff<p> 117 Distributed under the Boost Software License, Version 1.0. (See accompanying 118 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>) 119 </p> 120</div></td> 121</tr></table> 122<hr> 123<div class="spirit-nav"> 124<a accesskey="p" href="overload9.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../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="overload11.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 125</div> 126</body> 127</html> 128
