overload2.html
5.01 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>connect (2 of 12 overloads)</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../connect.html" title="connect">
<link rel="prev" href="overload1.html" title="connect (1 of 12 overloads)">
<link rel="next" href="overload3.html" title="connect (3 of 12 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../connect.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.connect.overload2"></a><a class="link" href="overload2.html" title="connect (2 of 12 overloads)">connect (2 of 12
overloads)</a>
</h4></div></div></div>
<p>
Establishes a socket connection by trying each endpoint in a sequence.
</p>
<pre class="programlisting">template<
typename <a class="link" href="../Protocol.html" title="Protocol requirements">Protocol</a>,
typename <a class="link" href="../Executor1.html" title="Executor requirements">Executor</a>,
typename <a class="link" href="../EndpointSequence.html" title="Endpoint sequence requirements">EndpointSequence</a>>
Protocol::endpoint connect(
basic_socket< Protocol, Executor > & s,
const EndpointSequence & endpoints,
asio::error_code & ec,
typename enable_if< is_endpoint_sequence< EndpointSequence >::value >::type * = 0);
</pre>
<p>
This function attempts to connect a socket to one of a sequence of endpoints.
It does this by repeated calls to the socket's <code class="computeroutput">connect</code> member
function, once for each endpoint in the sequence, until a connection is
successfully established.
</p>
<h6>
<a name="asio.reference.connect.overload2.h0"></a>
<span><a name="asio.reference.connect.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.connect.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">s</span></dt>
<dd><p>
The socket to be connected. If the socket is already open, it will
be closed.
</p></dd>
<dt><span class="term">endpoints</span></dt>
<dd><p>
A sequence of endpoints.
</p></dd>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any. If the sequence is empty,
set to <code class="computeroutput">asio::error::not_found</code>. Otherwise, contains the
error from the last connection attempt.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.connect.overload2.h1"></a>
<span><a name="asio.reference.connect.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.connect.overload2.return_value">Return
Value</a>
</h6>
<p>
On success, the successfully connected endpoint. Otherwise, a default-constructed
endpoint.
</p>
<h6>
<a name="asio.reference.connect.overload2.h2"></a>
<span><a name="asio.reference.connect.overload2.example"></a></span><a class="link" href="overload2.html#asio.reference.connect.overload2.example">Example</a>
</h6>
<pre class="programlisting">tcp::resolver r(my_context);
tcp::resolver::query q("host", "service");
tcp::socket s(my_context);
asio::error_code ec;
asio::connect(s, r.resolve(q), ec);
if (ec)
{
// An error occurred.
}
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
Kohlhoff<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../connect.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>