1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_stream::connect (4 of 10 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="../../../../index.html" title="Chapter 1. Boost.Beast"> 8<link rel="up" href="../connect.html" title="basic_stream::connect"> 9<link rel="prev" href="overload3.html" title="basic_stream::connect (3 of 10 overloads)"> 10<link rel="next" href="overload5.html" title="basic_stream::connect (5 of 10 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="overload3.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="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload5.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h6 class="title"> 27<a name="beast.ref.boost__beast__basic_stream.connect.overload4"></a><a class="link" href="overload4.html" title="basic_stream::connect (4 of 10 overloads)">basic_stream::connect 28 (4 of 10 overloads)</a> 29</h6></div></div></div> 30<p> 31 Establishes a connection by trying each endpoint in a sequence. 32 </p> 33<h7><a name="beast.ref.boost__beast__basic_stream.connect.overload4.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.connect.overload4.synopsis"></a></span><a class="link" href="overload4.html#beast.ref.boost__beast__basic_stream.connect.overload4.synopsis">Synopsis</a> 35 </h7><pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 36 <span class="keyword">class</span> <a href="../../../../../../../../doc/html/boost_asio/reference/EndpointSequence.html" target="_top"><span class="emphasis"><em>EndpointSequence</em></span></a><span class="special">></span> 37<span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span> 38<span class="identifier">connect</span><span class="special">(</span> 39 <span class="identifier">EndpointSequence</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">endpoints</span><span class="special">,</span> 40 <span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> 41</pre> 42<h7><a name="beast.ref.boost__beast__basic_stream.connect.overload4.h1"></a> 43 <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.connect.overload4.description"></a></span><a class="link" href="overload4.html#beast.ref.boost__beast__basic_stream.connect.overload4.description">Description</a> 44 </h7><p> 45 This function attempts to connect the stream to one of a sequence of 46 endpoints by trying each endpoint until a connection is successfully 47 established. The underlying socket is automatically opened if needed. 48 An automatically opened socket is not returned to the closed state upon 49 failure. The algorithm, known as a <span class="emphasis"><em>composed operation</em></span>, 50 is implemented in terms of calls to the underlying socket's <code class="computeroutput"><span class="identifier">connect</span></code> function. 51 </p> 52<h7><a name="beast.ref.boost__beast__basic_stream.connect.overload4.h2"></a> 53 <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.connect.overload4.parameters"></a></span><a class="link" href="overload4.html#beast.ref.boost__beast__basic_stream.connect.overload4.parameters">Parameters</a> 54 </h7><div class="informaltable"><table class="table"> 55<colgroup> 56<col> 57<col> 58</colgroup> 59<thead><tr> 60<th> 61 <p> 62 Name 63 </p> 64 </th> 65<th> 66 <p> 67 Description 68 </p> 69 </th> 70</tr></thead> 71<tbody> 72<tr> 73<td> 74 <p> 75 <code class="computeroutput"><span class="identifier">endpoints</span></code> 76 </p> 77 </td> 78<td> 79 <p> 80 A sequence of endpoints. 81 </p> 82 </td> 83</tr> 84<tr> 85<td> 86 <p> 87 <code class="computeroutput"><span class="identifier">ec</span></code> 88 </p> 89 </td> 90<td> 91 <p> 92 Set to indicate what error occurred, if any. If the sequence 93 is empty, set to <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">not_found</span></code>. 94 Otherwise, contains the error from the last connection attempt. 95 </p> 96 </td> 97</tr> 98</tbody> 99</table></div> 100<h7><a name="beast.ref.boost__beast__basic_stream.connect.overload4.h3"></a> 101 <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.connect.overload4.return_value"></a></span><a class="link" href="overload4.html#beast.ref.boost__beast__basic_stream.connect.overload4.return_value">Return 102 Value</a> 103 </h7><p> 104 On success, the successfully connected endpoint. Otherwise, a default-constructed 105 endpoint. 106 </p> 107</div> 108<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 109<td align="left"></td> 110<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 111 Falco<p> 112 Distributed under the Boost Software License, Version 1.0. (See accompanying 113 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>) 114 </p> 115</div></td> 116</tr></table> 117<hr> 118<div class="spirit-nav"> 119<a accesskey="p" href="overload3.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="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload5.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 120</div> 121</body> 122</html> 123
