1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>connect (2 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="overload1.html" title="connect (1 of 12 overloads)"> 10<link rel="next" href="overload3.html" title="connect (3 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="overload1.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="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.connect.overload2"></a><a class="link" href="overload2.html" title="connect (2 of 12 overloads)">connect (2 28 of 12 overloads)</a> 29</h4></div></div></div> 30<p> 31 Establishes a socket connection by trying each endpoint in a sequence. 32 </p> 33<pre class="programlisting">template< 34 typename <a class="link" href="../Protocol.html" title="Protocol requirements">Protocol</a>, 35 typename <a class="link" href="../Executor1.html" title="Executor requirements">Executor</a>, 36 typename <a class="link" href="../EndpointSequence.html" title="Endpoint sequence requirements">EndpointSequence</a>> 37Protocol::endpoint connect( 38 basic_socket< Protocol, Executor > & s, 39 const EndpointSequence & endpoints, 40 boost::system::error_code & ec, 41 typename enable_if< is_endpoint_sequence< EndpointSequence >::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.overload2.h0"></a> 51 <span class="phrase"><a name="boost_asio.reference.connect.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.connect.overload2.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">endpoints</span></dt> 62<dd><p> 63 A sequence of endpoints. 64 </p></dd> 65<dt><span class="term">ec</span></dt> 66<dd><p> 67 Set to indicate what error occurred, if any. If the sequence is empty, 68 set to <code class="computeroutput">boost::asio::error::not_found</code>. Otherwise, contains 69 the error from the last connection attempt. 70 </p></dd> 71</dl> 72</div> 73<h6> 74<a name="boost_asio.reference.connect.overload2.h1"></a> 75 <span class="phrase"><a name="boost_asio.reference.connect.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.connect.overload2.return_value">Return Value</a> 76 </h6> 77<p> 78 On success, the successfully connected endpoint. Otherwise, a default-constructed 79 endpoint. 80 </p> 81<h6> 82<a name="boost_asio.reference.connect.overload2.h2"></a> 83 <span class="phrase"><a name="boost_asio.reference.connect.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.connect.overload2.example">Example</a> 84 </h6> 85<pre class="programlisting">tcp::resolver r(my_context); 86tcp::resolver::query q("host", "service"); 87tcp::socket s(my_context); 88boost::system::error_code ec; 89boost::asio::connect(s, r.resolve(q), ec); 90if (ec) 91{ 92 // An error occurred. 93} 94</pre> 95</div> 96<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 97<td align="left"></td> 98<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 99 Kohlhoff<p> 100 Distributed under the Boost Software License, Version 1.0. (See accompanying 101 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>) 102 </p> 103</div></td> 104</tr></table> 105<hr> 106<div class="spirit-nav"> 107<a accesskey="p" href="overload1.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="overload3.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 108</div> 109</body> 110</html> 111
