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