diff options
| author | DongHun Kwak <dh0128.kwak@samsung.com> | 2017-09-13 11:08:07 +0900 |
|---|---|---|
| committer | DongHun Kwak <dh0128.kwak@samsung.com> | 2017-09-13 11:09:00 +0900 |
| commit | b5c87084afaef42b2d058f68091be31988a6a874 (patch) | |
| tree | adef9a65870a41181687e11d57fdf98e7629de3c /doc/html/boost_asio/reference/connect | |
| parent | 34bd32e225e2a8a94104489b31c42e5801cc1f4a (diff) | |
| download | boost-b5c87084afaef42b2d058f68091be31988a6a874.tar.gz boost-b5c87084afaef42b2d058f68091be31988a6a874.tar.bz2 boost-b5c87084afaef42b2d058f68091be31988a6a874.zip | |
Imported Upstream version 1.64.0upstream/1.64.0
Change-Id: Id9212edd016dd55f21172c427aa7894d1d24148b
Signed-off-by: DongHun Kwak <dh0128.kwak@samsung.com>
Diffstat (limited to 'doc/html/boost_asio/reference/connect')
| -rw-r--r-- | doc/html/boost_asio/reference/connect/overload1.html | 118 | ||||
| -rw-r--r-- | doc/html/boost_asio/reference/connect/overload2.html | 116 | ||||
| -rw-r--r-- | doc/html/boost_asio/reference/connect/overload3.html | 116 | ||||
| -rw-r--r-- | doc/html/boost_asio/reference/connect/overload4.html | 114 | ||||
| -rw-r--r-- | doc/html/boost_asio/reference/connect/overload5.html | 165 | ||||
| -rw-r--r-- | doc/html/boost_asio/reference/connect/overload6.html | 166 | ||||
| -rw-r--r-- | doc/html/boost_asio/reference/connect/overload7.html | 162 | ||||
| -rw-r--r-- | doc/html/boost_asio/reference/connect/overload8.html | 163 |
8 files changed, 1120 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/connect/overload1.html b/doc/html/boost_asio/reference/connect/overload1.html new file mode 100644 index 0000000000..4d8c346282 --- /dev/null +++ b/doc/html/boost_asio/reference/connect/overload1.html @@ -0,0 +1,118 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>connect (1 of 8 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="../connect.html" title="connect"> +<link rel="next" href="overload2.html" title="connect (2 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="../connect.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="overload2.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.overload1"></a><a class="link" href="overload1.html" title="connect (1 of 8 overloads)">connect (1 + 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="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> +</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.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.connect.overload1.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> +</dl> +</div> +<h6> +<a name="boost_asio.reference.connect.overload1.h1"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.connect.overload1.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.overload1.h2"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.connect.overload1.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"><span class="identifier">error_code</span></code> is <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.overload1.h3"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.connect.overload1.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.overload1.h4"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.connect.overload1.example">Example</a> + </h6> +<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">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> +</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-2017 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="../connect.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="overload2.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/connect/overload2.html b/doc/html/boost_asio/reference/connect/overload2.html new file mode 100644 index 0000000000..42a9e4f806 --- /dev/null +++ b/doc/html/boost_asio/reference/connect/overload2.html @@ -0,0 +1,116 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>connect (2 of 8 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="overload1.html" title="connect (1 of 8 overloads)"> +<link rel="next" href="overload3.html" title="connect (3 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="overload1.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="overload3.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.overload2"></a><a class="link" href="overload2.html" title="connect (2 of 8 overloads)">connect (2 + 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="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">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.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.connect.overload2.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">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.overload2.h1"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.connect.overload2.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.overload2.h2"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.connect.overload2.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.overload2.h3"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.connect.overload2.example">Example</a> + </h6> +<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">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">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> +</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-2017 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="overload1.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="overload3.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/connect/overload3.html b/doc/html/boost_asio/reference/connect/overload3.html new file mode 100644 index 0000000000..7aa9b21001 --- /dev/null +++ b/doc/html/boost_asio/reference/connect/overload3.html @@ -0,0 +1,116 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>connect (3 of 8 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="overload2.html" title="connect (2 of 8 overloads)"> +<link rel="next" href="overload4.html" title="connect (4 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="overload2.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="overload4.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.overload3"></a><a class="link" href="overload3.html" title="connect (3 of 8 overloads)">connect (3 + 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="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">Iterator</span> <span class="identifier">end</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.overload3.h0"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.connect.overload3.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">end</span></dt> +<dd><p> + An iterator pointing to the end of a sequence of endpoints. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.connect.overload3.h1"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload3.return_value"></a></span><a class="link" href="overload3.html#boost_asio.reference.connect.overload3.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.overload3.h2"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload3.exceptions"></a></span><a class="link" href="overload3.html#boost_asio.reference.connect.overload3.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"><span class="identifier">error_code</span></code> is <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.overload3.h3"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload3.example"></a></span><a class="link" href="overload3.html#boost_asio.reference.connect.overload3.example">Example</a> + </h6> +<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">resolver</span><span class="special">::</span><span class="identifier">iterator</span> <span class="identifier">i</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">end</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">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">i</span><span class="special">,</span> <span class="identifier">end</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-2017 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="overload2.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="overload4.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/connect/overload4.html b/doc/html/boost_asio/reference/connect/overload4.html new file mode 100644 index 0000000000..afeb862b29 --- /dev/null +++ b/doc/html/boost_asio/reference/connect/overload4.html @@ -0,0 +1,114 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>connect (4 of 8 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="overload3.html" title="connect (3 of 8 overloads)"> +<link rel="next" href="overload5.html" title="connect (5 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="overload3.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="overload5.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.overload4"></a><a class="link" href="overload4.html" title="connect (4 of 8 overloads)">connect (4 + 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="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">Iterator</span> <span class="identifier">end</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.overload4.h0"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload4.parameters"></a></span><a class="link" href="overload4.html#boost_asio.reference.connect.overload4.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">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 + the error from the last connection attempt. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.connect.overload4.h1"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload4.return_value"></a></span><a class="link" href="overload4.html#boost_asio.reference.connect.overload4.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.overload4.h2"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload4.example"></a></span><a class="link" href="overload4.html#boost_asio.reference.connect.overload4.example">Example</a> + </h6> +<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">resolver</span><span class="special">::</span><span class="identifier">iterator</span> <span class="identifier">i</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">end</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">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">i</span><span class="special">,</span> <span class="identifier">end</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> +</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-2017 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="overload3.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="overload5.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/connect/overload5.html b/doc/html/boost_asio/reference/connect/overload5.html new file mode 100644 index 0000000000..d02cccd36c --- /dev/null +++ b/doc/html/boost_asio/reference/connect/overload5.html @@ -0,0 +1,165 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>connect (5 of 8 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="overload4.html" title="connect (4 of 8 overloads)"> +<link rel="next" href="overload6.html" title="connect (6 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="overload4.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="overload6.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.overload5"></a><a class="link" href="overload5.html" title="connect (5 of 8 overloads)">connect (5 + 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> +</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.overload5.h0"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload5.parameters"></a></span><a class="link" href="overload5.html#boost_asio.reference.connect.overload5.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> +</dl> +</div> +<h6> +<a name="boost_asio.reference.connect.overload5.h1"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload5.return_value"></a></span><a class="link" href="overload5.html#boost_asio.reference.connect.overload5.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.overload5.h2"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload5.exceptions"></a></span><a class="link" href="overload5.html#boost_asio.reference.connect.overload5.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"><span class="identifier">error_code</span></code> is <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.overload5.h3"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload5.remarks"></a></span><a class="link" href="overload5.html#boost_asio.reference.connect.overload5.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.overload5.h4"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload5.example"></a></span><a class="link" href="overload5.html#boost_asio.reference.connect.overload5.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">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">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> +</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-2017 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="overload4.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="overload6.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/connect/overload6.html b/doc/html/boost_asio/reference/connect/overload6.html new file mode 100644 index 0000000000..27b1f60941 --- /dev/null +++ b/doc/html/boost_asio/reference/connect/overload6.html @@ -0,0 +1,166 @@ +<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.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)"> +</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-2017 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> diff --git a/doc/html/boost_asio/reference/connect/overload7.html b/doc/html/boost_asio/reference/connect/overload7.html new file mode 100644 index 0000000000..7217a477ef --- /dev/null +++ b/doc/html/boost_asio/reference/connect/overload7.html @@ -0,0 +1,162 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>connect (7 of 8 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="overload6.html" title="connect (6 of 8 overloads)"> +<link rel="next" href="overload8.html" title="connect (8 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="overload6.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="overload8.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.overload7"></a><a class="link" href="overload7.html" title="connect (7 of 8 overloads)">connect (7 + 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">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> +</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.overload7.h0"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload7.parameters"></a></span><a class="link" href="overload7.html#boost_asio.reference.connect.overload7.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">end</span></dt> +<dd><p> + An iterator pointing to the end 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> +</dl> +</div> +<h6> +<a name="boost_asio.reference.connect.overload7.h1"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload7.return_value"></a></span><a class="link" href="overload7.html#boost_asio.reference.connect.overload7.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.overload7.h2"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload7.exceptions"></a></span><a class="link" href="overload7.html#boost_asio.reference.connect.overload7.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"><span class="identifier">error_code</span></code> is <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.overload7.h3"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload7.example"></a></span><a class="link" href="overload7.html#boost_asio.reference.connect.overload7.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">resolver</span><span class="special">::</span><span class="identifier">iterator</span> <span class="identifier">i</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">end</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">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">i</span><span class="special">,</span> <span class="identifier">end</span><span class="special">,</span> <span class="identifier">my_connect_condition</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> +</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-2017 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="overload6.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="overload8.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/connect/overload8.html b/doc/html/boost_asio/reference/connect/overload8.html new file mode 100644 index 0000000000..b0374eec3d --- /dev/null +++ b/doc/html/boost_asio/reference/connect/overload8.html @@ -0,0 +1,163 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>connect (8 of 8 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="overload7.html" title="connect (7 of 8 overloads)"> +<link rel="next" href="../const_buffer.html" title="const_buffer"> +</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="overload7.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="../const_buffer.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.overload8"></a><a class="link" href="overload8.html" title="connect (8 of 8 overloads)">connect (8 + 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">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">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.overload8.h0"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload8.parameters"></a></span><a class="link" href="overload8.html#boost_asio.reference.connect.overload8.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">end</span></dt> +<dd><p> + An iterator pointing to the end 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.overload8.h1"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload8.return_value"></a></span><a class="link" href="overload8.html#boost_asio.reference.connect.overload8.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.overload8.h2"></a> + <span class="phrase"><a name="boost_asio.reference.connect.overload8.example"></a></span><a class="link" href="overload8.html#boost_asio.reference.connect.overload8.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">resolver</span><span class="special">::</span><span class="identifier">iterator</span> <span class="identifier">i</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">end</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">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">i</span><span class="special">,</span> <span class="identifier">end</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-2017 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="overload7.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="../const_buffer.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |