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