• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>basic_stream::connect (5 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="overload4.html" title="basic_stream::connect (4 of 10 overloads)">
10<link rel="next" href="overload6.html" title="basic_stream::connect (6 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="overload4.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="overload6.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.overload5"></a><a class="link" href="overload5.html" title="basic_stream::connect (5 of 10 overloads)">basic_stream::connect
28          (5 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.overload5.h0"></a>
34            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.connect.overload5.synopsis"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__basic_stream.connect.overload5.synopsis">Synopsis</a>
35          </h7><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
36    <span class="keyword">class</span> <span class="identifier">Iterator</span><span class="special">&gt;</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</pre>
42<h7><a name="beast.ref.boost__beast__basic_stream.connect.overload5.h1"></a>
43            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.connect.overload5.description"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__basic_stream.connect.overload5.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.overload5.h2"></a>
53            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.connect.overload5.parameters"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__basic_stream.connect.overload5.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">begin</span></code>
76                    </p>
77                  </td>
78<td>
79                    <p>
80                      An iterator pointing to the start of a sequence of endpoints.
81                    </p>
82                  </td>
83</tr>
84<tr>
85<td>
86                    <p>
87                      <code class="computeroutput"><span class="identifier">end</span></code>
88                    </p>
89                  </td>
90<td>
91                    <p>
92                      An iterator pointing to the end of a sequence of endpoints.
93                    </p>
94                  </td>
95</tr>
96</tbody>
97</table></div>
98<h7><a name="beast.ref.boost__beast__basic_stream.connect.overload5.h3"></a>
99            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.connect.overload5.return_value"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__basic_stream.connect.overload5.return_value">Return
100            Value</a>
101          </h7><p>
102            An iterator denoting the successfully connected endpoint.
103          </p>
104<h7><a name="beast.ref.boost__beast__basic_stream.connect.overload5.h4"></a>
105            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.connect.overload5.exceptions"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__basic_stream.connect.overload5.exceptions">Exceptions</a>
106          </h7><div class="informaltable"><table class="table">
107<colgroup>
108<col>
109<col>
110</colgroup>
111<thead><tr>
112<th>
113                    <p>
114                      Type
115                    </p>
116                  </th>
117<th>
118                    <p>
119                      Thrown On
120                    </p>
121                  </th>
122</tr></thead>
123<tbody><tr>
124<td>
125                    <p>
126                      <code class="computeroutput"><span class="identifier">system_error</span></code>
127                    </p>
128                  </td>
129<td>
130                    <p>
131                      Thrown on failure. If the sequence is empty, the associated
132                      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>.
133                      Otherwise, contains the error from the last connection attempt.
134                    </p>
135                  </td>
136</tr></tbody>
137</table></div>
138</div>
139<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
140<td align="left"></td>
141<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
142      Falco<p>
143        Distributed under the Boost Software License, Version 1.0. (See accompanying
144        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>)
145      </p>
146</div></td>
147</tr></table>
148<hr>
149<div class="spirit-nav">
150<a accesskey="p" href="overload4.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="overload6.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
151</div>
152</body>
153</html>
154