1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>connect (3 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="overload2.html" title="connect (2 of 12 overloads)"> 10<link rel="next" href="overload4.html" title="connect (4 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="overload2.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="overload4.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.overload3"></a><a class="link" href="overload3.html" title="connect (3 of 12 overloads)">connect (3 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> 38Iterator connect( 39 basic_socket< Protocol, Executor > & s, 40 Iterator begin, 41 typename enable_if<!is_endpoint_sequence< Iterator >::value >::type * = 0); 42</pre> 43<p> 44 This function attempts to connect a socket to one of a sequence of endpoints. 45 It does this by repeated calls to the socket's <code class="computeroutput">connect</code> member 46 function, once for each endpoint in the sequence, until a connection is 47 successfully established. 48 </p> 49<h6> 50<a name="boost_asio.reference.connect.overload3.h0"></a> 51 <span class="phrase"><a name="boost_asio.reference.connect.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.connect.overload3.parameters">Parameters</a> 52 </h6> 53<div class="variablelist"> 54<p class="title"><b></b></p> 55<dl class="variablelist"> 56<dt><span class="term">s</span></dt> 57<dd><p> 58 The socket to be connected. If the socket is already open, it will 59 be closed. 60 </p></dd> 61<dt><span class="term">begin</span></dt> 62<dd><p> 63 An iterator pointing to the start of a sequence of endpoints. 64 </p></dd> 65</dl> 66</div> 67<h6> 68<a name="boost_asio.reference.connect.overload3.h1"></a> 69 <span class="phrase"><a name="boost_asio.reference.connect.overload3.return_value"></a></span><a class="link" href="overload3.html#boost_asio.reference.connect.overload3.return_value">Return Value</a> 70 </h6> 71<p> 72 On success, an iterator denoting the successfully connected endpoint. Otherwise, 73 the end iterator. 74 </p> 75<h6> 76<a name="boost_asio.reference.connect.overload3.h2"></a> 77 <span class="phrase"><a name="boost_asio.reference.connect.overload3.exceptions"></a></span><a class="link" href="overload3.html#boost_asio.reference.connect.overload3.exceptions">Exceptions</a> 78 </h6> 79<div class="variablelist"> 80<p class="title"><b></b></p> 81<dl class="variablelist"> 82<dt><span class="term">boost::system::system_error</span></dt> 83<dd><p> 84 Thrown on failure. If the sequence is empty, the associated <code class="computeroutput">error_code</code> 85 is <code class="computeroutput">boost::asio::error::not_found</code>. Otherwise, contains 86 the error from the last connection attempt. 87 </p></dd> 88</dl> 89</div> 90<h6> 91<a name="boost_asio.reference.connect.overload3.h3"></a> 92 <span class="phrase"><a name="boost_asio.reference.connect.overload3.remarks"></a></span><a class="link" href="overload3.html#boost_asio.reference.connect.overload3.remarks">Remarks</a> 93 </h6> 94<p> 95 This overload assumes that a default constructed object of type <code class="computeroutput">Iterator</code> 96 represents the end of the sequence. This is a valid assumption for iterator 97 types such as <code class="computeroutput">boost::asio::ip::tcp::resolver::iterator</code>. 98 </p> 99</div> 100<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 101<td align="left"></td> 102<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 103 Kohlhoff<p> 104 Distributed under the Boost Software License, Version 1.0. (See accompanying 105 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>) 106 </p> 107</div></td> 108</tr></table> 109<hr> 110<div class="spirit-nav"> 111<a accesskey="p" href="overload2.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="overload4.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 112</div> 113</body> 114</html> 115
