128 lines
6.8 KiB
HTML
128 lines
6.8 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>connect (10 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="overload9.html" title="connect (9 of 12 overloads)">
|
|
<link rel="next" href="overload11.html" title="connect (11 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="overload9.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="overload11.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.overload10"></a><a class="link" href="overload10.html" title="connect (10 of 12 overloads)">connect (10
|
|
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<
|
|
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 Iterator,
|
|
typename <a class="link" href="../ConnectCondition.html" title="Connect condition requirements">ConnectCondition</a>>
|
|
Iterator connect(
|
|
basic_socket< Protocol, Executor > & s,
|
|
Iterator begin,
|
|
ConnectCondition connect_condition,
|
|
boost::system::error_code & ec,
|
|
typename constraint<!is_endpoint_sequence< Iterator >::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="boost_asio.reference.connect.overload10.h0"></a>
|
|
<span class="phrase"><a name="boost_asio.reference.connect.overload10.parameters"></a></span><a class="link" href="overload10.html#boost_asio.reference.connect.overload10.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& ec,
|
|
const typename Protocol::endpoint& 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>
|
|
<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">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.overload10.h1"></a>
|
|
<span class="phrase"><a name="boost_asio.reference.connect.overload10.return_value"></a></span><a class="link" href="overload10.html#boost_asio.reference.connect.overload10.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.overload10.h2"></a>
|
|
<span class="phrase"><a name="boost_asio.reference.connect.overload10.remarks"></a></span><a class="link" href="overload10.html#boost_asio.reference.connect.overload10.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 © 2003-2021 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="overload9.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="overload11.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|