diff options
| author | DongHun Kwak <dh0128.kwak@samsung.com> | 2016-10-06 10:38:45 +0900 |
|---|---|---|
| committer | DongHun Kwak <dh0128.kwak@samsung.com> | 2016-10-06 10:39:52 +0900 |
| commit | 5cde13f21d36c7224b0e13d11c4b49379ae5210d (patch) | |
| tree | e8269ac85a4b0f7d416e2565fa4f451b5cb41351 /doc/html/boost_asio/reference/connect/overload6.html | |
| parent | d9ec475d945d3035377a0d89ed42e382d8988891 (diff) | |
| download | boost-5cde13f21d36c7224b0e13d11c4b49379ae5210d.tar.gz boost-5cde13f21d36c7224b0e13d11c4b49379ae5210d.tar.bz2 boost-5cde13f21d36c7224b0e13d11c4b49379ae5210d.zip | |
Imported Upstream version 1.61.0
Change-Id: I96a1f878d1e6164f01e9aadd5147f38fca448d90
Signed-off-by: DongHun Kwak <dh0128.kwak@samsung.com>
Diffstat (limited to 'doc/html/boost_asio/reference/connect/overload6.html')
| -rw-r--r-- | doc/html/boost_asio/reference/connect/overload6.html | 167 |
1 files changed, 0 insertions, 167 deletions
diff --git a/doc/html/boost_asio/reference/connect/overload6.html b/doc/html/boost_asio/reference/connect/overload6.html deleted file mode 100644 index 974021f7c8..0000000000 --- a/doc/html/boost_asio/reference/connect/overload6.html +++ /dev/null @@ -1,167 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>connect (6 of 8 overloads)</title> -<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.78.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)"> -</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="overload5.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="overload7.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.overload6"></a><a class="link" href="overload6.html" title="connect (6 of 8 overloads)">connect (6 - of 8 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"><</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">></span> -<span class="identifier">Iterator</span> <span class="identifier">connect</span><span class="special">(</span> - <span class="identifier">basic_socket</span><span class="special"><</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">SocketService</span> <span class="special">></span> <span class="special">&</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">&</span> <span class="identifier">ec</span><span class="special">);</span> -</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. - </p> -<h6> -<a name="boost_asio.reference.connect.overload6.h0"></a> - <span class="phrase"><a name="boost_asio.reference.connect.overload6.parameters"></a></span><a class="link" href="overload6.html#boost_asio.reference.connect.overload6.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"><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">&</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">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 - the error from the last connection attempt. - </p></dd> -</dl> -</div> -<h6> -<a name="boost_asio.reference.connect.overload6.h1"></a> - <span class="phrase"><a name="boost_asio.reference.connect.overload6.return_value"></a></span><a class="link" href="overload6.html#boost_asio.reference.connect.overload6.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.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"><</span><span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">></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">&</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"><<</span> <span class="string">"Error: "</span> <span class="special"><<</span> <span class="identifier">ec</span><span class="special">.</span><span class="identifier">message</span><span class="special">()</span> <span class="special"><<</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"><<</span> <span class="string">"Trying: "</span> <span class="special"><<</span> <span class="identifier">next</span><span class="special">-></span><span class="identifier">endpoint</span><span class="special">()</span> <span class="special"><<</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"><<</span> <span class="string">"Connected to: "</span> <span class="special"><<</span> <span class="identifier">i</span><span class="special">-></span><span class="identifier">endpoint</span><span class="special">()</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> -<span class="special">}</span> -</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-2015 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="overload5.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="overload7.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> |