Imported Upstream version 1.66.0upstream/1.66.0

author: DongHun Kwak <dh0128.kwak@samsung.com> 2019-12-05 15:11:01 +0900
committer: DongHun Kwak <dh0128.kwak@samsung.com> 2019-12-05 15:11:01 +0900
commit: 3fdc3e5ee96dca5b11d1694975a65200787eab86 (patch)
tree: 5c1733853892b8397d67706fa453a9bd978d2102 /doc/html/boost_asio/reference/connect/overload6.html
parent: 88e602c57797660ebe0f9e15dbd64c1ff16dead3 (diff)
download: boost-3fdc3e5ee96dca5b11d1694975a65200787eab86.tar.gz
boost-3fdc3e5ee96dca5b11d1694975a65200787eab86.tar.bz2
boost-3fdc3e5ee96dca5b11d1694975a65200787eab86.zip
1 files changed, 31 insertions, 84 deletions
diff --git a/doc/html/boost_asio/reference/connect/overload6.html b/doc/html/boost_asio/reference/connect/overload6.html
index 27b1f60941..2a3b44b86b 100644
--- a/doc/html/boost_asio/reference/connect/overload6.html
+++ b/doc/html/boost_asio/reference/connect/overload6.html
@@ -1,13 +1,13 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>connect (6 of 8 overloads)</title>
+<title>connect (6 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="overload5.html" title="connect (5 of 8 overloads)">
-<link rel="next" href="overload7.html" title="connect (7 of 8 overloads)">
+<link rel="prev" href="overload5.html" title="connect (5 of 12 overloads)">
+<link rel="next" href="overload7.html" title="connect (7 of 12 overloads)">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 <table cellpadding="2" width="100%"><tr>
@@ -24,28 +24,26 @@
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="boost_asio.reference.connect.overload6"></a><a class="link" href="overload6.html" title="connect (6 of 8 overloads)">connect (6
-        of 8 overloads)</a>
+<a name="boost_asio.reference.connect.overload6"></a><a class="link" href="overload6.html" title="connect (6 of 12 overloads)">connect (6
+        of 12 overloads)</a>
 </h4></div></div></div>
 <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="../SocketService.html" title="Socket service requirements">SocketService</a><span class="special">,</span>
-    <span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">,</span>
-    <span class="keyword">typename</span> <span class="identifier">ConnectCondition</span><span class="special">&gt;</span>
-<span class="identifier">Iterator</span> <span class="identifier">connect</span><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">SocketService</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">boost</span><span class="special">::</span><span class="identifier">system</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>
+<pre class="programlisting">template&lt;
+    typename <a class="link" href="../Protocol.html" title="Protocol requirements">Protocol</a>,
+    typename Iterator&gt;
+Iterator connect(
+    basic_socket&lt; Protocol &gt; &amp; s,
+    Iterator begin,
+    Iterator end,
+    boost::system::error_code &amp; ec);
 </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"><span class="identifier">connect</span></code>
-          member function, once for each endpoint in the sequence, until a connection
-          is successfully established.
+          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.overload6.h0"></a>
@@ -63,32 +61,14 @@
 <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"><span class="identifier">Iterator</span> <span class="identifier">connect_condition</span><span class="special">(</span>
-    <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</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="identifier">Iterator</span> <span class="identifier">next</span><span class="special">);</span>
-</pre>
-<p>
-                The <code class="computeroutput"><span class="identifier">ec</span></code> parameter
-                contains the result from the most recent connect operation. Before
-                the first connection attempt, <code class="computeroutput"><span class="identifier">ec</span></code>
-                is always set to indicate success. The <code class="computeroutput"><span class="identifier">next</span></code>
-                parameter is an iterator pointing to the next endpoint to be tried.
-                The function object should return the next iterator, but is permitted
-                to return a different iterator so that endpoints may be skipped.
-                The implementation guarantees that the function object will never
-                be called with the end iterator.
-              </p>
-</dd>
+<dt><span class="term">end</span></dt>
+<dd><p>
+                An iterator pointing to the end of 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"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">not_found</span></code>. Otherwise, contains
+                set to <code class="computeroutput">boost::asio::error::not_found</code>. Otherwise, contains
                 the error from the last connection attempt.
               </p></dd>
 </dl>
@@ -103,51 +83,18 @@
         </p>
 <h6>
 <a name="boost_asio.reference.connect.overload6.h2"></a>
-          <span class="phrase"><a name="boost_asio.reference.connect.overload6.remarks"></a></span><a class="link" href="overload6.html#boost_asio.reference.connect.overload6.remarks">Remarks</a>
-        </h6>
-<p>
-          This overload assumes that a default constructed object of type <code class="computeroutput"><span class="identifier">Iterator</span></code> represents the end of the sequence.
-          This is a valid assumption for iterator types such as <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">resolver</span><span class="special">::</span><span class="identifier">iterator</span></code>.
-        </p>
-<h6>
-<a name="boost_asio.reference.connect.overload6.h3"></a>
           <span class="phrase"><a name="boost_asio.reference.connect.overload6.example"></a></span><a class="link" href="overload6.html#boost_asio.reference.connect.overload6.example">Example</a>
         </h6>
-<p>
-          The following connect condition function object can be used to output information
-          about the individual connection attempts:
-        </p>
-<pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">my_connect_condition</span>
-<span class="special">{</span>
-  <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">&gt;</span>
-  <span class="identifier">Iterator</span> <span class="keyword">operator</span><span class="special">()(</span>
-      <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</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="identifier">Iterator</span> <span class="identifier">next</span><span class="special">)</span>
-  <span class="special">{</span>
-    <span class="keyword">if</span> <span class="special">(</span><span class="identifier">ec</span><span class="special">)</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"Error: "</span> <span class="special">&lt;&lt;</span> <span class="identifier">ec</span><span class="special">.</span><span class="identifier">message</span><span class="special">()</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
-    <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"Trying: "</span> <span class="special">&lt;&lt;</span> <span class="identifier">next</span><span class="special">-&gt;</span><span class="identifier">endpoint</span><span class="special">()</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
-    <span class="keyword">return</span> <span class="identifier">next</span><span class="special">;</span>
-  <span class="special">}</span>
-<span class="special">};</span>
-</pre>
-<p>
-          It would be used with the <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">connect</span></code>
-          function as follows:
-        </p>
-<pre class="programlisting"><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">resolver</span> <span class="identifier">r</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span>
-<span class="identifier">tcp</span><span class="special">::</span><span class="identifier">resolver</span><span class="special">::</span><span class="identifier">query</span> <span class="identifier">q</span><span class="special">(</span><span class="string">"host"</span><span class="special">,</span> <span class="string">"service"</span><span class="special">);</span>
-<span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span> <span class="identifier">s</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span>
-<span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">ec</span><span class="special">;</span>
-<span class="identifier">tcp</span><span class="special">::</span><span class="identifier">resolver</span><span class="special">::</span><span class="identifier">iterator</span> <span class="identifier">i</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">connect</span><span class="special">(</span>
-    <span class="identifier">s</span><span class="special">,</span> <span class="identifier">r</span><span class="special">.</span><span class="identifier">resolve</span><span class="special">(</span><span class="identifier">q</span><span class="special">),</span> <span class="identifier">my_connect_condition</span><span class="special">(),</span> <span class="identifier">ec</span><span class="special">);</span>
-<span class="keyword">if</span> <span class="special">(</span><span class="identifier">ec</span><span class="special">)</span>
-<span class="special">{</span>
-  <span class="comment">// An error occurred.</span>
-<span class="special">}</span>
-<span class="keyword">else</span>
-<span class="special">{</span>
-  <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"Connected to: "</span> <span class="special">&lt;&lt;</span> <span class="identifier">i</span><span class="special">-&gt;</span><span class="identifier">endpoint</span><span class="special">()</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
-<span class="special">}</span>
+<pre class="programlisting">tcp::resolver r(io_context);
+tcp::resolver::query q("host", "service");
+tcp::resolver::results_type e = r.resolve(q);
+tcp::socket s(io_context);
+boost::system::error_code ec;
+boost::asio::connect(s, e.begin(), e.end(), ec);
+if (ec)
+{
+  // An error occurred.
+}
 </pre>
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
author	DongHun Kwak <dh0128.kwak@samsung.com>	2019-12-05 15:11:01 +0900
committer	DongHun Kwak <dh0128.kwak@samsung.com>	2019-12-05 15:11:01 +0900
commit	3fdc3e5ee96dca5b11d1694975a65200787eab86 (patch)
tree	5c1733853892b8397d67706fa453a9bd978d2102 /doc/html/boost_asio/reference/connect/overload6.html
parent	88e602c57797660ebe0f9e15dbd64c1ff16dead3 (diff)
download	boost-3fdc3e5ee96dca5b11d1694975a65200787eab86.tar.gz boost-3fdc3e5ee96dca5b11d1694975a65200787eab86.tar.bz2 boost-3fdc3e5ee96dca5b11d1694975a65200787eab86.zip