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