• 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 (2 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="overload1.html" title="basic_stream::connect (1 of 10 overloads)">
10<link rel="next" href="overload3.html" title="basic_stream::connect (3 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="overload1.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="overload3.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.overload2"></a><a class="link" href="overload2.html" title="basic_stream::connect (2 of 10 overloads)">basic_stream::connect
28          (2 of 10 overloads)</a>
29</h6></div></div></div>
30<p>
31            Connect the stream to the specified endpoint.
32          </p>
33<h7><a name="beast.ref.boost__beast__basic_stream.connect.overload2.h0"></a>
34            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.connect.overload2.synopsis"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__basic_stream.connect.overload2.synopsis">Synopsis</a>
35          </h7><pre class="programlisting"><span class="keyword">void</span>
36<span class="identifier">connect</span><span class="special">(</span>
37    <span class="identifier">endpoint_type</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">ep</span><span class="special">,</span>
38    <span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
39</pre>
40<h7><a name="beast.ref.boost__beast__basic_stream.connect.overload2.h1"></a>
41            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.connect.overload2.description"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__basic_stream.connect.overload2.description">Description</a>
42          </h7><p>
43            This function is used to connect the underlying socket to the specified
44            remote endpoint. The function call will block until the connection is
45            successfully made or an error occurs. The underlying socket is automatically
46            opened if needed. An automatically opened socket is not returned to the
47            closed state upon failure.
48          </p>
49<h7><a name="beast.ref.boost__beast__basic_stream.connect.overload2.h2"></a>
50            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.connect.overload2.parameters"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__basic_stream.connect.overload2.parameters">Parameters</a>
51          </h7><div class="informaltable"><table class="table">
52<colgroup>
53<col>
54<col>
55</colgroup>
56<thead><tr>
57<th>
58                    <p>
59                      Name
60                    </p>
61                  </th>
62<th>
63                    <p>
64                      Description
65                    </p>
66                  </th>
67</tr></thead>
68<tbody>
69<tr>
70<td>
71                    <p>
72                      <code class="computeroutput"><span class="identifier">ep</span></code>
73                    </p>
74                  </td>
75<td>
76                    <p>
77                      The remote endpoint to connect to.
78                    </p>
79                  </td>
80</tr>
81<tr>
82<td>
83                    <p>
84                      <code class="computeroutput"><span class="identifier">ec</span></code>
85                    </p>
86                  </td>
87<td>
88                    <p>
89                      Set to indicate what error occurred, if any.
90                    </p>
91                  </td>
92</tr>
93</tbody>
94</table></div>
95<h7><a name="beast.ref.boost__beast__basic_stream.connect.overload2.h3"></a>
96            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.connect.overload2.see_also"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__basic_stream.connect.overload2.see_also">See
97            Also</a>
98          </h7><p>
99            <a class="link" href="overload1.html" title="basic_stream::connect (1 of 10 overloads)"><code class="computeroutput"><span class="identifier">connect</span></code></a>
100          </p>
101</div>
102<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
103<td align="left"></td>
104<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
105      Falco<p>
106        Distributed under the Boost Software License, Version 1.0. (See accompanying
107        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>)
108      </p>
109</div></td>
110</tr></table>
111<hr>
112<div class="spirit-nav">
113<a accesskey="p" href="overload1.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="overload3.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
114</div>
115</body>
116</html>
117