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