Insane_DNS/libraries/asio-1.28.1/doc/asio/reference/connect.html

208 lines
26 KiB
HTML
Raw Normal View History

2023-10-24 21:59:30 -04:00
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>connect</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="../reference.html" title="Reference">
<link rel="prev" href="completion_signature_of/type.html" title="completion_signature_of::type">
<link rel="next" href="connect/overload1.html" title="connect (1 of 12 overloads)">
<meta name="viewport" content="width=device-width, initial-scale=1">
</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="completion_signature_of/type.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="connect/overload1.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.connect"></a><a class="link" href="connect.html" title="connect">connect</a>
</h3></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.connect"></a>
</p>
<p>
The <code class="computeroutput"><span class="identifier">connect</span></code> function is a
composed operation that establishes a socket connection by trying each endpoint
in a sequence.
</p>
<p>
Establishes a socket connection by trying each endpoint in a sequence.
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="EndpointSequence.html" title="Endpoint sequence requirements">EndpointSequence</a><span class="special">&gt;</span>
<span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span> <a class="link" href="connect/overload1.html" title="connect (1 of 12 overloads)">connect</a><span class="special">(</span>
<span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">Executor</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">EndpointSequence</span> <span class="special">&amp;</span> <span class="identifier">endpoints</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">constraint</span><span class="special">&lt;</span> <span class="identifier">is_endpoint_sequence</span><span class="special">&lt;</span> <span class="identifier">EndpointSequence</span> <span class="special">&gt;::</span><span class="identifier">value</span> <span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
<span class="emphasis"><em>» <a class="link" href="connect/overload1.html" title="connect (1 of 12 overloads)">more...</a></em></span>
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="EndpointSequence.html" title="Endpoint sequence requirements">EndpointSequence</a><span class="special">&gt;</span>
<span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span> <a class="link" href="connect/overload2.html" title="connect (2 of 12 overloads)">connect</a><span class="special">(</span>
<span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">Executor</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">EndpointSequence</span> <span class="special">&amp;</span> <span class="identifier">endpoints</span><span class="special">,</span>
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">constraint</span><span class="special">&lt;</span> <span class="identifier">is_endpoint_sequence</span><span class="special">&lt;</span> <span class="identifier">EndpointSequence</span> <span class="special">&gt;::</span><span class="identifier">value</span> <span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
<span class="emphasis"><em>» <a class="link" href="connect/overload2.html" title="connect (2 of 12 overloads)">more...</a></em></span>
</pre>
<p>
(Deprecated: Use range overload.) Establishes a socket connection by trying
each endpoint in a sequence.
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">&gt;</span>
<span class="identifier">Iterator</span> <a class="link" href="connect/overload3.html" title="connect (3 of 12 overloads)">connect</a><span class="special">(</span>
<span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">Executor</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">begin</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">constraint</span><span class="special">&lt;!</span><span class="identifier">is_endpoint_sequence</span><span class="special">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;::</span><span class="identifier">value</span> <span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
<span class="emphasis"><em>» <a class="link" href="connect/overload3.html" title="connect (3 of 12 overloads)">more...</a></em></span>
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">&gt;</span>
<span class="identifier">Iterator</span> <a class="link" href="connect/overload4.html" title="connect (4 of 12 overloads)">connect</a><span class="special">(</span>
<span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">Executor</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">begin</span><span class="special">,</span>
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">constraint</span><span class="special">&lt;!</span><span class="identifier">is_endpoint_sequence</span><span class="special">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;::</span><span class="identifier">value</span> <span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
<span class="emphasis"><em>» <a class="link" href="connect/overload4.html" title="connect (4 of 12 overloads)">more...</a></em></span>
</pre>
<p>
Establishes a socket connection by trying each endpoint in a sequence.
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">&gt;</span>
<span class="identifier">Iterator</span> <a class="link" href="connect/overload5.html" title="connect (5 of 12 overloads)">connect</a><span class="special">(</span>
<span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">Executor</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">begin</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">end</span><span class="special">);</span>
<span class="emphasis"><em>» <a class="link" href="connect/overload5.html" title="connect (5 of 12 overloads)">more...</a></em></span>
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">&gt;</span>
<span class="identifier">Iterator</span> <a class="link" href="connect/overload6.html" title="connect (6 of 12 overloads)">connect</a><span class="special">(</span>
<span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">Executor</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">begin</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">end</span><span class="special">,</span>
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
<span class="emphasis"><em>» <a class="link" href="connect/overload6.html" title="connect (6 of 12 overloads)">more...</a></em></span>
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="EndpointSequence.html" title="Endpoint sequence requirements">EndpointSequence</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="ConnectCondition.html" title="Connect condition requirements">ConnectCondition</a><span class="special">&gt;</span>
<span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span> <a class="link" href="connect/overload7.html" title="connect (7 of 12 overloads)">connect</a><span class="special">(</span>
<span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">Executor</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">EndpointSequence</span> <span class="special">&amp;</span> <span class="identifier">endpoints</span><span class="special">,</span>
<span class="identifier">ConnectCondition</span> <span class="identifier">connect_condition</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">constraint</span><span class="special">&lt;</span> <span class="identifier">is_endpoint_sequence</span><span class="special">&lt;</span> <span class="identifier">EndpointSequence</span> <span class="special">&gt;::</span><span class="identifier">value</span> <span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
<span class="emphasis"><em>» <a class="link" href="connect/overload7.html" title="connect (7 of 12 overloads)">more...</a></em></span>
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="EndpointSequence.html" title="Endpoint sequence requirements">EndpointSequence</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="ConnectCondition.html" title="Connect condition requirements">ConnectCondition</a><span class="special">&gt;</span>
<span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span> <a class="link" href="connect/overload8.html" title="connect (8 of 12 overloads)">connect</a><span class="special">(</span>
<span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">Executor</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">EndpointSequence</span> <span class="special">&amp;</span> <span class="identifier">endpoints</span><span class="special">,</span>
<span class="identifier">ConnectCondition</span> <span class="identifier">connect_condition</span><span class="special">,</span>
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">constraint</span><span class="special">&lt;</span> <span class="identifier">is_endpoint_sequence</span><span class="special">&lt;</span> <span class="identifier">EndpointSequence</span> <span class="special">&gt;::</span><span class="identifier">value</span> <span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
<span class="emphasis"><em>» <a class="link" href="connect/overload8.html" title="connect (8 of 12 overloads)">more...</a></em></span>
</pre>
<p>
(Deprecated: Use range overload.) Establishes a socket connection by trying
each endpoint in a sequence.
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="ConnectCondition.html" title="Connect condition requirements">ConnectCondition</a><span class="special">&gt;</span>
<span class="identifier">Iterator</span> <a class="link" href="connect/overload9.html" title="connect (9 of 12 overloads)">connect</a><span class="special">(</span>
<span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">Executor</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">begin</span><span class="special">,</span>
<span class="identifier">ConnectCondition</span> <span class="identifier">connect_condition</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">constraint</span><span class="special">&lt;!</span><span class="identifier">is_endpoint_sequence</span><span class="special">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;::</span><span class="identifier">value</span> <span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
<span class="emphasis"><em>» <a class="link" href="connect/overload9.html" title="connect (9 of 12 overloads)">more...</a></em></span>
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="ConnectCondition.html" title="Connect condition requirements">ConnectCondition</a><span class="special">&gt;</span>
<span class="identifier">Iterator</span> <a class="link" href="connect/overload10.html" title="connect (10 of 12 overloads)">connect</a><span class="special">(</span>
<span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">Executor</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">begin</span><span class="special">,</span>
<span class="identifier">ConnectCondition</span> <span class="identifier">connect_condition</span><span class="special">,</span>
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">constraint</span><span class="special">&lt;!</span><span class="identifier">is_endpoint_sequence</span><span class="special">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;::</span><span class="identifier">value</span> <span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
<span class="emphasis"><em>» <a class="link" href="connect/overload10.html" title="connect (10 of 12 overloads)">more...</a></em></span>
</pre>
<p>
Establishes a socket connection by trying each endpoint in a sequence.
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="ConnectCondition.html" title="Connect condition requirements">ConnectCondition</a><span class="special">&gt;</span>
<span class="identifier">Iterator</span> <a class="link" href="connect/overload11.html" title="connect (11 of 12 overloads)">connect</a><span class="special">(</span>
<span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">Executor</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">begin</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">end</span><span class="special">,</span>
<span class="identifier">ConnectCondition</span> <span class="identifier">connect_condition</span><span class="special">);</span>
<span class="emphasis"><em>» <a class="link" href="connect/overload11.html" title="connect (11 of 12 overloads)">more...</a></em></span>
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="ConnectCondition.html" title="Connect condition requirements">ConnectCondition</a><span class="special">&gt;</span>
<span class="identifier">Iterator</span> <a class="link" href="connect/overload12.html" title="connect (12 of 12 overloads)">connect</a><span class="special">(</span>
<span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">Executor</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">begin</span><span class="special">,</span>
<span class="identifier">Iterator</span> <span class="identifier">end</span><span class="special">,</span>
<span class="identifier">ConnectCondition</span> <span class="identifier">connect_condition</span><span class="special">,</span>
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
<span class="emphasis"><em>» <a class="link" href="connect/overload12.html" title="connect (12 of 12 overloads)">more...</a></em></span>
</pre>
<h5>
<a name="asio.reference.connect.h0"></a>
<span><a name="asio.reference.connect.requirements"></a></span><a class="link" href="connect.html#asio.reference.connect.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/connect.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
</p>
</div>
<div class="copyright-footer">Copyright © 2003-2023 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>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="completion_signature_of/type.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="connect/overload1.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>