doc/html/boost_asio/reference/connect/overload9.html


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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>connect (9 of 12 overloads)</title>
<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../connect.html" title="connect">
<link rel="prev" href="overload8.html" title="connect (8 of 12 overloads)">
<link rel="next" href="overload10.html" title="connect (10 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="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload8.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="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload10.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.connect.overload9"></a><a class="link" href="overload9.html" title="connect (9 of 12 overloads)">connect (9
        of 12 overloads)</a>
</h4></div></div></div>
<p>
          (Deprecated: Use range overload.) Establishes a socket connection by trying
          each endpoint in a sequence.
        </p>
<pre class="programlisting">template&lt;
    typename <a class="link" href="../Protocol.html" title="Protocol requirements">Protocol</a>,
    typename Iterator,
    typename <a class="link" href="../ConnectCondition.html" title="Connect condition requirements">ConnectCondition</a>&gt;
Iterator connect(
    basic_socket&lt; Protocol &gt; &amp; s,
    Iterator begin,
    ConnectCondition connect_condition,
    typename enable_if&lt;!is_endpoint_sequence&lt; Iterator &gt;::value &gt;::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="boost_asio.reference.connect.overload9.h0"></a>
          <span class="phrase"><a name="boost_asio.reference.connect.overload9.parameters"></a></span><a class="link" href="overload9.html#boost_asio.reference.connect.overload9.parameters">Parameters</a>
        </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<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">begin</span></dt>
<dd><p>
                An iterator pointing to the start of a sequence of endpoints.
              </p></dd>
<dt><span class="term">connect_condition</span></dt>
<dd>
<p>
                A function object that is called prior to each connection attempt.
                The signature of the function object must be:
</p>
<pre class="programlisting">bool connect_condition(
    const boost::system::error_code&amp; ec,
    const typename Protocol::endpoint&amp; next);
</pre>
<p>
                The <code class="computeroutput">ec</code> parameter contains the result from the most recent
                connect operation. Before the first connection attempt, <code class="computeroutput">ec</code>
                is always set to indicate success. The <code class="computeroutput">next</code> parameter
                is the next endpoint to be tried. The function object should return
                true if the next endpoint should be tried, and false if it should
                be skipped.
              </p>
</dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.connect.overload9.h1"></a>
          <span class="phrase"><a name="boost_asio.reference.connect.overload9.return_value"></a></span><a class="link" href="overload9.html#boost_asio.reference.connect.overload9.return_value">Return Value</a>
        </h6>
<p>
          On success, an iterator denoting the successfully connected endpoint. Otherwise,
          the end iterator.
        </p>
<h6>
<a name="boost_asio.reference.connect.overload9.h2"></a>
          <span class="phrase"><a name="boost_asio.reference.connect.overload9.exceptions"></a></span><a class="link" href="overload9.html#boost_asio.reference.connect.overload9.exceptions">Exceptions</a>
        </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">boost::system::system_error</span></dt>
<dd><p>
                Thrown on failure. If the sequence is empty, the associated <code class="computeroutput">error_code</code>
                is <code class="computeroutput">boost::asio::error::not_found</code>. Otherwise, contains
                the error from the last connection attempt.
              </p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.connect.overload9.h3"></a>
          <span class="phrase"><a name="boost_asio.reference.connect.overload9.remarks"></a></span><a class="link" href="overload9.html#boost_asio.reference.connect.overload9.remarks">Remarks</a>
        </h6>
<p>
          This overload assumes that a default constructed object of type <code class="computeroutput">Iterator</code>
          represents the end of the sequence. This is a valid assumption for iterator
          types such as <code class="computeroutput">boost::asio::ip::tcp::resolver::iterator</code>.
        </p>
</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 &#169; 2003-2018 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="overload8.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="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload10.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>