diff options
Diffstat (limited to 'doc/html/boost_asio/reference/basic_socket')
101 files changed, 8355 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/basic_socket/_basic_socket.html b/doc/html/boost_asio/reference/basic_socket/_basic_socket.html new file mode 100755 index 0000000000..ab7e7bda56 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/_basic_socket.html @@ -0,0 +1,50 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::~basic_socket</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="shutdown_type.html" title="basic_socket::shutdown_type"> +<link rel="next" href="../basic_socket_acceptor.html" title="basic_socket_acceptor"> +</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="shutdown_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="../basic_socket_acceptor.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.basic_socket._basic_socket"></a><a class="link" href="_basic_socket.html" title="basic_socket::~basic_socket">basic_socket::~basic_socket</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1123528"></a> +Protected destructor to prevent deletion through + this type. + </p> +<pre class="programlisting"><span class="special">~</span><span class="identifier">basic_socket</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-2012 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="shutdown_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="../basic_socket_acceptor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/assign.html b/doc/html/boost_asio/reference/basic_socket/assign.html new file mode 100755 index 0000000000..3a786cca49 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/assign.html @@ -0,0 +1,58 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::assign</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="../basic_socket.html" title="basic_socket"> +<link rel="next" href="assign/overload1.html" title="basic_socket::assign (1 of 2 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="../basic_socket.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="assign/overload1.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.basic_socket.assign"></a><a class="link" href="assign.html" title="basic_socket::assign">basic_socket::assign</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1090731"></a> +Assign an existing native socket to the socket. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="assign/overload1.html" title="basic_socket::assign (1 of 2 overloads)">assign</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">protocol_type</span> <span class="special">&</span> <span class="identifier">protocol</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">native_socket</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="assign/overload1.html" title="basic_socket::assign (1 of 2 overloads)">more...</a></em></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> <a class="link" href="assign/overload2.html" title="basic_socket::assign (2 of 2 overloads)">assign</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">protocol_type</span> <span class="special">&</span> <span class="identifier">protocol</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">native_socket</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> + <span class="emphasis"><em>» <a class="link" href="assign/overload2.html" title="basic_socket::assign (2 of 2 overloads)">more...</a></em></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-2012 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="../basic_socket.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="assign/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/assign/overload1.html b/doc/html/boost_asio/reference/basic_socket/assign/overload1.html new file mode 100755 index 0000000000..62a4a55385 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/assign/overload1.html @@ -0,0 +1,51 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::assign (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../assign.html" title="basic_socket::assign"> +<link rel="prev" href="../assign.html" title="basic_socket::assign"> +<link rel="next" href="overload2.html" title="basic_socket::assign (2 of 2 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="../assign.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../assign.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.assign.overload1"></a><a class="link" href="overload1.html" title="basic_socket::assign (1 of 2 overloads)">basic_socket::assign + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Assign an existing native socket to the socket. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">assign</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">protocol_type</span> <span class="special">&</span> <span class="identifier">protocol</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">native_socket</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-2012 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="../assign.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../assign.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/basic_socket/assign/overload2.html b/doc/html/boost_asio/reference/basic_socket/assign/overload2.html new file mode 100755 index 0000000000..35933cf91b --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/assign/overload2.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::assign (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../assign.html" title="basic_socket::assign"> +<link rel="prev" href="overload1.html" title="basic_socket::assign (1 of 2 overloads)"> +<link rel="next" href="../async_connect.html" title="basic_socket::async_connect"> +</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="../assign.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="../async_connect.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.assign.overload2"></a><a class="link" href="overload2.html" title="basic_socket::assign (2 of 2 overloads)">basic_socket::assign + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Assign an existing native socket to the socket. + </p> +<pre class="programlisting"><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">assign</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">protocol_type</span> <span class="special">&</span> <span class="identifier">protocol</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">native_socket</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> +</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-2012 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="../assign.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="../async_connect.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/async_connect.html b/doc/html/boost_asio/reference/basic_socket/async_connect.html new file mode 100755 index 0000000000..07515b272b --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/async_connect.html @@ -0,0 +1,113 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::async_connect</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="assign/overload2.html" title="basic_socket::assign (2 of 2 overloads)"> +<link rel="next" href="at_mark.html" title="basic_socket::at_mark"> +</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="assign/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="at_mark.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.basic_socket.async_connect"></a><a class="link" href="async_connect.html" title="basic_socket::async_connect">basic_socket::async_connect</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1091241"></a> +Start an asynchronous connect. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../ConnectHandler.html" title="Connect handler requirements">ConnectHandler</a><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">async_connect</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">endpoint_type</span> <span class="special">&</span> <span class="identifier">peer_endpoint</span><span class="special">,</span> + <span class="identifier">ConnectHandler</span> <span class="identifier">handler</span><span class="special">);</span> +</pre> +<p> + This function is used to asynchronously connect a socket to the specified + remote endpoint. The function call always returns immediately. + </p> +<p> + The socket is automatically opened if it is not already open. If the connect + fails, and the socket was automatically opened, the socket is not returned + to the closed state. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.async_connect.h0"></a> + <span><a name="boost_asio.reference.basic_socket.async_connect.parameters"></a></span><a class="link" href="async_connect.html#boost_asio.reference.basic_socket.async_connect.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">peer_endpoint</span></dt> +<dd><p> + The remote endpoint to which the socket will be connected. Copies + will be made of the endpoint object as required. + </p></dd> +<dt><span class="term">handler</span></dt> +<dd> +<p> + The handler to be called when the connection operation completes. + Copies will be made of the handler as required. The function signature + of the handler must be: +</p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</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">error</span> <span class="comment">// Result of operation</span> +<span class="special">);</span> +</pre> +<p> + Regardless of whether the asynchronous operation completes immediately + or not, the handler will not be invoked from within this function. + Invocation of the handler will be performed in a manner equivalent + to using <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">post</span><span class="special">()</span></code>. + </p> +</dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.async_connect.h1"></a> + <span><a name="boost_asio.reference.basic_socket.async_connect.example"></a></span><a class="link" href="async_connect.html#boost_asio.reference.basic_socket.async_connect.example">Example</a> + </h6> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">connect_handler</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">error</span><span class="special">)</span> +<span class="special">{</span> + <span class="keyword">if</span> <span class="special">(!</span><span class="identifier">error</span><span class="special">)</span> + <span class="special">{</span> + <span class="comment">// Connect succeeded.</span> + <span class="special">}</span> +<span class="special">}</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span> <span class="identifier">socket</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">endpoint</span> <span class="identifier">endpoint</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">ip</span><span class="special">::</span><span class="identifier">address</span><span class="special">::</span><span class="identifier">from_string</span><span class="special">(</span><span class="string">"1.2.3.4"</span><span class="special">),</span> <span class="number">12345</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">async_connect</span><span class="special">(</span><span class="identifier">endpoint</span><span class="special">,</span> <span class="identifier">connect_handler</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-2012 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="assign/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="at_mark.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/at_mark.html b/doc/html/boost_asio/reference/basic_socket/at_mark.html new file mode 100755 index 0000000000..89127ff879 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/at_mark.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::at_mark</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="async_connect.html" title="basic_socket::async_connect"> +<link rel="next" href="at_mark/overload1.html" title="basic_socket::at_mark (1 of 2 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="async_connect.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="at_mark/overload1.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.basic_socket.at_mark"></a><a class="link" href="at_mark.html" title="basic_socket::at_mark">basic_socket::at_mark</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1091908"></a> +Determine whether the socket is at the out-of-band data + mark. + </p> +<pre class="programlisting"><span class="keyword">bool</span> <a class="link" href="at_mark/overload1.html" title="basic_socket::at_mark (1 of 2 overloads)">at_mark</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="at_mark/overload1.html" title="basic_socket::at_mark (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">bool</span> <a class="link" href="at_mark/overload2.html" title="basic_socket::at_mark (2 of 2 overloads)">at_mark</a><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> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="at_mark/overload2.html" title="basic_socket::at_mark (2 of 2 overloads)">more...</a></em></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-2012 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="async_connect.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="at_mark/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/at_mark/overload1.html b/doc/html/boost_asio/reference/basic_socket/at_mark/overload1.html new file mode 100755 index 0000000000..9aa1a6e59c --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/at_mark/overload1.html @@ -0,0 +1,74 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::at_mark (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../at_mark.html" title="basic_socket::at_mark"> +<link rel="prev" href="../at_mark.html" title="basic_socket::at_mark"> +<link rel="next" href="overload2.html" title="basic_socket::at_mark (2 of 2 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="../at_mark.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../at_mark.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.at_mark.overload1"></a><a class="link" href="overload1.html" title="basic_socket::at_mark (1 of 2 overloads)">basic_socket::at_mark + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Determine whether the socket is at the out-of-band data mark. + </p> +<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">at_mark</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function is used to check whether the socket input is currently + positioned at the out-of-band data mark. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.at_mark.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.at_mark.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.at_mark.overload1.return_value">Return + Value</a> + </h6> +<p> + A bool indicating whether the socket is at the out-of-band data mark. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.at_mark.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_socket.at_mark.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.at_mark.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</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-2012 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="../at_mark.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../at_mark.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/basic_socket/at_mark/overload2.html b/doc/html/boost_asio/reference/basic_socket/at_mark/overload2.html new file mode 100755 index 0000000000..d0a86c622f --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/at_mark/overload2.html @@ -0,0 +1,75 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::at_mark (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../at_mark.html" title="basic_socket::at_mark"> +<link rel="prev" href="overload1.html" title="basic_socket::at_mark (1 of 2 overloads)"> +<link rel="next" href="../available.html" title="basic_socket::available"> +</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="../at_mark.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="../available.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.at_mark.overload2"></a><a class="link" href="overload2.html" title="basic_socket::at_mark (2 of 2 overloads)">basic_socket::at_mark + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Determine whether the socket is at the out-of-band data mark. + </p> +<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">at_mark</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> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function is used to check whether the socket input is currently + positioned at the out-of-band data mark. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.at_mark.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.at_mark.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.at_mark.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.at_mark.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.at_mark.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.at_mark.overload2.return_value">Return + Value</a> + </h6> +<p> + A bool indicating whether the socket is at the out-of-band data mark. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="../at_mark.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="../available.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/available.html b/doc/html/boost_asio/reference/basic_socket/available.html new file mode 100755 index 0000000000..fe20322cdd --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/available.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::available</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="at_mark/overload2.html" title="basic_socket::at_mark (2 of 2 overloads)"> +<link rel="next" href="available/overload1.html" title="basic_socket::available (1 of 2 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="at_mark/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="available/overload1.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.basic_socket.available"></a><a class="link" href="available.html" title="basic_socket::available">basic_socket::available</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1092375"></a> +Determine the number of bytes available for reading. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="available/overload1.html" title="basic_socket::available (1 of 2 overloads)">available</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="available/overload1.html" title="basic_socket::available (1 of 2 overloads)">more...</a></em></span> + +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="available/overload2.html" title="basic_socket::available (2 of 2 overloads)">available</a><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> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="available/overload2.html" title="basic_socket::available (2 of 2 overloads)">more...</a></em></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-2012 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="at_mark/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="available/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/available/overload1.html b/doc/html/boost_asio/reference/basic_socket/available/overload1.html new file mode 100755 index 0000000000..f9d64459cd --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/available/overload1.html @@ -0,0 +1,75 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::available (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../available.html" title="basic_socket::available"> +<link rel="prev" href="../available.html" title="basic_socket::available"> +<link rel="next" href="overload2.html" title="basic_socket::available (2 of 2 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="../available.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../available.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.available.overload1"></a><a class="link" href="overload1.html" title="basic_socket::available (1 of 2 overloads)">basic_socket::available + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Determine the number of bytes available for reading. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">available</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function is used to determine the number of bytes that may be read + without blocking. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.available.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.available.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.available.overload1.return_value">Return + Value</a> + </h6> +<p> + The number of bytes that may be read without blocking, or 0 if an error + occurs. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.available.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_socket.available.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.available.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</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-2012 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="../available.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../available.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/basic_socket/available/overload2.html b/doc/html/boost_asio/reference/basic_socket/available/overload2.html new file mode 100755 index 0000000000..c82cf578b8 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/available/overload2.html @@ -0,0 +1,76 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::available (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../available.html" title="basic_socket::available"> +<link rel="prev" href="overload1.html" title="basic_socket::available (1 of 2 overloads)"> +<link rel="next" href="../basic_socket.html" title="basic_socket::basic_socket"> +</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="../available.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="../basic_socket.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.available.overload2"></a><a class="link" href="overload2.html" title="basic_socket::available (2 of 2 overloads)">basic_socket::available + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Determine the number of bytes available for reading. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">available</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> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function is used to determine the number of bytes that may be read + without blocking. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.available.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.available.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.available.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.available.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.available.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.available.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of bytes that may be read without blocking, or 0 if an error + occurs. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="../available.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="../basic_socket.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/basic_socket.html b/doc/html/boost_asio/reference/basic_socket/basic_socket.html new file mode 100755 index 0000000000..c6424c93cc --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/basic_socket.html @@ -0,0 +1,85 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::basic_socket</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="available/overload2.html" title="basic_socket::available (2 of 2 overloads)"> +<link rel="next" href="basic_socket/overload1.html" title="basic_socket::basic_socket (1 of 5 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="available/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="basic_socket/overload1.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.basic_socket.basic_socket"></a><a class="link" href="basic_socket.html" title="basic_socket::basic_socket">basic_socket::basic_socket</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1092881"></a> +Construct a <a class="link" href="../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a> without opening it. + </p> +<pre class="programlisting"><span class="keyword">explicit</span> <a class="link" href="basic_socket/overload1.html" title="basic_socket::basic_socket (1 of 5 overloads)">basic_socket</a><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">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="basic_socket/overload1.html" title="basic_socket::basic_socket (1 of 5 overloads)">more...</a></em></span> +</pre> +<p> + Construct and open a <a class="link" href="../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a>. + </p> +<pre class="programlisting"><a class="link" href="basic_socket/overload2.html" title="basic_socket::basic_socket (2 of 5 overloads)">basic_socket</a><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">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">protocol_type</span> <span class="special">&</span> <span class="identifier">protocol</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="basic_socket/overload2.html" title="basic_socket::basic_socket (2 of 5 overloads)">more...</a></em></span> +</pre> +<p> + Construct a <a class="link" href="../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a>, opening it and binding + it to the given local endpoint. + </p> +<pre class="programlisting"><a class="link" href="basic_socket/overload3.html" title="basic_socket::basic_socket (3 of 5 overloads)">basic_socket</a><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">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">endpoint_type</span> <span class="special">&</span> <span class="identifier">endpoint</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="basic_socket/overload3.html" title="basic_socket::basic_socket (3 of 5 overloads)">more...</a></em></span> +</pre> +<p> + Construct a <a class="link" href="../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a> on an existing native + socket. + </p> +<pre class="programlisting"><a class="link" href="basic_socket/overload4.html" title="basic_socket::basic_socket (4 of 5 overloads)">basic_socket</a><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">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">protocol_type</span> <span class="special">&</span> <span class="identifier">protocol</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">native_socket</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="basic_socket/overload4.html" title="basic_socket::basic_socket (4 of 5 overloads)">more...</a></em></span> +</pre> +<p> + Move-construct a <a class="link" href="../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a> from another. + </p> +<pre class="programlisting"><a class="link" href="basic_socket/overload5.html" title="basic_socket::basic_socket (5 of 5 overloads)">basic_socket</a><span class="special">(</span> + <span class="identifier">basic_socket</span> <span class="special">&&</span> <span class="identifier">other</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="basic_socket/overload5.html" title="basic_socket::basic_socket (5 of 5 overloads)">more...</a></em></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-2012 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="available/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="basic_socket/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/basic_socket/overload1.html b/doc/html/boost_asio/reference/basic_socket/basic_socket/overload1.html new file mode 100755 index 0000000000..4601921c55 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/basic_socket/overload1.html @@ -0,0 +1,69 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::basic_socket (1 of 5 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket::basic_socket"> +<link rel="prev" href="../basic_socket.html" title="basic_socket::basic_socket"> +<link rel="next" href="overload2.html" title="basic_socket::basic_socket (2 of 5 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="../basic_socket.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.basic_socket.overload1"></a><a class="link" href="overload1.html" title="basic_socket::basic_socket (1 of 5 overloads)">basic_socket::basic_socket + (1 of 5 overloads)</a> +</h5></div></div></div> +<p> + Construct a <a class="link" href="../../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a> without opening + it. + </p> +<pre class="programlisting"><span class="identifier">basic_socket</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">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">);</span> +</pre> +<p> + This constructor creates a socket without opening it. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.basic_socket.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.basic_socket.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.basic_socket.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">io_service</span></dt> +<dd><p> + The <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that + the socket will use to dispatch handlers for any asynchronous operations + performed on the socket. + </p></dd> +</dl> +</div> +</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-2012 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="../basic_socket.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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/basic_socket/basic_socket/overload2.html b/doc/html/boost_asio/reference/basic_socket/basic_socket/overload2.html new file mode 100755 index 0000000000..5ce54de7f3 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/basic_socket/overload2.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::basic_socket (2 of 5 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket::basic_socket"> +<link rel="prev" href="overload1.html" title="basic_socket::basic_socket (1 of 5 overloads)"> +<link rel="next" href="overload3.html" title="basic_socket::basic_socket (3 of 5 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="../basic_socket.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.basic_socket.overload2"></a><a class="link" href="overload2.html" title="basic_socket::basic_socket (2 of 5 overloads)">basic_socket::basic_socket + (2 of 5 overloads)</a> +</h5></div></div></div> +<p> + Construct and open a <a class="link" href="../../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a>. + </p> +<pre class="programlisting"><span class="identifier">basic_socket</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">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">protocol_type</span> <span class="special">&</span> <span class="identifier">protocol</span><span class="special">);</span> +</pre> +<p> + This constructor creates and opens a socket. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.basic_socket.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.basic_socket.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.basic_socket.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">io_service</span></dt> +<dd><p> + The <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that + the socket will use to dispatch handlers for any asynchronous operations + performed on the socket. + </p></dd> +<dt><span class="term">protocol</span></dt> +<dd><p> + An object specifying protocol parameters to be used. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.basic_socket.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.basic_socket.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.basic_socket.overload2.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</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-2012 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="../basic_socket.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/basic_socket/basic_socket/overload3.html b/doc/html/boost_asio/reference/basic_socket/basic_socket/overload3.html new file mode 100755 index 0000000000..fe7c7dcc6f --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/basic_socket/overload3.html @@ -0,0 +1,89 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::basic_socket (3 of 5 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket::basic_socket"> +<link rel="prev" href="overload2.html" title="basic_socket::basic_socket (2 of 5 overloads)"> +<link rel="next" href="overload4.html" title="basic_socket::basic_socket (4 of 5 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="../basic_socket.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.basic_socket.overload3"></a><a class="link" href="overload3.html" title="basic_socket::basic_socket (3 of 5 overloads)">basic_socket::basic_socket + (3 of 5 overloads)</a> +</h5></div></div></div> +<p> + Construct a <a class="link" href="../../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a>, opening it and + binding it to the given local endpoint. + </p> +<pre class="programlisting"><span class="identifier">basic_socket</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">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">endpoint_type</span> <span class="special">&</span> <span class="identifier">endpoint</span><span class="special">);</span> +</pre> +<p> + This constructor creates a socket and automatically opens it bound to + the specified endpoint on the local machine. The protocol used is the + protocol associated with the given endpoint. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.basic_socket.overload3.h0"></a> + <span><a name="boost_asio.reference.basic_socket.basic_socket.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_socket.basic_socket.overload3.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">io_service</span></dt> +<dd><p> + The <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that + the socket will use to dispatch handlers for any asynchronous operations + performed on the socket. + </p></dd> +<dt><span class="term">endpoint</span></dt> +<dd><p> + An endpoint on the local machine to which the socket will be bound. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.basic_socket.overload3.h1"></a> + <span><a name="boost_asio.reference.basic_socket.basic_socket.overload3.exceptions"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_socket.basic_socket.overload3.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</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-2012 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="../basic_socket.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/basic_socket/basic_socket/overload4.html b/doc/html/boost_asio/reference/basic_socket/basic_socket/overload4.html new file mode 100755 index 0000000000..8ef7cf7d0b --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/basic_socket/overload4.html @@ -0,0 +1,92 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::basic_socket (4 of 5 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket::basic_socket"> +<link rel="prev" href="overload3.html" title="basic_socket::basic_socket (3 of 5 overloads)"> +<link rel="next" href="overload5.html" title="basic_socket::basic_socket (5 of 5 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="../basic_socket.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.basic_socket.overload4"></a><a class="link" href="overload4.html" title="basic_socket::basic_socket (4 of 5 overloads)">basic_socket::basic_socket + (4 of 5 overloads)</a> +</h5></div></div></div> +<p> + Construct a <a class="link" href="../../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a> on an existing + native socket. + </p> +<pre class="programlisting"><span class="identifier">basic_socket</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">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">protocol_type</span> <span class="special">&</span> <span class="identifier">protocol</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">native_socket</span><span class="special">);</span> +</pre> +<p> + This constructor creates a socket object to hold an existing native socket. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.basic_socket.overload4.h0"></a> + <span><a name="boost_asio.reference.basic_socket.basic_socket.overload4.parameters"></a></span><a class="link" href="overload4.html#boost_asio.reference.basic_socket.basic_socket.overload4.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">io_service</span></dt> +<dd><p> + The <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that + the socket will use to dispatch handlers for any asynchronous operations + performed on the socket. + </p></dd> +<dt><span class="term">protocol</span></dt> +<dd><p> + An object specifying protocol parameters to be used. + </p></dd> +<dt><span class="term">native_socket</span></dt> +<dd><p> + A native socket. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.basic_socket.overload4.h1"></a> + <span><a name="boost_asio.reference.basic_socket.basic_socket.overload4.exceptions"></a></span><a class="link" href="overload4.html#boost_asio.reference.basic_socket.basic_socket.overload4.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +</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-2012 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="../basic_socket.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/basic_socket/basic_socket/overload5.html b/doc/html/boost_asio/reference/basic_socket/basic_socket/overload5.html new file mode 100755 index 0000000000..ab8d266f13 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/basic_socket/overload5.html @@ -0,0 +1,75 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::basic_socket (5 of 5 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket::basic_socket"> +<link rel="prev" href="overload4.html" title="basic_socket::basic_socket (4 of 5 overloads)"> +<link rel="next" href="../bind.html" title="basic_socket::bind"> +</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="../basic_socket.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="../bind.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.basic_socket.overload5"></a><a class="link" href="overload5.html" title="basic_socket::basic_socket (5 of 5 overloads)">basic_socket::basic_socket + (5 of 5 overloads)</a> +</h5></div></div></div> +<p> + Move-construct a <a class="link" href="../../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a> from another. + </p> +<pre class="programlisting"><span class="identifier">basic_socket</span><span class="special">(</span> + <span class="identifier">basic_socket</span> <span class="special">&&</span> <span class="identifier">other</span><span class="special">);</span> +</pre> +<p> + This constructor moves a socket from one object to another. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.basic_socket.overload5.h0"></a> + <span><a name="boost_asio.reference.basic_socket.basic_socket.overload5.parameters"></a></span><a class="link" href="overload5.html#boost_asio.reference.basic_socket.basic_socket.overload5.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">other</span></dt> +<dd><p> + The other <a class="link" href="../../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a> object from + which the move will occur. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.basic_socket.overload5.h1"></a> + <span><a name="boost_asio.reference.basic_socket.basic_socket.overload5.remarks"></a></span><a class="link" href="overload5.html#boost_asio.reference.basic_socket.basic_socket.overload5.remarks">Remarks</a> + </h6> +<p> + Following the move, the moved-from object is in the same state as if + constructed using the <code class="computeroutput"><span class="identifier">basic_socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">&)</span> <span class="identifier">constructor</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="../basic_socket.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="../bind.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/bind.html b/doc/html/boost_asio/reference/basic_socket/bind.html new file mode 100755 index 0000000000..adb670805b --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/bind.html @@ -0,0 +1,56 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::bind</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="basic_socket/overload5.html" title="basic_socket::basic_socket (5 of 5 overloads)"> +<link rel="next" href="bind/overload1.html" title="basic_socket::bind (1 of 2 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="basic_socket/overload5.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="bind/overload1.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.basic_socket.bind"></a><a class="link" href="bind.html" title="basic_socket::bind">basic_socket::bind</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1094604"></a> +Bind the socket to the given local endpoint. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="bind/overload1.html" title="basic_socket::bind (1 of 2 overloads)">bind</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">endpoint_type</span> <span class="special">&</span> <span class="identifier">endpoint</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="bind/overload1.html" title="basic_socket::bind (1 of 2 overloads)">more...</a></em></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> <a class="link" href="bind/overload2.html" title="basic_socket::bind (2 of 2 overloads)">bind</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">endpoint_type</span> <span class="special">&</span> <span class="identifier">endpoint</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> + <span class="emphasis"><em>» <a class="link" href="bind/overload2.html" title="basic_socket::bind (2 of 2 overloads)">more...</a></em></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-2012 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="basic_socket/overload5.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="bind/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/bind/overload1.html b/doc/html/boost_asio/reference/basic_socket/bind/overload1.html new file mode 100755 index 0000000000..45d4eaa14f --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/bind/overload1.html @@ -0,0 +1,89 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::bind (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../bind.html" title="basic_socket::bind"> +<link rel="prev" href="../bind.html" title="basic_socket::bind"> +<link rel="next" href="overload2.html" title="basic_socket::bind (2 of 2 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="../bind.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../bind.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.bind.overload1"></a><a class="link" href="overload1.html" title="basic_socket::bind (1 of 2 overloads)">basic_socket::bind + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Bind the socket to the given local endpoint. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">bind</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">endpoint_type</span> <span class="special">&</span> <span class="identifier">endpoint</span><span class="special">);</span> +</pre> +<p> + This function binds the socket to the specified endpoint on the local + machine. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.bind.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.bind.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.bind.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">endpoint</span></dt> +<dd><p> + An endpoint on the local machine to which the socket will be bound. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.bind.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_socket.bind.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.bind.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.bind.overload1.h2"></a> + <span><a name="boost_asio.reference.basic_socket.bind.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.bind.overload1.example">Example</a> + </h6> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">open</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">v4</span><span class="special">());</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">bind</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">endpoint</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">v4</span><span class="special">(),</span> <span class="number">12345</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-2012 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="../bind.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../bind.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/basic_socket/bind/overload2.html b/doc/html/boost_asio/reference/basic_socket/bind/overload2.html new file mode 100755 index 0000000000..7094ec07bb --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/bind/overload2.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::bind (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../bind.html" title="basic_socket::bind"> +<link rel="prev" href="overload1.html" title="basic_socket::bind (1 of 2 overloads)"> +<link rel="next" href="../broadcast.html" title="basic_socket::broadcast"> +</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="../bind.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="../broadcast.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.bind.overload2"></a><a class="link" href="overload2.html" title="basic_socket::bind (2 of 2 overloads)">basic_socket::bind + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Bind the socket to the given local endpoint. + </p> +<pre class="programlisting"><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">bind</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">endpoint_type</span> <span class="special">&</span> <span class="identifier">endpoint</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 binds the socket to the specified endpoint on the local + machine. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.bind.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.bind.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.bind.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">endpoint</span></dt> +<dd><p> + An endpoint on the local machine to which the socket will be bound. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.bind.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.bind.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.bind.overload2.example">Example</a> + </h6> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">open</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">v4</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">socket</span><span class="special">.</span><span class="identifier">bind</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">endpoint</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">v4</span><span class="special">(),</span> <span class="number">12345</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-2012 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="../bind.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="../broadcast.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/broadcast.html b/doc/html/boost_asio/reference/basic_socket/broadcast.html new file mode 100755 index 0000000000..6495bbb88d --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/broadcast.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::broadcast</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="bind/overload2.html" title="basic_socket::bind (2 of 2 overloads)"> +<link rel="next" href="bytes_readable.html" title="basic_socket::bytes_readable"> +</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="bind/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="bytes_readable.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.basic_socket.broadcast"></a><a class="link" href="broadcast.html" title="basic_socket::broadcast">basic_socket::broadcast</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1095790"></a> +Socket option to permit sending of broadcast messages. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">broadcast</span><span class="special">;</span> +</pre> +<p> + Implements the SOL_SOCKET/SO_BROADCAST socket option. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.broadcast.h0"></a> + <span><a name="boost_asio.reference.basic_socket.broadcast.examples"></a></span><a class="link" href="broadcast.html#boost_asio.reference.basic_socket.broadcast.examples">Examples</a> + </h6> +<p> + Setting the option: + </p> +<pre class="programlisting"><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">udp</span><span class="special">::</span><span class="identifier">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">broadcast</span> <span class="identifier">option</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +</pre> +<p> + Getting the current option value: + </p> +<pre class="programlisting"><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">udp</span><span class="special">::</span><span class="identifier">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">broadcast</span> <span class="identifier">option</span><span class="special">;</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +<span class="keyword">bool</span> <span class="identifier">is_set</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">value</span><span class="special">();</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.broadcast.h1"></a> + <span><a name="boost_asio.reference.basic_socket.broadcast.requirements"></a></span><a class="link" href="broadcast.html#boost_asio.reference.basic_socket.broadcast.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="bind/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="bytes_readable.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/bytes_readable.html b/doc/html/boost_asio/reference/basic_socket/bytes_readable.html new file mode 100755 index 0000000000..da51a61137 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/bytes_readable.html @@ -0,0 +1,76 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::bytes_readable</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="broadcast.html" title="basic_socket::broadcast"> +<link rel="next" href="cancel.html" title="basic_socket::cancel"> +</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="broadcast.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="cancel.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.basic_socket.bytes_readable"></a><a class="link" href="bytes_readable.html" title="basic_socket::bytes_readable">basic_socket::bytes_readable</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1096269"></a> +IO control command to get the amount of data + that can be read without blocking. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">bytes_readable</span><span class="special">;</span> +</pre> +<p> + Implements the FIONREAD IO control command. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.bytes_readable.h0"></a> + <span><a name="boost_asio.reference.basic_socket.bytes_readable.example"></a></span><a class="link" href="bytes_readable.html#boost_asio.reference.basic_socket.bytes_readable.example">Example</a> + </h6> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">bytes_readable</span> <span class="identifier">command</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">io_control</span><span class="special">(</span><span class="identifier">command</span><span class="special">);</span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_readable</span> <span class="special">=</span> <span class="identifier">command</span><span class="special">.</span><span class="identifier">get</span><span class="special">();</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.bytes_readable.h1"></a> + <span><a name="boost_asio.reference.basic_socket.bytes_readable.requirements"></a></span><a class="link" href="bytes_readable.html#boost_asio.reference.basic_socket.bytes_readable.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="broadcast.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="cancel.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/cancel.html b/doc/html/boost_asio/reference/basic_socket/cancel.html new file mode 100755 index 0000000000..c898a02a47 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/cancel.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::cancel</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="bytes_readable.html" title="basic_socket::bytes_readable"> +<link rel="next" href="cancel/overload1.html" title="basic_socket::cancel (1 of 2 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="bytes_readable.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="cancel/overload1.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.basic_socket.cancel"></a><a class="link" href="cancel.html" title="basic_socket::cancel">basic_socket::cancel</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1096602"></a> +Cancel all asynchronous operations associated with the + socket. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="cancel/overload1.html" title="basic_socket::cancel (1 of 2 overloads)">cancel</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="cancel/overload1.html" title="basic_socket::cancel (1 of 2 overloads)">more...</a></em></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> <a class="link" href="cancel/overload2.html" title="basic_socket::cancel (2 of 2 overloads)">cancel</a><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> + <span class="emphasis"><em>» <a class="link" href="cancel/overload2.html" title="basic_socket::cancel (2 of 2 overloads)">more...</a></em></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-2012 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="bytes_readable.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="cancel/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/cancel/overload1.html b/doc/html/boost_asio/reference/basic_socket/cancel/overload1.html new file mode 100755 index 0000000000..371f70ac05 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/cancel/overload1.html @@ -0,0 +1,110 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::cancel (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../cancel.html" title="basic_socket::cancel"> +<link rel="prev" href="../cancel.html" title="basic_socket::cancel"> +<link rel="next" href="overload2.html" title="basic_socket::cancel (2 of 2 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="../cancel.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.cancel.overload1"></a><a class="link" href="overload1.html" title="basic_socket::cancel (1 of 2 overloads)">basic_socket::cancel + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Cancel all asynchronous operations associated with the socket. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">cancel</span><span class="special">();</span> +</pre> +<p> + This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed 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">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> + error. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.cancel.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.cancel.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.cancel.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.cancel.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_socket.cancel.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.cancel.overload1.remarks">Remarks</a> + </h6> +<p> + Calls to <code class="computeroutput"><span class="identifier">cancel</span><span class="special">()</span></code> + will always fail with <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">operation_not_supported</span></code> + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless BOOST_ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + It will only cancel asynchronous operations that were initiated in + the current thread. + </li> +<li class="listitem"> + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. + </li> +</ul></div> +<p> + For portable cancellation, consider using one of the following alternatives: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + Disable asio's I/O completion port backend by defining BOOST_ASIO_DISABLE_IOCP. + </li> +<li class="listitem"> + Use the <code class="computeroutput"><span class="identifier">close</span><span class="special">()</span></code> + function to simultaneously cancel the outstanding operations and + close the socket. + </li> +</ul></div> +<p> + When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="../cancel.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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/basic_socket/cancel/overload2.html b/doc/html/boost_asio/reference/basic_socket/cancel/overload2.html new file mode 100755 index 0000000000..4efb1d1c03 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/cancel/overload2.html @@ -0,0 +1,111 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::cancel (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../cancel.html" title="basic_socket::cancel"> +<link rel="prev" href="overload1.html" title="basic_socket::cancel (1 of 2 overloads)"> +<link rel="next" href="../close.html" title="basic_socket::close"> +</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="../cancel.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="../close.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.cancel.overload2"></a><a class="link" href="overload2.html" title="basic_socket::cancel (2 of 2 overloads)">basic_socket::cancel + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Cancel all asynchronous operations associated with the socket. + </p> +<pre class="programlisting"><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">cancel</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 causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed 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">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> + error. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.cancel.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.cancel.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.cancel.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.cancel.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.cancel.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.cancel.overload2.remarks">Remarks</a> + </h6> +<p> + Calls to <code class="computeroutput"><span class="identifier">cancel</span><span class="special">()</span></code> + will always fail with <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">operation_not_supported</span></code> + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless BOOST_ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + It will only cancel asynchronous operations that were initiated in + the current thread. + </li> +<li class="listitem"> + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. + </li> +</ul></div> +<p> + For portable cancellation, consider using one of the following alternatives: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + Disable asio's I/O completion port backend by defining BOOST_ASIO_DISABLE_IOCP. + </li> +<li class="listitem"> + Use the <code class="computeroutput"><span class="identifier">close</span><span class="special">()</span></code> + function to simultaneously cancel the outstanding operations and + close the socket. + </li> +</ul></div> +<p> + When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="../cancel.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="../close.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/close.html b/doc/html/boost_asio/reference/basic_socket/close.html new file mode 100755 index 0000000000..0db62a23a7 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/close.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::close</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="cancel/overload2.html" title="basic_socket::cancel (2 of 2 overloads)"> +<link rel="next" href="close/overload1.html" title="basic_socket::close (1 of 2 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="cancel/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="close/overload1.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.basic_socket.close"></a><a class="link" href="close.html" title="basic_socket::close">basic_socket::close</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1097396"></a> +Close the socket. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="close/overload1.html" title="basic_socket::close (1 of 2 overloads)">close</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="close/overload1.html" title="basic_socket::close (1 of 2 overloads)">more...</a></em></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> <a class="link" href="close/overload2.html" title="basic_socket::close (2 of 2 overloads)">close</a><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> + <span class="emphasis"><em>» <a class="link" href="close/overload2.html" title="basic_socket::close (2 of 2 overloads)">more...</a></em></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-2012 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="cancel/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="close/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/close/overload1.html b/doc/html/boost_asio/reference/basic_socket/close/overload1.html new file mode 100755 index 0000000000..96c3079df9 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/close/overload1.html @@ -0,0 +1,76 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::close (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../close.html" title="basic_socket::close"> +<link rel="prev" href="../close.html" title="basic_socket::close"> +<link rel="next" href="overload2.html" title="basic_socket::close (2 of 2 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="../close.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../close.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.close.overload1"></a><a class="link" href="overload1.html" title="basic_socket::close (1 of 2 overloads)">basic_socket::close + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Close the socket. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">close</span><span class="special">();</span> +</pre> +<p> + This function is used to close the socket. Any asynchronous send, receive + or connect operations will be cancelled immediately, and will complete + 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">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> error. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.close.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.close.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.close.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. Note that, even if the function indicates an + error, the underlying descriptor is closed. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.close.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_socket.close.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.close.overload1.remarks">Remarks</a> + </h6> +<p> + For portable behaviour with respect to graceful closure of a connected + socket, call <code class="computeroutput"><span class="identifier">shutdown</span><span class="special">()</span></code> before closing the socket. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="../close.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../close.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/basic_socket/close/overload2.html b/doc/html/boost_asio/reference/basic_socket/close/overload2.html new file mode 100755 index 0000000000..f92533a98d --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/close/overload2.html @@ -0,0 +1,90 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::close (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../close.html" title="basic_socket::close"> +<link rel="prev" href="overload1.html" title="basic_socket::close (1 of 2 overloads)"> +<link rel="next" href="../connect.html" title="basic_socket::connect"> +</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="../close.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="../connect.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.close.overload2"></a><a class="link" href="overload2.html" title="basic_socket::close (2 of 2 overloads)">basic_socket::close + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Close the socket. + </p> +<pre class="programlisting"><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">close</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 is used to close the socket. Any asynchronous send, receive + or connect operations will be cancelled immediately, and will complete + 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">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> error. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.close.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.close.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.close.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. Note that, even if + the function indicates an error, the underlying descriptor is closed. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.close.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.close.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.close.overload2.example">Example</a> + </h6> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket</span><span class="special">.</span><span class="identifier">close</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> +<h6> +<a name="boost_asio.reference.basic_socket.close.overload2.h2"></a> + <span><a name="boost_asio.reference.basic_socket.close.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.close.overload2.remarks">Remarks</a> + </h6> +<p> + For portable behaviour with respect to graceful closure of a connected + socket, call <code class="computeroutput"><span class="identifier">shutdown</span><span class="special">()</span></code> before closing the socket. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="../close.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="../connect.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/connect.html b/doc/html/boost_asio/reference/basic_socket/connect.html new file mode 100755 index 0000000000..cbedf12935 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/connect.html @@ -0,0 +1,56 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::connect</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="close/overload2.html" title="basic_socket::close (2 of 2 overloads)"> +<link rel="next" href="connect/overload1.html" title="basic_socket::connect (1 of 2 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="close/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="connect/overload1.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.basic_socket.connect"></a><a class="link" href="connect.html" title="basic_socket::connect">basic_socket::connect</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1098157"></a> +Connect the socket to the specified endpoint. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="connect/overload1.html" title="basic_socket::connect (1 of 2 overloads)">connect</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">endpoint_type</span> <span class="special">&</span> <span class="identifier">peer_endpoint</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="connect/overload1.html" title="basic_socket::connect (1 of 2 overloads)">more...</a></em></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> <a class="link" href="connect/overload2.html" title="basic_socket::connect (2 of 2 overloads)">connect</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">endpoint_type</span> <span class="special">&</span> <span class="identifier">peer_endpoint</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> + <span class="emphasis"><em>» <a class="link" href="connect/overload2.html" title="basic_socket::connect (2 of 2 overloads)">more...</a></em></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-2012 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="close/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="connect/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/connect/overload1.html b/doc/html/boost_asio/reference/basic_socket/connect/overload1.html new file mode 100755 index 0000000000..08eb29309d --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/connect/overload1.html @@ -0,0 +1,95 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::connect (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../connect.html" title="basic_socket::connect"> +<link rel="prev" href="../connect.html" title="basic_socket::connect"> +<link rel="next" href="overload2.html" title="basic_socket::connect (2 of 2 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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.connect.overload1"></a><a class="link" href="overload1.html" title="basic_socket::connect (1 of 2 overloads)">basic_socket::connect + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Connect the socket to the specified endpoint. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">connect</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">endpoint_type</span> <span class="special">&</span> <span class="identifier">peer_endpoint</span><span class="special">);</span> +</pre> +<p> + This function is used to connect a socket to the specified remote endpoint. + The function call will block until the connection is successfully made + or an error occurs. + </p> +<p> + The socket is automatically opened if it is not already open. If the + connect fails, and the socket was automatically opened, the socket is + not returned to the closed state. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.connect.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.connect.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.connect.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">peer_endpoint</span></dt> +<dd><p> + The remote endpoint to which the socket will be connected. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.connect.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_socket.connect.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.connect.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.connect.overload1.h2"></a> + <span><a name="boost_asio.reference.basic_socket.connect.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.connect.overload1.example">Example</a> + </h6> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">endpoint</span> <span class="identifier">endpoint</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">ip</span><span class="special">::</span><span class="identifier">address</span><span class="special">::</span><span class="identifier">from_string</span><span class="special">(</span><span class="string">"1.2.3.4"</span><span class="special">),</span> <span class="number">12345</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">connect</span><span class="special">(</span><span class="identifier">endpoint</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-2012 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/basic_socket/connect/overload2.html b/doc/html/boost_asio/reference/basic_socket/connect/overload2.html new file mode 100755 index 0000000000..142ddbaad8 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/connect/overload2.html @@ -0,0 +1,92 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::connect (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../connect.html" title="basic_socket::connect"> +<link rel="prev" href="overload1.html" title="basic_socket::connect (1 of 2 overloads)"> +<link rel="next" href="../debug.html" title="basic_socket::debug"> +</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="../debug.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.connect.overload2"></a><a class="link" href="overload2.html" title="basic_socket::connect (2 of 2 overloads)">basic_socket::connect + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Connect the socket to the specified endpoint. + </p> +<pre class="programlisting"><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">connect</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">endpoint_type</span> <span class="special">&</span> <span class="identifier">peer_endpoint</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 is used to connect a socket to the specified remote endpoint. + The function call will block until the connection is successfully made + or an error occurs. + </p> +<p> + The socket is automatically opened if it is not already open. If the + connect fails, and the socket was automatically opened, the socket is + not returned to the closed state. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.connect.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.connect.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.connect.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">peer_endpoint</span></dt> +<dd><p> + The remote endpoint to which the socket will be connected. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.connect.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.connect.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.connect.overload2.example">Example</a> + </h6> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">endpoint</span> <span class="identifier">endpoint</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">ip</span><span class="special">::</span><span class="identifier">address</span><span class="special">::</span><span class="identifier">from_string</span><span class="special">(</span><span class="string">"1.2.3.4"</span><span class="special">),</span> <span class="number">12345</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">socket</span><span class="special">.</span><span class="identifier">connect</span><span class="special">(</span><span class="identifier">endpoint</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-2012 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="../debug.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/debug.html b/doc/html/boost_asio/reference/basic_socket/debug.html new file mode 100755 index 0000000000..1dcd7e550c --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/debug.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::debug</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="connect/overload2.html" title="basic_socket::connect (2 of 2 overloads)"> +<link rel="next" href="do_not_route.html" title="basic_socket::do_not_route"> +</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/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="do_not_route.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.basic_socket.debug"></a><a class="link" href="debug.html" title="basic_socket::debug">basic_socket::debug</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1099289"></a> +Socket option to enable socket-level debugging. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">debug</span><span class="special">;</span> +</pre> +<p> + Implements the SOL_SOCKET/SO_DEBUG socket option. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.debug.h0"></a> + <span><a name="boost_asio.reference.basic_socket.debug.examples"></a></span><a class="link" href="debug.html#boost_asio.reference.basic_socket.debug.examples">Examples</a> + </h6> +<p> + Setting the option: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">debug</span> <span class="identifier">option</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +</pre> +<p> + Getting the current option value: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">debug</span> <span class="identifier">option</span><span class="special">;</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +<span class="keyword">bool</span> <span class="identifier">is_set</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">value</span><span class="special">();</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.debug.h1"></a> + <span><a name="boost_asio.reference.basic_socket.debug.requirements"></a></span><a class="link" href="debug.html#boost_asio.reference.basic_socket.debug.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="do_not_route.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/do_not_route.html b/doc/html/boost_asio/reference/basic_socket/do_not_route.html new file mode 100755 index 0000000000..722cb711ee --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/do_not_route.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::do_not_route</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="debug.html" title="basic_socket::debug"> +<link rel="next" href="enable_connection_aborted.html" title="basic_socket::enable_connection_aborted"> +</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="debug.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="enable_connection_aborted.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.basic_socket.do_not_route"></a><a class="link" href="do_not_route.html" title="basic_socket::do_not_route">basic_socket::do_not_route</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1099768"></a> +Socket option to prevent routing, use local interfaces + only. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">do_not_route</span><span class="special">;</span> +</pre> +<p> + Implements the SOL_SOCKET/SO_DONTROUTE socket option. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.do_not_route.h0"></a> + <span><a name="boost_asio.reference.basic_socket.do_not_route.examples"></a></span><a class="link" href="do_not_route.html#boost_asio.reference.basic_socket.do_not_route.examples">Examples</a> + </h6> +<p> + Setting the option: + </p> +<pre class="programlisting"><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">udp</span><span class="special">::</span><span class="identifier">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">do_not_route</span> <span class="identifier">option</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +</pre> +<p> + Getting the current option value: + </p> +<pre class="programlisting"><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">udp</span><span class="special">::</span><span class="identifier">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">do_not_route</span> <span class="identifier">option</span><span class="special">;</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +<span class="keyword">bool</span> <span class="identifier">is_set</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">value</span><span class="special">();</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.do_not_route.h1"></a> + <span><a name="boost_asio.reference.basic_socket.do_not_route.requirements"></a></span><a class="link" href="do_not_route.html#boost_asio.reference.basic_socket.do_not_route.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="debug.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="enable_connection_aborted.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/enable_connection_aborted.html b/doc/html/boost_asio/reference/basic_socket/enable_connection_aborted.html new file mode 100755 index 0000000000..2b4c9593a0 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/enable_connection_aborted.html @@ -0,0 +1,89 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::enable_connection_aborted</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="do_not_route.html" title="basic_socket::do_not_route"> +<link rel="next" href="endpoint_type.html" title="basic_socket::endpoint_type"> +</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="do_not_route.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="endpoint_type.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.basic_socket.enable_connection_aborted"></a><a class="link" href="enable_connection_aborted.html" title="basic_socket::enable_connection_aborted">basic_socket::enable_connection_aborted</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1100248"></a> +Socket option to report aborted connections + on accept. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">enable_connection_aborted</span><span class="special">;</span> +</pre> +<p> + Implements a custom socket option that determines whether or not an accept + operation is permitted to fail with <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">connection_aborted</span></code>. + By default the option is false. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.enable_connection_aborted.h0"></a> + <span><a name="boost_asio.reference.basic_socket.enable_connection_aborted.examples"></a></span><a class="link" href="enable_connection_aborted.html#boost_asio.reference.basic_socket.enable_connection_aborted.examples">Examples</a> + </h6> +<p> + Setting the option: + </p> +<pre class="programlisting"><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">acceptor</span> <span class="identifier">acceptor</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">enable_connection_aborted</span> <span class="identifier">option</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span> +<span class="identifier">acceptor</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +</pre> +<p> + Getting the current option value: + </p> +<pre class="programlisting"><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">acceptor</span> <span class="identifier">acceptor</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">enable_connection_aborted</span> <span class="identifier">option</span><span class="special">;</span> +<span class="identifier">acceptor</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +<span class="keyword">bool</span> <span class="identifier">is_set</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">value</span><span class="special">();</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.enable_connection_aborted.h1"></a> + <span><a name="boost_asio.reference.basic_socket.enable_connection_aborted.requirements"></a></span><a class="link" href="enable_connection_aborted.html#boost_asio.reference.basic_socket.enable_connection_aborted.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="do_not_route.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="endpoint_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/endpoint_type.html b/doc/html/boost_asio/reference/basic_socket/endpoint_type.html new file mode 100755 index 0000000000..7c070ed5e5 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/endpoint_type.html @@ -0,0 +1,59 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::endpoint_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="enable_connection_aborted.html" title="basic_socket::enable_connection_aborted"> +<link rel="next" href="get_implementation.html" title="basic_socket::get_implementation"> +</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="enable_connection_aborted.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="get_implementation.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.basic_socket.endpoint_type"></a><a class="link" href="endpoint_type.html" title="basic_socket::endpoint_type">basic_socket::endpoint_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1101032"></a> +The endpoint type. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span> <span class="identifier">endpoint_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.endpoint_type.h0"></a> + <span><a name="boost_asio.reference.basic_socket.endpoint_type.requirements"></a></span><a class="link" href="endpoint_type.html#boost_asio.reference.basic_socket.endpoint_type.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="enable_connection_aborted.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="get_implementation.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/get_implementation.html b/doc/html/boost_asio/reference/basic_socket/get_implementation.html new file mode 100755 index 0000000000..220b31cb9a --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/get_implementation.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::get_implementation</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="endpoint_type.html" title="basic_socket::endpoint_type"> +<link rel="next" href="get_implementation/overload1.html" title="basic_socket::get_implementation (1 of 2 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="endpoint_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="get_implementation/overload1.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.basic_socket.get_implementation"></a><a class="link" href="get_implementation.html" title="basic_socket::get_implementation">basic_socket::get_implementation</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1101150"></a> +Get the underlying implementation of the + I/O object. + </p> +<pre class="programlisting"><span class="identifier">implementation_type</span> <span class="special">&</span> <a class="link" href="get_implementation/overload1.html" title="basic_socket::get_implementation (1 of 2 overloads)">get_implementation</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="get_implementation/overload1.html" title="basic_socket::get_implementation (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">const</span> <span class="identifier">implementation_type</span> <span class="special">&</span> <a class="link" href="get_implementation/overload2.html" title="basic_socket::get_implementation (2 of 2 overloads)">get_implementation</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="get_implementation/overload2.html" title="basic_socket::get_implementation (2 of 2 overloads)">more...</a></em></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-2012 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="endpoint_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="get_implementation/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/get_implementation/overload1.html b/doc/html/boost_asio/reference/basic_socket/get_implementation/overload1.html new file mode 100755 index 0000000000..1f1e075e4a --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/get_implementation/overload1.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::get_implementation (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../get_implementation.html" title="basic_socket::get_implementation"> +<link rel="prev" href="../get_implementation.html" title="basic_socket::get_implementation"> +<link rel="next" href="overload2.html" title="basic_socket::get_implementation (2 of 2 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="../get_implementation.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_implementation.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.get_implementation.overload1"></a><a class="link" href="overload1.html" title="basic_socket::get_implementation (1 of 2 overloads)">basic_socket::get_implementation + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the underlying implementation of the I/O object. + </p> +<pre class="programlisting"><span class="identifier">implementation_type</span> <span class="special">&</span> <span class="identifier">get_implementation</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-2012 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="../get_implementation.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_implementation.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/basic_socket/get_implementation/overload2.html b/doc/html/boost_asio/reference/basic_socket/get_implementation/overload2.html new file mode 100755 index 0000000000..1b57229e87 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/get_implementation/overload2.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::get_implementation (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../get_implementation.html" title="basic_socket::get_implementation"> +<link rel="prev" href="overload1.html" title="basic_socket::get_implementation (1 of 2 overloads)"> +<link rel="next" href="../get_io_service.html" title="basic_socket::get_io_service"> +</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="../get_implementation.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="../get_io_service.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.get_implementation.overload2"></a><a class="link" href="overload2.html" title="basic_socket::get_implementation (2 of 2 overloads)">basic_socket::get_implementation + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the underlying implementation of the I/O object. + </p> +<pre class="programlisting"><span class="keyword">const</span> <span class="identifier">implementation_type</span> <span class="special">&</span> <span class="identifier">get_implementation</span><span class="special">()</span> <span class="keyword">const</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-2012 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="../get_implementation.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="../get_io_service.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/get_io_service.html b/doc/html/boost_asio/reference/basic_socket/get_io_service.html new file mode 100755 index 0000000000..ba87504bd3 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/get_io_service.html @@ -0,0 +1,67 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::get_io_service</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="get_implementation/overload2.html" title="basic_socket::get_implementation (2 of 2 overloads)"> +<link rel="next" href="get_option.html" title="basic_socket::get_option"> +</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="get_implementation/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="get_option.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.basic_socket.get_io_service"></a><a class="link" href="get_io_service.html" title="basic_socket::get_io_service">basic_socket::get_io_service</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="id1101412"></a> +Get the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> associated with the + object. + </p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">get_io_service</span><span class="special">();</span> +</pre> +<p> + This function may be used to obtain the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that the I/O + object uses to dispatch handlers for asynchronous operations. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.get_io_service.h0"></a> + <span><a name="boost_asio.reference.basic_socket.get_io_service.return_value"></a></span><a class="link" href="get_io_service.html#boost_asio.reference.basic_socket.get_io_service.return_value">Return + Value</a> + </h6> +<p> + A reference to the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that the I/O + object will use to dispatch handlers. Ownership is not transferred to the + caller. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="get_implementation/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="get_option.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/get_option.html b/doc/html/boost_asio/reference/basic_socket/get_option.html new file mode 100755 index 0000000000..4af07e9d94 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/get_option.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::get_option</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="get_io_service.html" title="basic_socket::get_io_service"> +<link rel="next" href="get_option/overload1.html" title="basic_socket::get_option (1 of 2 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="get_io_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="get_option/overload1.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.basic_socket.get_option"></a><a class="link" href="get_option.html" title="basic_socket::get_option">basic_socket::get_option</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1101572"></a> +Get an option from the socket. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../GettableSocketOption.html" title="Gettable socket option requirements">GettableSocketOption</a><span class="special">></span> +<span class="keyword">void</span> <a class="link" href="get_option/overload1.html" title="basic_socket::get_option (1 of 2 overloads)">get_option</a><span class="special">(</span> + <span class="identifier">GettableSocketOption</span> <span class="special">&</span> <span class="identifier">option</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="get_option/overload1.html" title="basic_socket::get_option (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../GettableSocketOption.html" title="Gettable socket option requirements">GettableSocketOption</a><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> <a class="link" href="get_option/overload2.html" title="basic_socket::get_option (2 of 2 overloads)">get_option</a><span class="special">(</span> + <span class="identifier">GettableSocketOption</span> <span class="special">&</span> <span class="identifier">option</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> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="get_option/overload2.html" title="basic_socket::get_option (2 of 2 overloads)">more...</a></em></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-2012 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="get_io_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="get_option/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/get_option/overload1.html b/doc/html/boost_asio/reference/basic_socket/get_option/overload1.html new file mode 100755 index 0000000000..f6f4bc0ba3 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/get_option/overload1.html @@ -0,0 +1,94 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::get_option (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../get_option.html" title="basic_socket::get_option"> +<link rel="prev" href="../get_option.html" title="basic_socket::get_option"> +<link rel="next" href="overload2.html" title="basic_socket::get_option (2 of 2 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="../get_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_option.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.get_option.overload1"></a><a class="link" href="overload1.html" title="basic_socket::get_option (1 of 2 overloads)">basic_socket::get_option + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Get an option from the socket. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../GettableSocketOption.html" title="Gettable socket option requirements">GettableSocketOption</a><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">get_option</span><span class="special">(</span> + <span class="identifier">GettableSocketOption</span> <span class="special">&</span> <span class="identifier">option</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function is used to get the current value of an option on the socket. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.get_option.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.get_option.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.get_option.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">option</span></dt> +<dd><p> + The option value to be obtained from the socket. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.get_option.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_socket.get_option.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.get_option.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.get_option.overload1.h2"></a> + <span><a name="boost_asio.reference.basic_socket.get_option.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.get_option.overload1.example">Example</a> + </h6> +<p> + Getting the value of the SOL_SOCKET/SO_KEEPALIVE option: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">::</span><span class="identifier">keep_alive</span> <span class="identifier">option</span><span class="special">;</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +<span class="keyword">bool</span> <span class="identifier">is_set</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">get</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-2012 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="../get_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_option.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/basic_socket/get_option/overload2.html b/doc/html/boost_asio/reference/basic_socket/get_option/overload2.html new file mode 100755 index 0000000000..bf5f393e70 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/get_option/overload2.html @@ -0,0 +1,91 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::get_option (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../get_option.html" title="basic_socket::get_option"> +<link rel="prev" href="overload1.html" title="basic_socket::get_option (1 of 2 overloads)"> +<link rel="next" href="../get_service.html" title="basic_socket::get_service"> +</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="../get_option.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="../get_service.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.get_option.overload2"></a><a class="link" href="overload2.html" title="basic_socket::get_option (2 of 2 overloads)">basic_socket::get_option + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Get an option from the socket. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../GettableSocketOption.html" title="Gettable socket option requirements">GettableSocketOption</a><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">get_option</span><span class="special">(</span> + <span class="identifier">GettableSocketOption</span> <span class="special">&</span> <span class="identifier">option</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> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function is used to get the current value of an option on the socket. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.get_option.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.get_option.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.get_option.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">option</span></dt> +<dd><p> + The option value to be obtained from the socket. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.get_option.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.get_option.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.get_option.overload2.example">Example</a> + </h6> +<p> + Getting the value of the SOL_SOCKET/SO_KEEPALIVE option: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">::</span><span class="identifier">keep_alive</span> <span class="identifier">option</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">socket</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</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">bool</span> <span class="identifier">is_set</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">get</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-2012 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="../get_option.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="../get_service.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/get_service.html b/doc/html/boost_asio/reference/basic_socket/get_service.html new file mode 100755 index 0000000000..d3976729e6 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/get_service.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::get_service</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="get_option/overload2.html" title="basic_socket::get_option (2 of 2 overloads)"> +<link rel="next" href="get_service/overload1.html" title="basic_socket::get_service (1 of 2 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="get_option/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="get_service/overload1.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.basic_socket.get_service"></a><a class="link" href="get_service.html" title="basic_socket::get_service">basic_socket::get_service</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1102794"></a> +Get the service associated with the I/O object. + </p> +<pre class="programlisting"><span class="identifier">service_type</span> <span class="special">&</span> <a class="link" href="get_service/overload1.html" title="basic_socket::get_service (1 of 2 overloads)">get_service</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="get_service/overload1.html" title="basic_socket::get_service (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">const</span> <span class="identifier">service_type</span> <span class="special">&</span> <a class="link" href="get_service/overload2.html" title="basic_socket::get_service (2 of 2 overloads)">get_service</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="get_service/overload2.html" title="basic_socket::get_service (2 of 2 overloads)">more...</a></em></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-2012 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="get_option/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="get_service/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/get_service/overload1.html b/doc/html/boost_asio/reference/basic_socket/get_service/overload1.html new file mode 100755 index 0000000000..6e49436851 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/get_service/overload1.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::get_service (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../get_service.html" title="basic_socket::get_service"> +<link rel="prev" href="../get_service.html" title="basic_socket::get_service"> +<link rel="next" href="overload2.html" title="basic_socket::get_service (2 of 2 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="../get_service.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_service.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.get_service.overload1"></a><a class="link" href="overload1.html" title="basic_socket::get_service (1 of 2 overloads)">basic_socket::get_service + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the service associated with the I/O object. + </p> +<pre class="programlisting"><span class="identifier">service_type</span> <span class="special">&</span> <span class="identifier">get_service</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-2012 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="../get_service.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_service.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/basic_socket/get_service/overload2.html b/doc/html/boost_asio/reference/basic_socket/get_service/overload2.html new file mode 100755 index 0000000000..d20a02059f --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/get_service/overload2.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::get_service (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../get_service.html" title="basic_socket::get_service"> +<link rel="prev" href="overload1.html" title="basic_socket::get_service (1 of 2 overloads)"> +<link rel="next" href="../implementation.html" title="basic_socket::implementation"> +</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="../get_service.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="../implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.get_service.overload2"></a><a class="link" href="overload2.html" title="basic_socket::get_service (2 of 2 overloads)">basic_socket::get_service + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the service associated with the I/O object. + </p> +<pre class="programlisting"><span class="keyword">const</span> <span class="identifier">service_type</span> <span class="special">&</span> <span class="identifier">get_service</span><span class="special">()</span> <span class="keyword">const</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-2012 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="../get_service.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="../implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/implementation.html b/doc/html/boost_asio/reference/basic_socket/implementation.html new file mode 100755 index 0000000000..40ff8079cb --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/implementation.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::implementation</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="get_service/overload2.html" title="basic_socket::get_service (2 of 2 overloads)"> +<link rel="next" href="implementation_type.html" title="basic_socket::implementation_type"> +</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="get_service/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="implementation_type.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.basic_socket.implementation"></a><a class="link" href="implementation.html" title="basic_socket::implementation">basic_socket::implementation</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="id1103052"></a> +(Deprecated: Use <code class="computeroutput"><span class="identifier">get_implementation</span><span class="special">()</span></code>.) The underlying implementation of the + I/O object. + </p> +<pre class="programlisting"><span class="identifier">implementation_type</span> <span class="identifier">implementation</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-2012 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="get_service/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="implementation_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/implementation_type.html b/doc/html/boost_asio/reference/basic_socket/implementation_type.html new file mode 100755 index 0000000000..c2b3b625ab --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/implementation_type.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::implementation_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="implementation.html" title="basic_socket::implementation"> +<link rel="next" href="io_control.html" title="basic_socket::io_control"> +</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="implementation.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="io_control.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.basic_socket.implementation_type"></a><a class="link" href="implementation_type.html" title="basic_socket::implementation_type">basic_socket::implementation_type</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="id1103127"></a> +The underlying implementation type of I/O + object. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">service_type</span><span class="special">::</span><span class="identifier">implementation_type</span> <span class="identifier">implementation_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.implementation_type.h0"></a> + <span><a name="boost_asio.reference.basic_socket.implementation_type.requirements"></a></span><a class="link" href="implementation_type.html#boost_asio.reference.basic_socket.implementation_type.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="implementation.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="io_control.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/io_control.html b/doc/html/boost_asio/reference/basic_socket/io_control.html new file mode 100755 index 0000000000..d2ee241152 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/io_control.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::io_control</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="implementation_type.html" title="basic_socket::implementation_type"> +<link rel="next" href="io_control/overload1.html" title="basic_socket::io_control (1 of 2 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="implementation_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="io_control/overload1.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.basic_socket.io_control"></a><a class="link" href="io_control.html" title="basic_socket::io_control">basic_socket::io_control</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1103249"></a> +Perform an IO control command on the socket. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../IoControlCommand.html" title="I/O control command requirements">IoControlCommand</a><span class="special">></span> +<span class="keyword">void</span> <a class="link" href="io_control/overload1.html" title="basic_socket::io_control (1 of 2 overloads)">io_control</a><span class="special">(</span> + <span class="identifier">IoControlCommand</span> <span class="special">&</span> <span class="identifier">command</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="io_control/overload1.html" title="basic_socket::io_control (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../IoControlCommand.html" title="I/O control command requirements">IoControlCommand</a><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> <a class="link" href="io_control/overload2.html" title="basic_socket::io_control (2 of 2 overloads)">io_control</a><span class="special">(</span> + <span class="identifier">IoControlCommand</span> <span class="special">&</span> <span class="identifier">command</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> + <span class="emphasis"><em>» <a class="link" href="io_control/overload2.html" title="basic_socket::io_control (2 of 2 overloads)">more...</a></em></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-2012 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="implementation_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="io_control/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/io_control/overload1.html b/doc/html/boost_asio/reference/basic_socket/io_control/overload1.html new file mode 100755 index 0000000000..ce8f4b2d83 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/io_control/overload1.html @@ -0,0 +1,94 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::io_control (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_control.html" title="basic_socket::io_control"> +<link rel="prev" href="../io_control.html" title="basic_socket::io_control"> +<link rel="next" href="overload2.html" title="basic_socket::io_control (2 of 2 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="../io_control.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_control.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.io_control.overload1"></a><a class="link" href="overload1.html" title="basic_socket::io_control (1 of 2 overloads)">basic_socket::io_control + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Perform an IO control command on the socket. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../IoControlCommand.html" title="I/O control command requirements">IoControlCommand</a><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">io_control</span><span class="special">(</span> + <span class="identifier">IoControlCommand</span> <span class="special">&</span> <span class="identifier">command</span><span class="special">);</span> +</pre> +<p> + This function is used to execute an IO control command on the socket. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.io_control.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.io_control.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.io_control.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">command</span></dt> +<dd><p> + The IO control command to be performed on the socket. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.io_control.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_socket.io_control.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.io_control.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.io_control.overload1.h2"></a> + <span><a name="boost_asio.reference.basic_socket.io_control.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.io_control.overload1.example">Example</a> + </h6> +<p> + Getting the number of bytes ready to read: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">::</span><span class="identifier">bytes_readable</span> <span class="identifier">command</span><span class="special">;</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">io_control</span><span class="special">(</span><span class="identifier">command</span><span class="special">);</span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_readable</span> <span class="special">=</span> <span class="identifier">command</span><span class="special">.</span><span class="identifier">get</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-2012 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="../io_control.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_control.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/basic_socket/io_control/overload2.html b/doc/html/boost_asio/reference/basic_socket/io_control/overload2.html new file mode 100755 index 0000000000..95dd31b159 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/io_control/overload2.html @@ -0,0 +1,91 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::io_control (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../io_control.html" title="basic_socket::io_control"> +<link rel="prev" href="overload1.html" title="basic_socket::io_control (1 of 2 overloads)"> +<link rel="next" href="../is_open.html" title="basic_socket::is_open"> +</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="../io_control.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="../is_open.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.io_control.overload2"></a><a class="link" href="overload2.html" title="basic_socket::io_control (2 of 2 overloads)">basic_socket::io_control + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Perform an IO control command on the socket. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../IoControlCommand.html" title="I/O control command requirements">IoControlCommand</a><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">io_control</span><span class="special">(</span> + <span class="identifier">IoControlCommand</span> <span class="special">&</span> <span class="identifier">command</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 is used to execute an IO control command on the socket. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.io_control.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.io_control.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.io_control.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">command</span></dt> +<dd><p> + The IO control command to be performed on the socket. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.io_control.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.io_control.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.io_control.overload2.example">Example</a> + </h6> +<p> + Getting the number of bytes ready to read: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">::</span><span class="identifier">bytes_readable</span> <span class="identifier">command</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">socket</span><span class="special">.</span><span class="identifier">io_control</span><span class="special">(</span><span class="identifier">command</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="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_readable</span> <span class="special">=</span> <span class="identifier">command</span><span class="special">.</span><span class="identifier">get</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-2012 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="../io_control.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="../is_open.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/is_open.html b/doc/html/boost_asio/reference/basic_socket/is_open.html new file mode 100755 index 0000000000..f4108809d2 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/is_open.html @@ -0,0 +1,49 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::is_open</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="io_control/overload2.html" title="basic_socket::io_control (2 of 2 overloads)"> +<link rel="next" href="keep_alive.html" title="basic_socket::keep_alive"> +</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="io_control/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="keep_alive.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.basic_socket.is_open"></a><a class="link" href="is_open.html" title="basic_socket::is_open">basic_socket::is_open</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1104447"></a> +Determine whether the socket is open. + </p> +<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">is_open</span><span class="special">()</span> <span class="keyword">const</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-2012 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="io_control/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="keep_alive.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/keep_alive.html b/doc/html/boost_asio/reference/basic_socket/keep_alive.html new file mode 100755 index 0000000000..1411c75db2 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/keep_alive.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::keep_alive</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="is_open.html" title="basic_socket::is_open"> +<link rel="next" href="linger.html" title="basic_socket::linger"> +</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="is_open.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="linger.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.basic_socket.keep_alive"></a><a class="link" href="keep_alive.html" title="basic_socket::keep_alive">basic_socket::keep_alive</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1104514"></a> +Socket option to send keep-alives. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">keep_alive</span><span class="special">;</span> +</pre> +<p> + Implements the SOL_SOCKET/SO_KEEPALIVE socket option. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.keep_alive.h0"></a> + <span><a name="boost_asio.reference.basic_socket.keep_alive.examples"></a></span><a class="link" href="keep_alive.html#boost_asio.reference.basic_socket.keep_alive.examples">Examples</a> + </h6> +<p> + Setting the option: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">keep_alive</span> <span class="identifier">option</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +</pre> +<p> + Getting the current option value: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">keep_alive</span> <span class="identifier">option</span><span class="special">;</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +<span class="keyword">bool</span> <span class="identifier">is_set</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">value</span><span class="special">();</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.keep_alive.h1"></a> + <span><a name="boost_asio.reference.basic_socket.keep_alive.requirements"></a></span><a class="link" href="keep_alive.html#boost_asio.reference.basic_socket.keep_alive.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="is_open.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="linger.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/linger.html b/doc/html/boost_asio/reference/basic_socket/linger.html new file mode 100755 index 0000000000..aa537b26a4 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/linger.html @@ -0,0 +1,88 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::linger</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="keep_alive.html" title="basic_socket::keep_alive"> +<link rel="next" href="local_endpoint.html" title="basic_socket::local_endpoint"> +</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="keep_alive.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="local_endpoint.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.basic_socket.linger"></a><a class="link" href="linger.html" title="basic_socket::linger">basic_socket::linger</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1104993"></a> +Socket option to specify whether the socket lingers on + close if unsent data is present. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">linger</span><span class="special">;</span> +</pre> +<p> + Implements the SOL_SOCKET/SO_LINGER socket option. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.linger.h0"></a> + <span><a name="boost_asio.reference.basic_socket.linger.examples"></a></span><a class="link" href="linger.html#boost_asio.reference.basic_socket.linger.examples">Examples</a> + </h6> +<p> + Setting the option: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">linger</span> <span class="identifier">option</span><span class="special">(</span><span class="keyword">true</span><span class="special">,</span> <span class="number">30</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +</pre> +<p> + Getting the current option value: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">linger</span> <span class="identifier">option</span><span class="special">;</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +<span class="keyword">bool</span> <span class="identifier">is_set</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">enabled</span><span class="special">();</span> +<span class="keyword">unsigned</span> <span class="keyword">short</span> <span class="identifier">timeout</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">timeout</span><span class="special">();</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.linger.h1"></a> + <span><a name="boost_asio.reference.basic_socket.linger.requirements"></a></span><a class="link" href="linger.html#boost_asio.reference.basic_socket.linger.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="keep_alive.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="local_endpoint.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/local_endpoint.html b/doc/html/boost_asio/reference/basic_socket/local_endpoint.html new file mode 100755 index 0000000000..5b649152d0 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/local_endpoint.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::local_endpoint</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="linger.html" title="basic_socket::linger"> +<link rel="next" href="local_endpoint/overload1.html" title="basic_socket::local_endpoint (1 of 2 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="linger.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="local_endpoint/overload1.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.basic_socket.local_endpoint"></a><a class="link" href="local_endpoint.html" title="basic_socket::local_endpoint">basic_socket::local_endpoint</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1105514"></a> +Get the local endpoint of the socket. + </p> +<pre class="programlisting"><span class="identifier">endpoint_type</span> <a class="link" href="local_endpoint/overload1.html" title="basic_socket::local_endpoint (1 of 2 overloads)">local_endpoint</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="local_endpoint/overload1.html" title="basic_socket::local_endpoint (1 of 2 overloads)">more...</a></em></span> + +<span class="identifier">endpoint_type</span> <a class="link" href="local_endpoint/overload2.html" title="basic_socket::local_endpoint (2 of 2 overloads)">local_endpoint</a><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> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="local_endpoint/overload2.html" title="basic_socket::local_endpoint (2 of 2 overloads)">more...</a></em></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-2012 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="linger.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="local_endpoint/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/local_endpoint/overload1.html b/doc/html/boost_asio/reference/basic_socket/local_endpoint/overload1.html new file mode 100755 index 0000000000..98f61b6ab3 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/local_endpoint/overload1.html @@ -0,0 +1,81 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::local_endpoint (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../local_endpoint.html" title="basic_socket::local_endpoint"> +<link rel="prev" href="../local_endpoint.html" title="basic_socket::local_endpoint"> +<link rel="next" href="overload2.html" title="basic_socket::local_endpoint (2 of 2 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="../local_endpoint.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../local_endpoint.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.local_endpoint.overload1"></a><a class="link" href="overload1.html" title="basic_socket::local_endpoint (1 of 2 overloads)">basic_socket::local_endpoint + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Get the local endpoint of the socket. + </p> +<pre class="programlisting"><span class="identifier">endpoint_type</span> <span class="identifier">local_endpoint</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function is used to obtain the locally bound endpoint of the socket. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.local_endpoint.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.local_endpoint.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.local_endpoint.overload1.return_value">Return + Value</a> + </h6> +<p> + An object that represents the local endpoint of the socket. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.local_endpoint.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_socket.local_endpoint.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.local_endpoint.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.local_endpoint.overload1.h2"></a> + <span><a name="boost_asio.reference.basic_socket.local_endpoint.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.local_endpoint.overload1.example">Example</a> + </h6> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">endpoint</span> <span class="identifier">endpoint</span> <span class="special">=</span> <span class="identifier">socket</span><span class="special">.</span><span class="identifier">local_endpoint</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-2012 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="../local_endpoint.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../local_endpoint.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/basic_socket/local_endpoint/overload2.html b/doc/html/boost_asio/reference/basic_socket/local_endpoint/overload2.html new file mode 100755 index 0000000000..a90cb7acf9 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/local_endpoint/overload2.html @@ -0,0 +1,88 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::local_endpoint (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../local_endpoint.html" title="basic_socket::local_endpoint"> +<link rel="prev" href="overload1.html" title="basic_socket::local_endpoint (1 of 2 overloads)"> +<link rel="next" href="../lowest_layer.html" title="basic_socket::lowest_layer"> +</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="../local_endpoint.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="../lowest_layer.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.local_endpoint.overload2"></a><a class="link" href="overload2.html" title="basic_socket::local_endpoint (2 of 2 overloads)">basic_socket::local_endpoint + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Get the local endpoint of the socket. + </p> +<pre class="programlisting"><span class="identifier">endpoint_type</span> <span class="identifier">local_endpoint</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> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function is used to obtain the locally bound endpoint of the socket. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.local_endpoint.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.local_endpoint.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.local_endpoint.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.local_endpoint.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.local_endpoint.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.local_endpoint.overload2.return_value">Return + Value</a> + </h6> +<p> + An object that represents the local endpoint of the socket. Returns a + default-constructed endpoint object if an error occurred. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.local_endpoint.overload2.h2"></a> + <span><a name="boost_asio.reference.basic_socket.local_endpoint.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.local_endpoint.overload2.example">Example</a> + </h6> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">endpoint</span> <span class="identifier">endpoint</span> <span class="special">=</span> <span class="identifier">socket</span><span class="special">.</span><span class="identifier">local_endpoint</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-2012 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="../local_endpoint.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="../lowest_layer.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/lowest_layer.html b/doc/html/boost_asio/reference/basic_socket/lowest_layer.html new file mode 100755 index 0000000000..7e88cf9992 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/lowest_layer.html @@ -0,0 +1,56 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::lowest_layer</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="local_endpoint/overload2.html" title="basic_socket::local_endpoint (2 of 2 overloads)"> +<link rel="next" href="lowest_layer/overload1.html" title="basic_socket::lowest_layer (1 of 2 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="local_endpoint/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="lowest_layer/overload1.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.basic_socket.lowest_layer"></a><a class="link" href="lowest_layer.html" title="basic_socket::lowest_layer">basic_socket::lowest_layer</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1106395"></a> +Get a reference to the lowest layer. + </p> +<pre class="programlisting"><span class="identifier">lowest_layer_type</span> <span class="special">&</span> <a class="link" href="lowest_layer/overload1.html" title="basic_socket::lowest_layer (1 of 2 overloads)">lowest_layer</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="lowest_layer/overload1.html" title="basic_socket::lowest_layer (1 of 2 overloads)">more...</a></em></span> +</pre> +<p> + Get a const reference to the lowest layer. + </p> +<pre class="programlisting"><span class="keyword">const</span> <span class="identifier">lowest_layer_type</span> <span class="special">&</span> <a class="link" href="lowest_layer/overload2.html" title="basic_socket::lowest_layer (2 of 2 overloads)">lowest_layer</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="lowest_layer/overload2.html" title="basic_socket::lowest_layer (2 of 2 overloads)">more...</a></em></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-2012 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="local_endpoint/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="lowest_layer/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/lowest_layer/overload1.html b/doc/html/boost_asio/reference/basic_socket/lowest_layer/overload1.html new file mode 100755 index 0000000000..d6363f4805 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/lowest_layer/overload1.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::lowest_layer (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../lowest_layer.html" title="basic_socket::lowest_layer"> +<link rel="prev" href="../lowest_layer.html" title="basic_socket::lowest_layer"> +<link rel="next" href="overload2.html" title="basic_socket::lowest_layer (2 of 2 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="../lowest_layer.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.lowest_layer.overload1"></a><a class="link" href="overload1.html" title="basic_socket::lowest_layer (1 of 2 overloads)">basic_socket::lowest_layer + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Get a reference to the lowest layer. + </p> +<pre class="programlisting"><span class="identifier">lowest_layer_type</span> <span class="special">&</span> <span class="identifier">lowest_layer</span><span class="special">();</span> +</pre> +<p> + This function returns a reference to the lowest layer in a stack of layers. + Since a <a class="link" href="../../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a> cannot contain + any further layers, it simply returns a reference to itself. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.lowest_layer.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.lowest_layer.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.lowest_layer.overload1.return_value">Return + Value</a> + </h6> +<p> + A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="../lowest_layer.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.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/basic_socket/lowest_layer/overload2.html b/doc/html/boost_asio/reference/basic_socket/lowest_layer/overload2.html new file mode 100755 index 0000000000..1b36a011a9 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/lowest_layer/overload2.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::lowest_layer (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../lowest_layer.html" title="basic_socket::lowest_layer"> +<link rel="prev" href="overload1.html" title="basic_socket::lowest_layer (1 of 2 overloads)"> +<link rel="next" href="../lowest_layer_type.html" title="basic_socket::lowest_layer_type"> +</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="../lowest_layer.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="../lowest_layer_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.lowest_layer.overload2"></a><a class="link" href="overload2.html" title="basic_socket::lowest_layer (2 of 2 overloads)">basic_socket::lowest_layer + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Get a const reference to the lowest layer. + </p> +<pre class="programlisting"><span class="keyword">const</span> <span class="identifier">lowest_layer_type</span> <span class="special">&</span> <span class="identifier">lowest_layer</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function returns a const reference to the lowest layer in a stack + of layers. Since a <a class="link" href="../../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a> cannot contain + any further layers, it simply returns a reference to itself. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.lowest_layer.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.lowest_layer.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.lowest_layer.overload2.return_value">Return + Value</a> + </h6> +<p> + A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="../lowest_layer.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="../lowest_layer_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/lowest_layer_type.html b/doc/html/boost_asio/reference/basic_socket/lowest_layer_type.html new file mode 100755 index 0000000000..4b90e3df36 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/lowest_layer_type.html @@ -0,0 +1,904 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::lowest_layer_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="lowest_layer/overload2.html" title="basic_socket::lowest_layer (2 of 2 overloads)"> +<link rel="next" href="max_connections.html" title="basic_socket::max_connections"> +</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="lowest_layer/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="max_connections.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.basic_socket.lowest_layer_type"></a><a class="link" href="lowest_layer_type.html" title="basic_socket::lowest_layer_type">basic_socket::lowest_layer_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1106753"></a> +A <a class="link" href="../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a> is always the lowest + layer. + </p> +<pre class="programlisting"><span class="keyword">typedef</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="identifier">lowest_layer_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.lowest_layer_type.h0"></a> + <span><a name="boost_asio.reference.basic_socket.lowest_layer_type.types"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.basic_socket.lowest_layer_type.types">Types</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <a class="link" href="broadcast.html" title="basic_socket::broadcast"><span class="bold"><strong>broadcast</strong></span></a> + </p> + </td> +<td> + <p> + Socket option to permit sending of broadcast messages. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="bytes_readable.html" title="basic_socket::bytes_readable"><span class="bold"><strong>bytes_readable</strong></span></a> + </p> + </td> +<td> + <p> + IO control command to get the amount of data that can be read + without blocking. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="debug.html" title="basic_socket::debug"><span class="bold"><strong>debug</strong></span></a> + </p> + </td> +<td> + <p> + Socket option to enable socket-level debugging. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="do_not_route.html" title="basic_socket::do_not_route"><span class="bold"><strong>do_not_route</strong></span></a> + </p> + </td> +<td> + <p> + Socket option to prevent routing, use local interfaces only. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="enable_connection_aborted.html" title="basic_socket::enable_connection_aborted"><span class="bold"><strong>enable_connection_aborted</strong></span></a> + </p> + </td> +<td> + <p> + Socket option to report aborted connections on accept. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="endpoint_type.html" title="basic_socket::endpoint_type"><span class="bold"><strong>endpoint_type</strong></span></a> + </p> + </td> +<td> + <p> + The endpoint type. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="implementation_type.html" title="basic_socket::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a> + </p> + </td> +<td> + <p> + The underlying implementation type of I/O object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="keep_alive.html" title="basic_socket::keep_alive"><span class="bold"><strong>keep_alive</strong></span></a> + </p> + </td> +<td> + <p> + Socket option to send keep-alives. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="linger.html" title="basic_socket::linger"><span class="bold"><strong>linger</strong></span></a> + </p> + </td> +<td> + <p> + Socket option to specify whether the socket lingers on close + if unsent data is present. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="lowest_layer_type.html" title="basic_socket::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a> + </p> + </td> +<td> + <p> + A basic_socket is always the lowest layer. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="message_flags.html" title="basic_socket::message_flags"><span class="bold"><strong>message_flags</strong></span></a> + </p> + </td> +<td> + <p> + Bitmask type for flags that can be passed to send and receive + operations. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="native_handle_type.html" title="basic_socket::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a> + </p> + </td> +<td> + <p> + The native representation of a socket. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="native_type.html" title="basic_socket::native_type"><span class="bold"><strong>native_type</strong></span></a> + </p> + </td> +<td> + <p> + (Deprecated: Use native_handle_type.) The native representation + of a socket. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="non_blocking_io.html" title="basic_socket::non_blocking_io"><span class="bold"><strong>non_blocking_io</strong></span></a> + </p> + </td> +<td> + <p> + (Deprecated: Use non_blocking().) IO control command to set the + blocking mode of the socket. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="protocol_type.html" title="basic_socket::protocol_type"><span class="bold"><strong>protocol_type</strong></span></a> + </p> + </td> +<td> + <p> + The protocol type. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="receive_buffer_size.html" title="basic_socket::receive_buffer_size"><span class="bold"><strong>receive_buffer_size</strong></span></a> + </p> + </td> +<td> + <p> + Socket option for the receive buffer size of a socket. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="receive_low_watermark.html" title="basic_socket::receive_low_watermark"><span class="bold"><strong>receive_low_watermark</strong></span></a> + </p> + </td> +<td> + <p> + Socket option for the receive low watermark. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="reuse_address.html" title="basic_socket::reuse_address"><span class="bold"><strong>reuse_address</strong></span></a> + </p> + </td> +<td> + <p> + Socket option to allow the socket to be bound to an address that + is already in use. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="send_buffer_size.html" title="basic_socket::send_buffer_size"><span class="bold"><strong>send_buffer_size</strong></span></a> + </p> + </td> +<td> + <p> + Socket option for the send buffer size of a socket. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="send_low_watermark.html" title="basic_socket::send_low_watermark"><span class="bold"><strong>send_low_watermark</strong></span></a> + </p> + </td> +<td> + <p> + Socket option for the send low watermark. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="service_type.html" title="basic_socket::service_type"><span class="bold"><strong>service_type</strong></span></a> + </p> + </td> +<td> + <p> + The type of the service that will be used to provide I/O operations. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="shutdown_type.html" title="basic_socket::shutdown_type"><span class="bold"><strong>shutdown_type</strong></span></a> + </p> + </td> +<td> + <p> + Different ways a socket may be shutdown. + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="boost_asio.reference.basic_socket.lowest_layer_type.h1"></a> + <span><a name="boost_asio.reference.basic_socket.lowest_layer_type.member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.basic_socket.lowest_layer_type.member_functions">Member + Functions</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <a class="link" href="assign.html" title="basic_socket::assign"><span class="bold"><strong>assign</strong></span></a> + </p> + </td> +<td> + <p> + Assign an existing native socket to the socket. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="async_connect.html" title="basic_socket::async_connect"><span class="bold"><strong>async_connect</strong></span></a> + </p> + </td> +<td> + <p> + Start an asynchronous connect. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="at_mark.html" title="basic_socket::at_mark"><span class="bold"><strong>at_mark</strong></span></a> + </p> + </td> +<td> + <p> + Determine whether the socket is at the out-of-band data mark. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="available.html" title="basic_socket::available"><span class="bold"><strong>available</strong></span></a> + </p> + </td> +<td> + <p> + Determine the number of bytes available for reading. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="basic_socket.html" title="basic_socket::basic_socket"><span class="bold"><strong>basic_socket</strong></span></a> + </p> + </td> +<td> + <p> + Construct a basic_socket without opening it. + </p> + <p> + Construct and open a basic_socket. + </p> + <p> + Construct a basic_socket, opening it and binding it to the given + local endpoint. + </p> + <p> + Construct a basic_socket on an existing native socket. + </p> + <p> + Move-construct a basic_socket from another. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="bind.html" title="basic_socket::bind"><span class="bold"><strong>bind</strong></span></a> + </p> + </td> +<td> + <p> + Bind the socket to the given local endpoint. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="cancel.html" title="basic_socket::cancel"><span class="bold"><strong>cancel</strong></span></a> + </p> + </td> +<td> + <p> + Cancel all asynchronous operations associated with the socket. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="close.html" title="basic_socket::close"><span class="bold"><strong>close</strong></span></a> + </p> + </td> +<td> + <p> + Close the socket. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="connect.html" title="basic_socket::connect"><span class="bold"><strong>connect</strong></span></a> + </p> + </td> +<td> + <p> + Connect the socket to the specified endpoint. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="get_io_service.html" title="basic_socket::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a> + </p> + </td> +<td> + <p> + Get the io_service associated with the object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="get_option.html" title="basic_socket::get_option"><span class="bold"><strong>get_option</strong></span></a> + </p> + </td> +<td> + <p> + Get an option from the socket. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="io_control.html" title="basic_socket::io_control"><span class="bold"><strong>io_control</strong></span></a> + </p> + </td> +<td> + <p> + Perform an IO control command on the socket. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="is_open.html" title="basic_socket::is_open"><span class="bold"><strong>is_open</strong></span></a> + </p> + </td> +<td> + <p> + Determine whether the socket is open. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="local_endpoint.html" title="basic_socket::local_endpoint"><span class="bold"><strong>local_endpoint</strong></span></a> + </p> + </td> +<td> + <p> + Get the local endpoint of the socket. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="lowest_layer.html" title="basic_socket::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a> + </p> + </td> +<td> + <p> + Get a reference to the lowest layer. + </p> + <p> + Get a const reference to the lowest layer. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="native.html" title="basic_socket::native"><span class="bold"><strong>native</strong></span></a> + </p> + </td> +<td> + <p> + (Deprecated: Use native_handle().) Get the native socket representation. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="native_handle.html" title="basic_socket::native_handle"><span class="bold"><strong>native_handle</strong></span></a> + </p> + </td> +<td> + <p> + Get the native socket representation. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="native_non_blocking.html" title="basic_socket::native_non_blocking"><span class="bold"><strong>native_non_blocking</strong></span></a> + </p> + </td> +<td> + <p> + Gets the non-blocking mode of the native socket implementation. + </p> + <p> + Sets the non-blocking mode of the native socket implementation. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="non_blocking.html" title="basic_socket::non_blocking"><span class="bold"><strong>non_blocking</strong></span></a> + </p> + </td> +<td> + <p> + Gets the non-blocking mode of the socket. + </p> + <p> + Sets the non-blocking mode of the socket. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="open.html" title="basic_socket::open"><span class="bold"><strong>open</strong></span></a> + </p> + </td> +<td> + <p> + Open the socket using the specified protocol. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="operator_eq_.html" title="basic_socket::operator="><span class="bold"><strong>operator=</strong></span></a> + </p> + </td> +<td> + <p> + Move-assign a basic_socket from another. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="remote_endpoint.html" title="basic_socket::remote_endpoint"><span class="bold"><strong>remote_endpoint</strong></span></a> + </p> + </td> +<td> + <p> + Get the remote endpoint of the socket. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="set_option.html" title="basic_socket::set_option"><span class="bold"><strong>set_option</strong></span></a> + </p> + </td> +<td> + <p> + Set an option on the socket. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="shutdown.html" title="basic_socket::shutdown"><span class="bold"><strong>shutdown</strong></span></a> + </p> + </td> +<td> + <p> + Disable sends or receives on the socket. + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="boost_asio.reference.basic_socket.lowest_layer_type.h2"></a> + <span><a name="boost_asio.reference.basic_socket.lowest_layer_type.protected_member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.basic_socket.lowest_layer_type.protected_member_functions">Protected + Member Functions</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <a class="link" href="get_implementation.html" title="basic_socket::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a> + </p> + </td> +<td> + <p> + Get the underlying implementation of the I/O object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="get_service.html" title="basic_socket::get_service"><span class="bold"><strong>get_service</strong></span></a> + </p> + </td> +<td> + <p> + Get the service associated with the I/O object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="_basic_socket.html" title="basic_socket::~basic_socket"><span class="bold"><strong>~basic_socket</strong></span></a> + </p> + </td> +<td> + <p> + Protected destructor to prevent deletion through this type. + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="boost_asio.reference.basic_socket.lowest_layer_type.h3"></a> + <span><a name="boost_asio.reference.basic_socket.lowest_layer_type.data_members"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.basic_socket.lowest_layer_type.data_members">Data + Members</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <a class="link" href="max_connections.html" title="basic_socket::max_connections"><span class="bold"><strong>max_connections</strong></span></a> + </p> + </td> +<td> + <p> + The maximum length of the queue of pending incoming connections. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="message_do_not_route.html" title="basic_socket::message_do_not_route"><span class="bold"><strong>message_do_not_route</strong></span></a> + </p> + </td> +<td> + <p> + Specify that the data should not be subject to routing. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="message_end_of_record.html" title="basic_socket::message_end_of_record"><span class="bold"><strong>message_end_of_record</strong></span></a> + </p> + </td> +<td> + <p> + Specifies that the data marks the end of a record. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="message_out_of_band.html" title="basic_socket::message_out_of_band"><span class="bold"><strong>message_out_of_band</strong></span></a> + </p> + </td> +<td> + <p> + Process out-of-band data. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="message_peek.html" title="basic_socket::message_peek"><span class="bold"><strong>message_peek</strong></span></a> + </p> + </td> +<td> + <p> + Peek at incoming data without removing it from the input queue. + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="boost_asio.reference.basic_socket.lowest_layer_type.h4"></a> + <span><a name="boost_asio.reference.basic_socket.lowest_layer_type.protected_data_members"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.basic_socket.lowest_layer_type.protected_data_members">Protected + Data Members</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <a class="link" href="implementation.html" title="basic_socket::implementation"><span class="bold"><strong>implementation</strong></span></a> + </p> + </td> +<td> + <p> + (Deprecated: Use get_implementation().) The underlying implementation + of the I/O object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="service.html" title="basic_socket::service"><span class="bold"><strong>service</strong></span></a> + </p> + </td> +<td> + <p> + (Deprecated: Use get_service().) The service associated with + the I/O object. + </p> + </td> +</tr> +</tbody> +</table></div> +<p> + The <a class="link" href="../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a> + class template provides functionality that is common to both stream-oriented + and datagram-oriented sockets. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.lowest_layer_type.h5"></a> + <span><a name="boost_asio.reference.basic_socket.lowest_layer_type.thread_safety"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.basic_socket.lowest_layer_type.thread_safety">Thread + Safety</a> + </h6> +<p> + <span class="bold"><strong>Distinct</strong></span> <span class="bold"><strong>objects:</strong></span> + Safe. + </p> +<p> + <span class="bold"><strong>Shared</strong></span> <span class="bold"><strong>objects:</strong></span> + Unsafe. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.lowest_layer_type.h6"></a> + <span><a name="boost_asio.reference.basic_socket.lowest_layer_type.requirements"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.basic_socket.lowest_layer_type.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="lowest_layer/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="max_connections.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/max_connections.html b/doc/html/boost_asio/reference/basic_socket/max_connections.html new file mode 100755 index 0000000000..efc874b1da --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/max_connections.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::max_connections</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="lowest_layer_type.html" title="basic_socket::lowest_layer_type"> +<link rel="next" href="message_do_not_route.html" title="basic_socket::message_do_not_route"> +</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="lowest_layer_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="message_do_not_route.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.basic_socket.max_connections"></a><a class="link" href="max_connections.html" title="basic_socket::max_connections">basic_socket::max_connections</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1108954"></a> +The maximum length of the queue of pending incoming + connections. + </p> +<pre class="programlisting"><span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">int</span> <span class="identifier">max_connections</span> <span class="special">=</span> <span class="identifier">implementation_defined</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-2012 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="lowest_layer_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="message_do_not_route.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/message_do_not_route.html b/doc/html/boost_asio/reference/basic_socket/message_do_not_route.html new file mode 100755 index 0000000000..f9d55f4557 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/message_do_not_route.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::message_do_not_route</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="max_connections.html" title="basic_socket::max_connections"> +<link rel="next" href="message_end_of_record.html" title="basic_socket::message_end_of_record"> +</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="max_connections.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="message_end_of_record.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.basic_socket.message_do_not_route"></a><a class="link" href="message_do_not_route.html" title="basic_socket::message_do_not_route">basic_socket::message_do_not_route</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1109037"></a> +Specify that the data should not be subject + to routing. + </p> +<pre class="programlisting"><span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">int</span> <span class="identifier">message_do_not_route</span> <span class="special">=</span> <span class="identifier">implementation_defined</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-2012 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="max_connections.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="message_end_of_record.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/message_end_of_record.html b/doc/html/boost_asio/reference/basic_socket/message_end_of_record.html new file mode 100755 index 0000000000..8abf280715 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/message_end_of_record.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::message_end_of_record</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="message_do_not_route.html" title="basic_socket::message_do_not_route"> +<link rel="next" href="message_flags.html" title="basic_socket::message_flags"> +</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="message_do_not_route.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="message_flags.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.basic_socket.message_end_of_record"></a><a class="link" href="message_end_of_record.html" title="basic_socket::message_end_of_record">basic_socket::message_end_of_record</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1109119"></a> +Specifies that the data marks the end + of a record. + </p> +<pre class="programlisting"><span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">int</span> <span class="identifier">message_end_of_record</span> <span class="special">=</span> <span class="identifier">implementation_defined</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-2012 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="message_do_not_route.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="message_flags.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/message_flags.html b/doc/html/boost_asio/reference/basic_socket/message_flags.html new file mode 100755 index 0000000000..7e264b9e53 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/message_flags.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::message_flags</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="message_end_of_record.html" title="basic_socket::message_end_of_record"> +<link rel="next" href="message_out_of_band.html" title="basic_socket::message_out_of_band"> +</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="message_end_of_record.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="message_out_of_band.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.basic_socket.message_flags"></a><a class="link" href="message_flags.html" title="basic_socket::message_flags">basic_socket::message_flags</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1109201"></a> +Bitmask type for flags that can be passed to send + and receive operations. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="keyword">int</span> <span class="identifier">message_flags</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.message_flags.h0"></a> + <span><a name="boost_asio.reference.basic_socket.message_flags.requirements"></a></span><a class="link" href="message_flags.html#boost_asio.reference.basic_socket.message_flags.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="message_end_of_record.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="message_out_of_band.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/message_out_of_band.html b/doc/html/boost_asio/reference/basic_socket/message_out_of_band.html new file mode 100755 index 0000000000..505cbd4822 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/message_out_of_band.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::message_out_of_band</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="message_flags.html" title="basic_socket::message_flags"> +<link rel="next" href="message_peek.html" title="basic_socket::message_peek"> +</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="message_flags.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="message_peek.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.basic_socket.message_out_of_band"></a><a class="link" href="message_out_of_band.html" title="basic_socket::message_out_of_band">basic_socket::message_out_of_band</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1109320"></a> +Process out-of-band data. + </p> +<pre class="programlisting"><span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">int</span> <span class="identifier">message_out_of_band</span> <span class="special">=</span> <span class="identifier">implementation_defined</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-2012 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="message_flags.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="message_peek.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/message_peek.html b/doc/html/boost_asio/reference/basic_socket/message_peek.html new file mode 100755 index 0000000000..b0eab4579c --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/message_peek.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::message_peek</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="message_out_of_band.html" title="basic_socket::message_out_of_band"> +<link rel="next" href="native.html" title="basic_socket::native"> +</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="message_out_of_band.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="native.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.basic_socket.message_peek"></a><a class="link" href="message_peek.html" title="basic_socket::message_peek">basic_socket::message_peek</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1109401"></a> +Peek at incoming data without removing it from + the input queue. + </p> +<pre class="programlisting"><span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">int</span> <span class="identifier">message_peek</span> <span class="special">=</span> <span class="identifier">implementation_defined</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-2012 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="message_out_of_band.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="native.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/native.html b/doc/html/boost_asio/reference/basic_socket/native.html new file mode 100755 index 0000000000..820a4e0772 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/native.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::native</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="message_peek.html" title="basic_socket::message_peek"> +<link rel="next" href="native_handle.html" title="basic_socket::native_handle"> +</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="message_peek.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="native_handle.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.basic_socket.native"></a><a class="link" href="native.html" title="basic_socket::native">basic_socket::native</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1109475"></a> +(Deprecated: Use <code class="computeroutput"><span class="identifier">native_handle</span><span class="special">()</span></code>.) Get the native socket representation. + </p> +<pre class="programlisting"><span class="identifier">native_type</span> <span class="identifier">native</span><span class="special">();</span> +</pre> +<p> + This function may be used to obtain the underlying representation of the + socket. This is intended to allow access to native socket functionality + that is not otherwise provided. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="message_peek.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="native_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/native_handle.html b/doc/html/boost_asio/reference/basic_socket/native_handle.html new file mode 100755 index 0000000000..95323bd7a8 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/native_handle.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::native_handle</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="native.html" title="basic_socket::native"> +<link rel="next" href="native_handle_type.html" title="basic_socket::native_handle_type"> +</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="native.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="native_handle_type.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.basic_socket.native_handle"></a><a class="link" href="native_handle.html" title="basic_socket::native_handle">basic_socket::native_handle</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1109547"></a> +Get the native socket representation. + </p> +<pre class="programlisting"><span class="identifier">native_handle_type</span> <span class="identifier">native_handle</span><span class="special">();</span> +</pre> +<p> + This function may be used to obtain the underlying representation of the + socket. This is intended to allow access to native socket functionality + that is not otherwise provided. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="native.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="native_handle_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/native_handle_type.html b/doc/html/boost_asio/reference/basic_socket/native_handle_type.html new file mode 100755 index 0000000000..dc32547221 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/native_handle_type.html @@ -0,0 +1,59 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::native_handle_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="native_handle.html" title="basic_socket::native_handle"> +<link rel="next" href="native_non_blocking.html" title="basic_socket::native_non_blocking"> +</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="native_handle.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="native_non_blocking.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.basic_socket.native_handle_type"></a><a class="link" href="native_handle_type.html" title="basic_socket::native_handle_type">basic_socket::native_handle_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1109606"></a> +The native representation of a socket. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">SocketService</span><span class="special">::</span><span class="identifier">native_handle_type</span> <span class="identifier">native_handle_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.native_handle_type.h0"></a> + <span><a name="boost_asio.reference.basic_socket.native_handle_type.requirements"></a></span><a class="link" href="native_handle_type.html#boost_asio.reference.basic_socket.native_handle_type.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="native_handle.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="native_non_blocking.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/native_non_blocking.html b/doc/html/boost_asio/reference/basic_socket/native_non_blocking.html new file mode 100755 index 0000000000..6d65328270 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/native_non_blocking.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::native_non_blocking</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="native_handle_type.html" title="basic_socket::native_handle_type"> +<link rel="next" href="native_non_blocking/overload1.html" title="basic_socket::native_non_blocking (1 of 3 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="native_handle_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="native_non_blocking/overload1.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.basic_socket.native_non_blocking"></a><a class="link" href="native_non_blocking.html" title="basic_socket::native_non_blocking">basic_socket::native_non_blocking</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1109728"></a> +Gets the non-blocking mode of the native + socket implementation. + </p> +<pre class="programlisting"><span class="keyword">bool</span> <a class="link" href="native_non_blocking/overload1.html" title="basic_socket::native_non_blocking (1 of 3 overloads)">native_non_blocking</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="native_non_blocking/overload1.html" title="basic_socket::native_non_blocking (1 of 3 overloads)">more...</a></em></span> +</pre> +<p> + Sets the non-blocking mode of the native socket implementation. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="native_non_blocking/overload2.html" title="basic_socket::native_non_blocking (2 of 3 overloads)">native_non_blocking</a><span class="special">(</span> + <span class="keyword">bool</span> <span class="identifier">mode</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="native_non_blocking/overload2.html" title="basic_socket::native_non_blocking (2 of 3 overloads)">more...</a></em></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> <a class="link" href="native_non_blocking/overload3.html" title="basic_socket::native_non_blocking (3 of 3 overloads)">native_non_blocking</a><span class="special">(</span> + <span class="keyword">bool</span> <span class="identifier">mode</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> + <span class="emphasis"><em>» <a class="link" href="native_non_blocking/overload3.html" title="basic_socket::native_non_blocking (3 of 3 overloads)">more...</a></em></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-2012 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="native_handle_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="native_non_blocking/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/native_non_blocking/overload1.html b/doc/html/boost_asio/reference/basic_socket/native_non_blocking/overload1.html new file mode 100755 index 0000000000..2d66af3217 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/native_non_blocking/overload1.html @@ -0,0 +1,149 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::native_non_blocking (1 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../native_non_blocking.html" title="basic_socket::native_non_blocking"> +<link rel="prev" href="../native_non_blocking.html" title="basic_socket::native_non_blocking"> +<link rel="next" href="overload2.html" title="basic_socket::native_non_blocking (2 of 3 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="../native_non_blocking.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../native_non_blocking.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.native_non_blocking.overload1"></a><a class="link" href="overload1.html" title="basic_socket::native_non_blocking (1 of 3 overloads)">basic_socket::native_non_blocking + (1 of 3 overloads)</a> +</h5></div></div></div> +<p> + Gets the non-blocking mode of the native socket implementation. + </p> +<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">native_non_blocking</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function is used to retrieve the non-blocking mode of the underlying + native socket. This mode has no effect on the behaviour of the socket + object's synchronous operations. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.native_non_blocking.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.native_non_blocking.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.native_non_blocking.overload1.return_value">Return + Value</a> + </h6> +<p> + <code class="computeroutput"><span class="keyword">true</span></code> if the underlying socket + is in non-blocking mode and direct system calls may fail with <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">would_block</span></code> (or the equivalent system + error). + </p> +<h6> +<a name="boost_asio.reference.basic_socket.native_non_blocking.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_socket.native_non_blocking.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.native_non_blocking.overload1.remarks">Remarks</a> + </h6> +<p> + The current non-blocking mode is cached by the socket object. Consequently, + the return value may be incorrect if the non-blocking mode was set directly + on the native socket. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.native_non_blocking.overload1.h2"></a> + <span><a name="boost_asio.reference.basic_socket.native_non_blocking.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.native_non_blocking.overload1.example">Example</a> + </h6> +<p> + This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's <code class="computeroutput"><span class="identifier">sendfile</span></code> system + call might be encapsulated: + </p> +<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Handler</span><span class="special">></span> +<span class="keyword">struct</span> <span class="identifier">sendfile_op</span> +<span class="special">{</span> + <span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">&</span> <span class="identifier">sock_</span><span class="special">;</span> + <span class="keyword">int</span> <span class="identifier">fd_</span><span class="special">;</span> + <span class="identifier">Handler</span> <span class="identifier">handler_</span><span class="special">;</span> + <span class="identifier">off_t</span> <span class="identifier">offset_</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">total_bytes_transferred_</span><span class="special">;</span> + + <span class="comment">// Function call operator meeting WriteHandler requirements.</span> + <span class="comment">// Used as the handler for the async_write_some operation.</span> + <span class="keyword">void</span> <span class="keyword">operator</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">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> + <span class="special">{</span> + <span class="comment">// Put the underlying socket into non-blocking mode.</span> + <span class="keyword">if</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">sock_</span><span class="special">.</span><span class="identifier">native_non_blocking</span><span class="special">())</span> + <span class="identifier">sock_</span><span class="special">.</span><span class="identifier">native_non_blocking</span><span class="special">(</span><span class="keyword">true</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="keyword">for</span> <span class="special">(;;)</span> + <span class="special">{</span> + <span class="comment">// Try the system call.</span> + <span class="identifier">errno</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <span class="keyword">int</span> <span class="identifier">n</span> <span class="special">=</span> <span class="special">::</span><span class="identifier">sendfile</span><span class="special">(</span><span class="identifier">sock_</span><span class="special">.</span><span class="identifier">native_handle</span><span class="special">(),</span> <span class="identifier">fd_</span><span class="special">,</span> <span class="special">&</span><span class="identifier">offset_</span><span class="special">,</span> <span class="number">65536</span><span class="special">);</span> + <span class="identifier">ec</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">n</span> <span class="special"><</span> <span class="number">0</span> <span class="special">?</span> <span class="identifier">errno</span> <span class="special">:</span> <span class="number">0</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">error</span><span class="special">::</span><span class="identifier">get_system_category</span><span class="special">());</span> + <span class="identifier">total_bytes_transferred_</span> <span class="special">+=</span> <span class="identifier">ec</span> <span class="special">?</span> <span class="number">0</span> <span class="special">:</span> <span class="identifier">n</span><span class="special">;</span> + + <span class="comment">// Retry operation immediately if interrupted by signal.</span> + <span class="keyword">if</span> <span class="special">(</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">error</span><span class="special">::</span><span class="identifier">interrupted</span><span class="special">)</span> + <span class="keyword">continue</span><span class="special">;</span> + + <span class="comment">// Check if we need to run the operation again.</span> + <span class="keyword">if</span> <span class="special">(</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">error</span><span class="special">::</span><span class="identifier">would_block</span> + <span class="special">||</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">error</span><span class="special">::</span><span class="identifier">try_again</span><span class="special">)</span> + <span class="special">{</span> + <span class="comment">// We have to wait for the socket to become ready again.</span> + <span class="identifier">sock_</span><span class="special">.</span><span class="identifier">async_write_some</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">null_buffers</span><span class="special">(),</span> <span class="special">*</span><span class="keyword">this</span><span class="special">);</span> + <span class="keyword">return</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">n</span> <span class="special">==</span> <span class="number">0</span><span class="special">)</span> + <span class="special">{</span> + <span class="comment">// An error occurred, or we have reached the end of the file.</span> + <span class="comment">// Either way we must exit the loop so we can call the handler.</span> + <span class="keyword">break</span><span class="special">;</span> + <span class="special">}</span> + + <span class="comment">// Loop around to try calling sendfile again.</span> + <span class="special">}</span> + <span class="special">}</span> + + <span class="comment">// Pass result back to user's handler.</span> + <span class="identifier">handler_</span><span class="special">(</span><span class="identifier">ec</span><span class="special">,</span> <span class="identifier">total_bytes_transferred_</span><span class="special">);</span> + <span class="special">}</span> +<span class="special">};</span> + +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Handler</span><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">async_sendfile</span><span class="special">(</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">&</span> <span class="identifier">sock</span><span class="special">,</span> <span class="keyword">int</span> <span class="identifier">fd</span><span class="special">,</span> <span class="identifier">Handler</span> <span class="identifier">h</span><span class="special">)</span> +<span class="special">{</span> + <span class="identifier">sendfile_op</span><span class="special"><</span><span class="identifier">Handler</span><span class="special">></span> <span class="identifier">op</span> <span class="special">=</span> <span class="special">{</span> <span class="identifier">sock</span><span class="special">,</span> <span class="identifier">fd</span><span class="special">,</span> <span class="identifier">h</span><span class="special">,</span> <span class="number">0</span><span class="special">,</span> <span class="number">0</span> <span class="special">};</span> + <span class="identifier">sock</span><span class="special">.</span><span class="identifier">async_write_some</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">null_buffers</span><span class="special">(),</span> <span class="identifier">op</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-2012 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="../native_non_blocking.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../native_non_blocking.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/basic_socket/native_non_blocking/overload2.html b/doc/html/boost_asio/reference/basic_socket/native_non_blocking/overload2.html new file mode 100755 index 0000000000..063d8de9a3 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/native_non_blocking/overload2.html @@ -0,0 +1,164 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::native_non_blocking (2 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../native_non_blocking.html" title="basic_socket::native_non_blocking"> +<link rel="prev" href="overload1.html" title="basic_socket::native_non_blocking (1 of 3 overloads)"> +<link rel="next" href="overload3.html" title="basic_socket::native_non_blocking (3 of 3 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="../native_non_blocking.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.native_non_blocking.overload2"></a><a class="link" href="overload2.html" title="basic_socket::native_non_blocking (2 of 3 overloads)">basic_socket::native_non_blocking + (2 of 3 overloads)</a> +</h5></div></div></div> +<p> + Sets the non-blocking mode of the native socket implementation. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">native_non_blocking</span><span class="special">(</span> + <span class="keyword">bool</span> <span class="identifier">mode</span><span class="special">);</span> +</pre> +<p> + This function is used to modify the non-blocking mode of the underlying + native socket. It has no effect on the behaviour of the socket object's + synchronous operations. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.native_non_blocking.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.native_non_blocking.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.native_non_blocking.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">mode</span></dt> +<dd><p> + If <code class="computeroutput"><span class="keyword">true</span></code>, the underlying + socket is put into non-blocking mode and direct system calls may + fail with <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">would_block</span></code> + (or the equivalent system error). + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.native_non_blocking.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.native_non_blocking.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.native_non_blocking.overload2.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. If the <code class="computeroutput"><span class="identifier">mode</span></code> + is <code class="computeroutput"><span class="keyword">false</span></code>, but the + current value of <code class="computeroutput"><span class="identifier">non_blocking</span><span class="special">()</span></code> is <code class="computeroutput"><span class="keyword">true</span></code>, + this function fails with <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">invalid_argument</span></code>, + as the combination does not make sense. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.native_non_blocking.overload2.h2"></a> + <span><a name="boost_asio.reference.basic_socket.native_non_blocking.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.native_non_blocking.overload2.example">Example</a> + </h6> +<p> + This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's <code class="computeroutput"><span class="identifier">sendfile</span></code> system + call might be encapsulated: + </p> +<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Handler</span><span class="special">></span> +<span class="keyword">struct</span> <span class="identifier">sendfile_op</span> +<span class="special">{</span> + <span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">&</span> <span class="identifier">sock_</span><span class="special">;</span> + <span class="keyword">int</span> <span class="identifier">fd_</span><span class="special">;</span> + <span class="identifier">Handler</span> <span class="identifier">handler_</span><span class="special">;</span> + <span class="identifier">off_t</span> <span class="identifier">offset_</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">total_bytes_transferred_</span><span class="special">;</span> + + <span class="comment">// Function call operator meeting WriteHandler requirements.</span> + <span class="comment">// Used as the handler for the async_write_some operation.</span> + <span class="keyword">void</span> <span class="keyword">operator</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">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> + <span class="special">{</span> + <span class="comment">// Put the underlying socket into non-blocking mode.</span> + <span class="keyword">if</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">sock_</span><span class="special">.</span><span class="identifier">native_non_blocking</span><span class="special">())</span> + <span class="identifier">sock_</span><span class="special">.</span><span class="identifier">native_non_blocking</span><span class="special">(</span><span class="keyword">true</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="keyword">for</span> <span class="special">(;;)</span> + <span class="special">{</span> + <span class="comment">// Try the system call.</span> + <span class="identifier">errno</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <span class="keyword">int</span> <span class="identifier">n</span> <span class="special">=</span> <span class="special">::</span><span class="identifier">sendfile</span><span class="special">(</span><span class="identifier">sock_</span><span class="special">.</span><span class="identifier">native_handle</span><span class="special">(),</span> <span class="identifier">fd_</span><span class="special">,</span> <span class="special">&</span><span class="identifier">offset_</span><span class="special">,</span> <span class="number">65536</span><span class="special">);</span> + <span class="identifier">ec</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">n</span> <span class="special"><</span> <span class="number">0</span> <span class="special">?</span> <span class="identifier">errno</span> <span class="special">:</span> <span class="number">0</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">error</span><span class="special">::</span><span class="identifier">get_system_category</span><span class="special">());</span> + <span class="identifier">total_bytes_transferred_</span> <span class="special">+=</span> <span class="identifier">ec</span> <span class="special">?</span> <span class="number">0</span> <span class="special">:</span> <span class="identifier">n</span><span class="special">;</span> + + <span class="comment">// Retry operation immediately if interrupted by signal.</span> + <span class="keyword">if</span> <span class="special">(</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">error</span><span class="special">::</span><span class="identifier">interrupted</span><span class="special">)</span> + <span class="keyword">continue</span><span class="special">;</span> + + <span class="comment">// Check if we need to run the operation again.</span> + <span class="keyword">if</span> <span class="special">(</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">error</span><span class="special">::</span><span class="identifier">would_block</span> + <span class="special">||</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">error</span><span class="special">::</span><span class="identifier">try_again</span><span class="special">)</span> + <span class="special">{</span> + <span class="comment">// We have to wait for the socket to become ready again.</span> + <span class="identifier">sock_</span><span class="special">.</span><span class="identifier">async_write_some</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">null_buffers</span><span class="special">(),</span> <span class="special">*</span><span class="keyword">this</span><span class="special">);</span> + <span class="keyword">return</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">n</span> <span class="special">==</span> <span class="number">0</span><span class="special">)</span> + <span class="special">{</span> + <span class="comment">// An error occurred, or we have reached the end of the file.</span> + <span class="comment">// Either way we must exit the loop so we can call the handler.</span> + <span class="keyword">break</span><span class="special">;</span> + <span class="special">}</span> + + <span class="comment">// Loop around to try calling sendfile again.</span> + <span class="special">}</span> + <span class="special">}</span> + + <span class="comment">// Pass result back to user's handler.</span> + <span class="identifier">handler_</span><span class="special">(</span><span class="identifier">ec</span><span class="special">,</span> <span class="identifier">total_bytes_transferred_</span><span class="special">);</span> + <span class="special">}</span> +<span class="special">};</span> + +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Handler</span><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">async_sendfile</span><span class="special">(</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">&</span> <span class="identifier">sock</span><span class="special">,</span> <span class="keyword">int</span> <span class="identifier">fd</span><span class="special">,</span> <span class="identifier">Handler</span> <span class="identifier">h</span><span class="special">)</span> +<span class="special">{</span> + <span class="identifier">sendfile_op</span><span class="special"><</span><span class="identifier">Handler</span><span class="special">></span> <span class="identifier">op</span> <span class="special">=</span> <span class="special">{</span> <span class="identifier">sock</span><span class="special">,</span> <span class="identifier">fd</span><span class="special">,</span> <span class="identifier">h</span><span class="special">,</span> <span class="number">0</span><span class="special">,</span> <span class="number">0</span> <span class="special">};</span> + <span class="identifier">sock</span><span class="special">.</span><span class="identifier">async_write_some</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">null_buffers</span><span class="special">(),</span> <span class="identifier">op</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-2012 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="../native_non_blocking.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/basic_socket/native_non_blocking/overload3.html b/doc/html/boost_asio/reference/basic_socket/native_non_blocking/overload3.html new file mode 100755 index 0000000000..cafd0b45be --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/native_non_blocking/overload3.html @@ -0,0 +1,155 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::native_non_blocking (3 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../native_non_blocking.html" title="basic_socket::native_non_blocking"> +<link rel="prev" href="overload2.html" title="basic_socket::native_non_blocking (2 of 3 overloads)"> +<link rel="next" href="../native_type.html" title="basic_socket::native_type"> +</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="../native_non_blocking.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="../native_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.native_non_blocking.overload3"></a><a class="link" href="overload3.html" title="basic_socket::native_non_blocking (3 of 3 overloads)">basic_socket::native_non_blocking + (3 of 3 overloads)</a> +</h5></div></div></div> +<p> + Sets the non-blocking mode of the native socket implementation. + </p> +<pre class="programlisting"><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">native_non_blocking</span><span class="special">(</span> + <span class="keyword">bool</span> <span class="identifier">mode</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 is used to modify the non-blocking mode of the underlying + native socket. It has no effect on the behaviour of the socket object's + synchronous operations. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.native_non_blocking.overload3.h0"></a> + <span><a name="boost_asio.reference.basic_socket.native_non_blocking.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_socket.native_non_blocking.overload3.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">mode</span></dt> +<dd><p> + If <code class="computeroutput"><span class="keyword">true</span></code>, the underlying + socket is put into non-blocking mode and direct system calls may + fail with <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">would_block</span></code> + (or the equivalent system error). + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. If the <code class="computeroutput"><span class="identifier">mode</span></code> is <code class="computeroutput"><span class="keyword">false</span></code>, + but the current value of <code class="computeroutput"><span class="identifier">non_blocking</span><span class="special">()</span></code> is <code class="computeroutput"><span class="keyword">true</span></code>, + this function fails with <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">invalid_argument</span></code>, + as the combination does not make sense. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.native_non_blocking.overload3.h1"></a> + <span><a name="boost_asio.reference.basic_socket.native_non_blocking.overload3.example"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_socket.native_non_blocking.overload3.example">Example</a> + </h6> +<p> + This function is intended to allow the encapsulation of arbitrary non-blocking + system calls as asynchronous operations, in a way that is transparent + to the user of the socket object. The following example illustrates how + Linux's <code class="computeroutput"><span class="identifier">sendfile</span></code> system + call might be encapsulated: + </p> +<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Handler</span><span class="special">></span> +<span class="keyword">struct</span> <span class="identifier">sendfile_op</span> +<span class="special">{</span> + <span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">&</span> <span class="identifier">sock_</span><span class="special">;</span> + <span class="keyword">int</span> <span class="identifier">fd_</span><span class="special">;</span> + <span class="identifier">Handler</span> <span class="identifier">handler_</span><span class="special">;</span> + <span class="identifier">off_t</span> <span class="identifier">offset_</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">total_bytes_transferred_</span><span class="special">;</span> + + <span class="comment">// Function call operator meeting WriteHandler requirements.</span> + <span class="comment">// Used as the handler for the async_write_some operation.</span> + <span class="keyword">void</span> <span class="keyword">operator</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">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> + <span class="special">{</span> + <span class="comment">// Put the underlying socket into non-blocking mode.</span> + <span class="keyword">if</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">sock_</span><span class="special">.</span><span class="identifier">native_non_blocking</span><span class="special">())</span> + <span class="identifier">sock_</span><span class="special">.</span><span class="identifier">native_non_blocking</span><span class="special">(</span><span class="keyword">true</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="keyword">for</span> <span class="special">(;;)</span> + <span class="special">{</span> + <span class="comment">// Try the system call.</span> + <span class="identifier">errno</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <span class="keyword">int</span> <span class="identifier">n</span> <span class="special">=</span> <span class="special">::</span><span class="identifier">sendfile</span><span class="special">(</span><span class="identifier">sock_</span><span class="special">.</span><span class="identifier">native_handle</span><span class="special">(),</span> <span class="identifier">fd_</span><span class="special">,</span> <span class="special">&</span><span class="identifier">offset_</span><span class="special">,</span> <span class="number">65536</span><span class="special">);</span> + <span class="identifier">ec</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">n</span> <span class="special"><</span> <span class="number">0</span> <span class="special">?</span> <span class="identifier">errno</span> <span class="special">:</span> <span class="number">0</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">error</span><span class="special">::</span><span class="identifier">get_system_category</span><span class="special">());</span> + <span class="identifier">total_bytes_transferred_</span> <span class="special">+=</span> <span class="identifier">ec</span> <span class="special">?</span> <span class="number">0</span> <span class="special">:</span> <span class="identifier">n</span><span class="special">;</span> + + <span class="comment">// Retry operation immediately if interrupted by signal.</span> + <span class="keyword">if</span> <span class="special">(</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">error</span><span class="special">::</span><span class="identifier">interrupted</span><span class="special">)</span> + <span class="keyword">continue</span><span class="special">;</span> + + <span class="comment">// Check if we need to run the operation again.</span> + <span class="keyword">if</span> <span class="special">(</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">error</span><span class="special">::</span><span class="identifier">would_block</span> + <span class="special">||</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">error</span><span class="special">::</span><span class="identifier">try_again</span><span class="special">)</span> + <span class="special">{</span> + <span class="comment">// We have to wait for the socket to become ready again.</span> + <span class="identifier">sock_</span><span class="special">.</span><span class="identifier">async_write_some</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">null_buffers</span><span class="special">(),</span> <span class="special">*</span><span class="keyword">this</span><span class="special">);</span> + <span class="keyword">return</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">n</span> <span class="special">==</span> <span class="number">0</span><span class="special">)</span> + <span class="special">{</span> + <span class="comment">// An error occurred, or we have reached the end of the file.</span> + <span class="comment">// Either way we must exit the loop so we can call the handler.</span> + <span class="keyword">break</span><span class="special">;</span> + <span class="special">}</span> + + <span class="comment">// Loop around to try calling sendfile again.</span> + <span class="special">}</span> + <span class="special">}</span> + + <span class="comment">// Pass result back to user's handler.</span> + <span class="identifier">handler_</span><span class="special">(</span><span class="identifier">ec</span><span class="special">,</span> <span class="identifier">total_bytes_transferred_</span><span class="special">);</span> + <span class="special">}</span> +<span class="special">};</span> + +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Handler</span><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">async_sendfile</span><span class="special">(</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">&</span> <span class="identifier">sock</span><span class="special">,</span> <span class="keyword">int</span> <span class="identifier">fd</span><span class="special">,</span> <span class="identifier">Handler</span> <span class="identifier">h</span><span class="special">)</span> +<span class="special">{</span> + <span class="identifier">sendfile_op</span><span class="special"><</span><span class="identifier">Handler</span><span class="special">></span> <span class="identifier">op</span> <span class="special">=</span> <span class="special">{</span> <span class="identifier">sock</span><span class="special">,</span> <span class="identifier">fd</span><span class="special">,</span> <span class="identifier">h</span><span class="special">,</span> <span class="number">0</span><span class="special">,</span> <span class="number">0</span> <span class="special">};</span> + <span class="identifier">sock</span><span class="special">.</span><span class="identifier">async_write_some</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">null_buffers</span><span class="special">(),</span> <span class="identifier">op</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-2012 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="../native_non_blocking.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="../native_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/native_type.html b/doc/html/boost_asio/reference/basic_socket/native_type.html new file mode 100755 index 0000000000..5073223a86 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/native_type.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::native_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="native_non_blocking/overload3.html" title="basic_socket::native_non_blocking (3 of 3 overloads)"> +<link rel="next" href="non_blocking.html" title="basic_socket::non_blocking"> +</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="native_non_blocking/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="non_blocking.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.basic_socket.native_type"></a><a class="link" href="native_type.html" title="basic_socket::native_type">basic_socket::native_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1114748"></a> +(Deprecated: Use native_handle_type.) The native + representation of a socket. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">SocketService</span><span class="special">::</span><span class="identifier">native_handle_type</span> <span class="identifier">native_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.native_type.h0"></a> + <span><a name="boost_asio.reference.basic_socket.native_type.requirements"></a></span><a class="link" href="native_type.html#boost_asio.reference.basic_socket.native_type.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="native_non_blocking/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="non_blocking.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/non_blocking.html b/doc/html/boost_asio/reference/basic_socket/non_blocking.html new file mode 100755 index 0000000000..d0dff34211 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/non_blocking.html @@ -0,0 +1,62 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::non_blocking</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="native_type.html" title="basic_socket::native_type"> +<link rel="next" href="non_blocking/overload1.html" title="basic_socket::non_blocking (1 of 3 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="native_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="non_blocking/overload1.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.basic_socket.non_blocking"></a><a class="link" href="non_blocking.html" title="basic_socket::non_blocking">basic_socket::non_blocking</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1114869"></a> +Gets the non-blocking mode of the socket. + </p> +<pre class="programlisting"><span class="keyword">bool</span> <a class="link" href="non_blocking/overload1.html" title="basic_socket::non_blocking (1 of 3 overloads)">non_blocking</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="non_blocking/overload1.html" title="basic_socket::non_blocking (1 of 3 overloads)">more...</a></em></span> +</pre> +<p> + Sets the non-blocking mode of the socket. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="non_blocking/overload2.html" title="basic_socket::non_blocking (2 of 3 overloads)">non_blocking</a><span class="special">(</span> + <span class="keyword">bool</span> <span class="identifier">mode</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="non_blocking/overload2.html" title="basic_socket::non_blocking (2 of 3 overloads)">more...</a></em></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> <a class="link" href="non_blocking/overload3.html" title="basic_socket::non_blocking (3 of 3 overloads)">non_blocking</a><span class="special">(</span> + <span class="keyword">bool</span> <span class="identifier">mode</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> + <span class="emphasis"><em>» <a class="link" href="non_blocking/overload3.html" title="basic_socket::non_blocking (3 of 3 overloads)">more...</a></em></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-2012 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="native_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="non_blocking/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/non_blocking/overload1.html b/doc/html/boost_asio/reference/basic_socket/non_blocking/overload1.html new file mode 100755 index 0000000000..0e26d011bd --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/non_blocking/overload1.html @@ -0,0 +1,69 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::non_blocking (1 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../non_blocking.html" title="basic_socket::non_blocking"> +<link rel="prev" href="../non_blocking.html" title="basic_socket::non_blocking"> +<link rel="next" href="overload2.html" title="basic_socket::non_blocking (2 of 3 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="../non_blocking.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_blocking.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.non_blocking.overload1"></a><a class="link" href="overload1.html" title="basic_socket::non_blocking (1 of 3 overloads)">basic_socket::non_blocking + (1 of 3 overloads)</a> +</h5></div></div></div> +<p> + Gets the non-blocking mode of the socket. + </p> +<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">non_blocking</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.non_blocking.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.non_blocking.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.non_blocking.overload1.return_value">Return + Value</a> + </h6> +<p> + <code class="computeroutput"><span class="keyword">true</span></code> if the socket's synchronous + operations will fail with <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">would_block</span></code> + if they are unable to perform the requested operation immediately. If + <code class="computeroutput"><span class="keyword">false</span></code>, synchronous operations + will block until complete. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.non_blocking.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_socket.non_blocking.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.non_blocking.overload1.remarks">Remarks</a> + </h6> +<p> + The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error <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">would_block</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="../non_blocking.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_blocking.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/basic_socket/non_blocking/overload2.html b/doc/html/boost_asio/reference/basic_socket/non_blocking/overload2.html new file mode 100755 index 0000000000..542bd01a71 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/non_blocking/overload2.html @@ -0,0 +1,88 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::non_blocking (2 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../non_blocking.html" title="basic_socket::non_blocking"> +<link rel="prev" href="overload1.html" title="basic_socket::non_blocking (1 of 3 overloads)"> +<link rel="next" href="overload3.html" title="basic_socket::non_blocking (3 of 3 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="../non_blocking.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.non_blocking.overload2"></a><a class="link" href="overload2.html" title="basic_socket::non_blocking (2 of 3 overloads)">basic_socket::non_blocking + (2 of 3 overloads)</a> +</h5></div></div></div> +<p> + Sets the non-blocking mode of the socket. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">non_blocking</span><span class="special">(</span> + <span class="keyword">bool</span> <span class="identifier">mode</span><span class="special">);</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.non_blocking.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.non_blocking.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.non_blocking.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">mode</span></dt> +<dd><p> + If <code class="computeroutput"><span class="keyword">true</span></code>, the socket's + synchronous operations will fail with <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">would_block</span></code> + if they are unable to perform the requested operation immediately. + If <code class="computeroutput"><span class="keyword">false</span></code>, synchronous + operations will block until complete. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.non_blocking.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.non_blocking.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.non_blocking.overload2.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.non_blocking.overload2.h2"></a> + <span><a name="boost_asio.reference.basic_socket.non_blocking.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.non_blocking.overload2.remarks">Remarks</a> + </h6> +<p> + The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error <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">would_block</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="../non_blocking.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/basic_socket/non_blocking/overload3.html b/doc/html/boost_asio/reference/basic_socket/non_blocking/overload3.html new file mode 100755 index 0000000000..105df6cee7 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/non_blocking/overload3.html @@ -0,0 +1,80 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::non_blocking (3 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../non_blocking.html" title="basic_socket::non_blocking"> +<link rel="prev" href="overload2.html" title="basic_socket::non_blocking (2 of 3 overloads)"> +<link rel="next" href="../non_blocking_io.html" title="basic_socket::non_blocking_io"> +</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="../non_blocking.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="../non_blocking_io.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.non_blocking.overload3"></a><a class="link" href="overload3.html" title="basic_socket::non_blocking (3 of 3 overloads)">basic_socket::non_blocking + (3 of 3 overloads)</a> +</h5></div></div></div> +<p> + Sets the non-blocking mode of the socket. + </p> +<pre class="programlisting"><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">non_blocking</span><span class="special">(</span> + <span class="keyword">bool</span> <span class="identifier">mode</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> +<h6> +<a name="boost_asio.reference.basic_socket.non_blocking.overload3.h0"></a> + <span><a name="boost_asio.reference.basic_socket.non_blocking.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_socket.non_blocking.overload3.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">mode</span></dt> +<dd><p> + If <code class="computeroutput"><span class="keyword">true</span></code>, the socket's + synchronous operations will fail with <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">would_block</span></code> + if they are unable to perform the requested operation immediately. + If <code class="computeroutput"><span class="keyword">false</span></code>, synchronous + operations will block until complete. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.non_blocking.overload3.h1"></a> + <span><a name="boost_asio.reference.basic_socket.non_blocking.overload3.remarks"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_socket.non_blocking.overload3.remarks">Remarks</a> + </h6> +<p> + The non-blocking mode has no effect on the behaviour of asynchronous + operations. Asynchronous operations will never fail with the error <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">would_block</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="../non_blocking.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="../non_blocking_io.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/non_blocking_io.html b/doc/html/boost_asio/reference/basic_socket/non_blocking_io.html new file mode 100755 index 0000000000..e65bdd5d89 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/non_blocking_io.html @@ -0,0 +1,75 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::non_blocking_io</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="non_blocking/overload3.html" title="basic_socket::non_blocking (3 of 3 overloads)"> +<link rel="next" href="open.html" title="basic_socket::open"> +</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="non_blocking/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="open.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.basic_socket.non_blocking_io"></a><a class="link" href="non_blocking_io.html" title="basic_socket::non_blocking_io">basic_socket::non_blocking_io</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1115913"></a> +(Deprecated: Use non_blocking().) IO control + command to set the blocking mode of the socket. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">non_blocking_io</span><span class="special">;</span> +</pre> +<p> + Implements the FIONBIO IO control command. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.non_blocking_io.h0"></a> + <span><a name="boost_asio.reference.basic_socket.non_blocking_io.example"></a></span><a class="link" href="non_blocking_io.html#boost_asio.reference.basic_socket.non_blocking_io.example">Example</a> + </h6> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">non_blocking_io</span> <span class="identifier">command</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">io_control</span><span class="special">(</span><span class="identifier">command</span><span class="special">);</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.non_blocking_io.h1"></a> + <span><a name="boost_asio.reference.basic_socket.non_blocking_io.requirements"></a></span><a class="link" href="non_blocking_io.html#boost_asio.reference.basic_socket.non_blocking_io.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="non_blocking/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="open.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/open.html b/doc/html/boost_asio/reference/basic_socket/open.html new file mode 100755 index 0000000000..c7bc4edb23 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/open.html @@ -0,0 +1,56 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::open</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="non_blocking_io.html" title="basic_socket::non_blocking_io"> +<link rel="next" href="open/overload1.html" title="basic_socket::open (1 of 2 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="non_blocking_io.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="open/overload1.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.basic_socket.open"></a><a class="link" href="open.html" title="basic_socket::open">basic_socket::open</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1116203"></a> +Open the socket using the specified protocol. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="open/overload1.html" title="basic_socket::open (1 of 2 overloads)">open</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">protocol_type</span> <span class="special">&</span> <span class="identifier">protocol</span> <span class="special">=</span> <span class="identifier">protocol_type</span><span class="special">());</span> + <span class="emphasis"><em>» <a class="link" href="open/overload1.html" title="basic_socket::open (1 of 2 overloads)">more...</a></em></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> <a class="link" href="open/overload2.html" title="basic_socket::open (2 of 2 overloads)">open</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">protocol_type</span> <span class="special">&</span> <span class="identifier">protocol</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> + <span class="emphasis"><em>» <a class="link" href="open/overload2.html" title="basic_socket::open (2 of 2 overloads)">more...</a></em></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-2012 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="non_blocking_io.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="open/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/open/overload1.html b/doc/html/boost_asio/reference/basic_socket/open/overload1.html new file mode 100755 index 0000000000..9f770723db --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/open/overload1.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::open (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../open.html" title="basic_socket::open"> +<link rel="prev" href="../open.html" title="basic_socket::open"> +<link rel="next" href="overload2.html" title="basic_socket::open (2 of 2 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="../open.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../open.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.open.overload1"></a><a class="link" href="overload1.html" title="basic_socket::open (1 of 2 overloads)">basic_socket::open + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Open the socket using the specified protocol. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">open</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">protocol_type</span> <span class="special">&</span> <span class="identifier">protocol</span> <span class="special">=</span> <span class="identifier">protocol_type</span><span class="special">());</span> +</pre> +<p> + This function opens the socket so that it will use the specified protocol. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.open.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.open.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.open.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">protocol</span></dt> +<dd><p> + An object specifying protocol parameters to be used. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.open.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_socket.open.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.open.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.open.overload1.h2"></a> + <span><a name="boost_asio.reference.basic_socket.open.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.open.overload1.example">Example</a> + </h6> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">open</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">v4</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-2012 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="../open.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../open.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/basic_socket/open/overload2.html b/doc/html/boost_asio/reference/basic_socket/open/overload2.html new file mode 100755 index 0000000000..b92a4caad7 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/open/overload2.html @@ -0,0 +1,83 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::open (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../open.html" title="basic_socket::open"> +<link rel="prev" href="overload1.html" title="basic_socket::open (1 of 2 overloads)"> +<link rel="next" href="../operator_eq_.html" title="basic_socket::operator="> +</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="../open.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="../operator_eq_.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.open.overload2"></a><a class="link" href="overload2.html" title="basic_socket::open (2 of 2 overloads)">basic_socket::open + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Open the socket using the specified protocol. + </p> +<pre class="programlisting"><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">open</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">protocol_type</span> <span class="special">&</span> <span class="identifier">protocol</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 opens the socket so that it will use the specified protocol. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.open.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.open.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.open.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">protocol</span></dt> +<dd><p> + An object specifying which protocol is to be used. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.open.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.open.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.open.overload2.example">Example</a> + </h6> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</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">socket</span><span class="special">.</span><span class="identifier">open</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">v4</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-2012 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="../open.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="../operator_eq_.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/operator_eq_.html b/doc/html/boost_asio/reference/basic_socket/operator_eq_.html new file mode 100755 index 0000000000..75ade31298 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/operator_eq_.html @@ -0,0 +1,75 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::operator=</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="open/overload2.html" title="basic_socket::open (2 of 2 overloads)"> +<link rel="next" href="protocol_type.html" title="basic_socket::protocol_type"> +</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="open/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="protocol_type.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.basic_socket.operator_eq_"></a><a class="link" href="operator_eq_.html" title="basic_socket::operator=">basic_socket::operator=</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1117174"></a> +Move-assign a <a class="link" href="../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a> from another. + </p> +<pre class="programlisting"><span class="identifier">basic_socket</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">=(</span> + <span class="identifier">basic_socket</span> <span class="special">&&</span> <span class="identifier">other</span><span class="special">);</span> +</pre> +<p> + This assignment operator moves a socket from one object to another. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.operator_eq_.h0"></a> + <span><a name="boost_asio.reference.basic_socket.operator_eq_.parameters"></a></span><a class="link" href="operator_eq_.html#boost_asio.reference.basic_socket.operator_eq_.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">other</span></dt> +<dd><p> + The other <a class="link" href="../basic_socket.html" title="basic_socket"><code class="computeroutput"><span class="identifier">basic_socket</span></code></a> object from + which the move will occur. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.operator_eq_.h1"></a> + <span><a name="boost_asio.reference.basic_socket.operator_eq_.remarks"></a></span><a class="link" href="operator_eq_.html#boost_asio.reference.basic_socket.operator_eq_.remarks">Remarks</a> + </h6> +<p> + Following the move, the moved-from object is in the same state as if constructed + using the <code class="computeroutput"><span class="identifier">basic_socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">&)</span> <span class="identifier">constructor</span></code>. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="open/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="protocol_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/protocol_type.html b/doc/html/boost_asio/reference/basic_socket/protocol_type.html new file mode 100755 index 0000000000..b0c385b238 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/protocol_type.html @@ -0,0 +1,59 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::protocol_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="operator_eq_.html" title="basic_socket::operator="> +<link rel="next" href="receive_buffer_size.html" title="basic_socket::receive_buffer_size"> +</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="operator_eq_.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="receive_buffer_size.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.basic_socket.protocol_type"></a><a class="link" href="protocol_type.html" title="basic_socket::protocol_type">basic_socket::protocol_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1117396"></a> +The protocol type. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">Protocol</span> <span class="identifier">protocol_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.protocol_type.h0"></a> + <span><a name="boost_asio.reference.basic_socket.protocol_type.requirements"></a></span><a class="link" href="protocol_type.html#boost_asio.reference.basic_socket.protocol_type.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="operator_eq_.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="receive_buffer_size.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/receive_buffer_size.html b/doc/html/boost_asio/reference/basic_socket/receive_buffer_size.html new file mode 100755 index 0000000000..41373051c9 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/receive_buffer_size.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::receive_buffer_size</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="protocol_type.html" title="basic_socket::protocol_type"> +<link rel="next" href="receive_low_watermark.html" title="basic_socket::receive_low_watermark"> +</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="protocol_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="receive_low_watermark.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.basic_socket.receive_buffer_size"></a><a class="link" href="receive_buffer_size.html" title="basic_socket::receive_buffer_size">basic_socket::receive_buffer_size</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1117513"></a> +Socket option for the receive buffer size + of a socket. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">receive_buffer_size</span><span class="special">;</span> +</pre> +<p> + Implements the SOL_SOCKET/SO_RCVBUF socket option. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.receive_buffer_size.h0"></a> + <span><a name="boost_asio.reference.basic_socket.receive_buffer_size.examples"></a></span><a class="link" href="receive_buffer_size.html#boost_asio.reference.basic_socket.receive_buffer_size.examples">Examples</a> + </h6> +<p> + Setting the option: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">receive_buffer_size</span> <span class="identifier">option</span><span class="special">(</span><span class="number">8192</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +</pre> +<p> + Getting the current option value: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">receive_buffer_size</span> <span class="identifier">option</span><span class="special">;</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +<span class="keyword">int</span> <span class="identifier">size</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">value</span><span class="special">();</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.receive_buffer_size.h1"></a> + <span><a name="boost_asio.reference.basic_socket.receive_buffer_size.requirements"></a></span><a class="link" href="receive_buffer_size.html#boost_asio.reference.basic_socket.receive_buffer_size.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="protocol_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="receive_low_watermark.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/receive_low_watermark.html b/doc/html/boost_asio/reference/basic_socket/receive_low_watermark.html new file mode 100755 index 0000000000..fcc1e8d204 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/receive_low_watermark.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::receive_low_watermark</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="receive_buffer_size.html" title="basic_socket::receive_buffer_size"> +<link rel="next" href="remote_endpoint.html" title="basic_socket::remote_endpoint"> +</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="receive_buffer_size.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="remote_endpoint.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.basic_socket.receive_low_watermark"></a><a class="link" href="receive_low_watermark.html" title="basic_socket::receive_low_watermark">basic_socket::receive_low_watermark</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1117996"></a> +Socket option for the receive low watermark. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">receive_low_watermark</span><span class="special">;</span> +</pre> +<p> + Implements the SOL_SOCKET/SO_RCVLOWAT socket option. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.receive_low_watermark.h0"></a> + <span><a name="boost_asio.reference.basic_socket.receive_low_watermark.examples"></a></span><a class="link" href="receive_low_watermark.html#boost_asio.reference.basic_socket.receive_low_watermark.examples">Examples</a> + </h6> +<p> + Setting the option: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">receive_low_watermark</span> <span class="identifier">option</span><span class="special">(</span><span class="number">1024</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +</pre> +<p> + Getting the current option value: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">receive_low_watermark</span> <span class="identifier">option</span><span class="special">;</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +<span class="keyword">int</span> <span class="identifier">size</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">value</span><span class="special">();</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.receive_low_watermark.h1"></a> + <span><a name="boost_asio.reference.basic_socket.receive_low_watermark.requirements"></a></span><a class="link" href="receive_low_watermark.html#boost_asio.reference.basic_socket.receive_low_watermark.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="receive_buffer_size.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="remote_endpoint.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/remote_endpoint.html b/doc/html/boost_asio/reference/basic_socket/remote_endpoint.html new file mode 100755 index 0000000000..fbf755f85a --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/remote_endpoint.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::remote_endpoint</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="receive_low_watermark.html" title="basic_socket::receive_low_watermark"> +<link rel="next" href="remote_endpoint/overload1.html" title="basic_socket::remote_endpoint (1 of 2 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="receive_low_watermark.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="remote_endpoint/overload1.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.basic_socket.remote_endpoint"></a><a class="link" href="remote_endpoint.html" title="basic_socket::remote_endpoint">basic_socket::remote_endpoint</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1118743"></a> +Get the remote endpoint of the socket. + </p> +<pre class="programlisting"><span class="identifier">endpoint_type</span> <a class="link" href="remote_endpoint/overload1.html" title="basic_socket::remote_endpoint (1 of 2 overloads)">remote_endpoint</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="remote_endpoint/overload1.html" title="basic_socket::remote_endpoint (1 of 2 overloads)">more...</a></em></span> + +<span class="identifier">endpoint_type</span> <a class="link" href="remote_endpoint/overload2.html" title="basic_socket::remote_endpoint (2 of 2 overloads)">remote_endpoint</a><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> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="remote_endpoint/overload2.html" title="basic_socket::remote_endpoint (2 of 2 overloads)">more...</a></em></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-2012 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="receive_low_watermark.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="remote_endpoint/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/remote_endpoint/overload1.html b/doc/html/boost_asio/reference/basic_socket/remote_endpoint/overload1.html new file mode 100755 index 0000000000..921ebd356d --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/remote_endpoint/overload1.html @@ -0,0 +1,81 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::remote_endpoint (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../remote_endpoint.html" title="basic_socket::remote_endpoint"> +<link rel="prev" href="../remote_endpoint.html" title="basic_socket::remote_endpoint"> +<link rel="next" href="overload2.html" title="basic_socket::remote_endpoint (2 of 2 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="../remote_endpoint.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../remote_endpoint.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.remote_endpoint.overload1"></a><a class="link" href="overload1.html" title="basic_socket::remote_endpoint (1 of 2 overloads)">basic_socket::remote_endpoint + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Get the remote endpoint of the socket. + </p> +<pre class="programlisting"><span class="identifier">endpoint_type</span> <span class="identifier">remote_endpoint</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function is used to obtain the remote endpoint of the socket. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.remote_endpoint.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.remote_endpoint.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.remote_endpoint.overload1.return_value">Return + Value</a> + </h6> +<p> + An object that represents the remote endpoint of the socket. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.remote_endpoint.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_socket.remote_endpoint.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.remote_endpoint.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.remote_endpoint.overload1.h2"></a> + <span><a name="boost_asio.reference.basic_socket.remote_endpoint.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.remote_endpoint.overload1.example">Example</a> + </h6> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">endpoint</span> <span class="identifier">endpoint</span> <span class="special">=</span> <span class="identifier">socket</span><span class="special">.</span><span class="identifier">remote_endpoint</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-2012 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="../remote_endpoint.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../remote_endpoint.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/basic_socket/remote_endpoint/overload2.html b/doc/html/boost_asio/reference/basic_socket/remote_endpoint/overload2.html new file mode 100755 index 0000000000..320730058b --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/remote_endpoint/overload2.html @@ -0,0 +1,88 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::remote_endpoint (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../remote_endpoint.html" title="basic_socket::remote_endpoint"> +<link rel="prev" href="overload1.html" title="basic_socket::remote_endpoint (1 of 2 overloads)"> +<link rel="next" href="../reuse_address.html" title="basic_socket::reuse_address"> +</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="../remote_endpoint.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="../reuse_address.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.remote_endpoint.overload2"></a><a class="link" href="overload2.html" title="basic_socket::remote_endpoint (2 of 2 overloads)">basic_socket::remote_endpoint + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Get the remote endpoint of the socket. + </p> +<pre class="programlisting"><span class="identifier">endpoint_type</span> <span class="identifier">remote_endpoint</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> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function is used to obtain the remote endpoint of the socket. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.remote_endpoint.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.remote_endpoint.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.remote_endpoint.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.remote_endpoint.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.remote_endpoint.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.remote_endpoint.overload2.return_value">Return + Value</a> + </h6> +<p> + An object that represents the remote endpoint of the socket. Returns + a default-constructed endpoint object if an error occurred. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.remote_endpoint.overload2.h2"></a> + <span><a name="boost_asio.reference.basic_socket.remote_endpoint.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.remote_endpoint.overload2.example">Example</a> + </h6> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">endpoint</span> <span class="identifier">endpoint</span> <span class="special">=</span> <span class="identifier">socket</span><span class="special">.</span><span class="identifier">remote_endpoint</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-2012 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="../remote_endpoint.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="../reuse_address.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/reuse_address.html b/doc/html/boost_asio/reference/basic_socket/reuse_address.html new file mode 100755 index 0000000000..2c17e1e7f4 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/reuse_address.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::reuse_address</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="remote_endpoint/overload2.html" title="basic_socket::remote_endpoint (2 of 2 overloads)"> +<link rel="next" href="send_buffer_size.html" title="basic_socket::send_buffer_size"> +</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="remote_endpoint/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="send_buffer_size.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.basic_socket.reuse_address"></a><a class="link" href="reuse_address.html" title="basic_socket::reuse_address">basic_socket::reuse_address</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1119628"></a> +Socket option to allow the socket to be bound + to an address that is already in use. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">reuse_address</span><span class="special">;</span> +</pre> +<p> + Implements the SOL_SOCKET/SO_REUSEADDR socket option. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.reuse_address.h0"></a> + <span><a name="boost_asio.reference.basic_socket.reuse_address.examples"></a></span><a class="link" href="reuse_address.html#boost_asio.reference.basic_socket.reuse_address.examples">Examples</a> + </h6> +<p> + Setting the option: + </p> +<pre class="programlisting"><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">acceptor</span> <span class="identifier">acceptor</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">reuse_address</span> <span class="identifier">option</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span> +<span class="identifier">acceptor</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +</pre> +<p> + Getting the current option value: + </p> +<pre class="programlisting"><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">acceptor</span> <span class="identifier">acceptor</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">reuse_address</span> <span class="identifier">option</span><span class="special">;</span> +<span class="identifier">acceptor</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +<span class="keyword">bool</span> <span class="identifier">is_set</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">value</span><span class="special">();</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.reuse_address.h1"></a> + <span><a name="boost_asio.reference.basic_socket.reuse_address.requirements"></a></span><a class="link" href="reuse_address.html#boost_asio.reference.basic_socket.reuse_address.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="remote_endpoint/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="send_buffer_size.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/send_buffer_size.html b/doc/html/boost_asio/reference/basic_socket/send_buffer_size.html new file mode 100755 index 0000000000..7d6e342081 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/send_buffer_size.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::send_buffer_size</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="reuse_address.html" title="basic_socket::reuse_address"> +<link rel="next" href="send_low_watermark.html" title="basic_socket::send_low_watermark"> +</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="reuse_address.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="send_low_watermark.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.basic_socket.send_buffer_size"></a><a class="link" href="send_buffer_size.html" title="basic_socket::send_buffer_size">basic_socket::send_buffer_size</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1120108"></a> +Socket option for the send buffer size of a + socket. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">send_buffer_size</span><span class="special">;</span> +</pre> +<p> + Implements the SOL_SOCKET/SO_SNDBUF socket option. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.send_buffer_size.h0"></a> + <span><a name="boost_asio.reference.basic_socket.send_buffer_size.examples"></a></span><a class="link" href="send_buffer_size.html#boost_asio.reference.basic_socket.send_buffer_size.examples">Examples</a> + </h6> +<p> + Setting the option: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">send_buffer_size</span> <span class="identifier">option</span><span class="special">(</span><span class="number">8192</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +</pre> +<p> + Getting the current option value: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">send_buffer_size</span> <span class="identifier">option</span><span class="special">;</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +<span class="keyword">int</span> <span class="identifier">size</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">value</span><span class="special">();</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.send_buffer_size.h1"></a> + <span><a name="boost_asio.reference.basic_socket.send_buffer_size.requirements"></a></span><a class="link" href="send_buffer_size.html#boost_asio.reference.basic_socket.send_buffer_size.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="reuse_address.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="send_low_watermark.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/send_low_watermark.html b/doc/html/boost_asio/reference/basic_socket/send_low_watermark.html new file mode 100755 index 0000000000..e62ac3ac59 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/send_low_watermark.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::send_low_watermark</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="send_buffer_size.html" title="basic_socket::send_buffer_size"> +<link rel="next" href="service.html" title="basic_socket::service"> +</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="send_buffer_size.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="service.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.basic_socket.send_low_watermark"></a><a class="link" href="send_low_watermark.html" title="basic_socket::send_low_watermark">basic_socket::send_low_watermark</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1120589"></a> +Socket option for the send low watermark. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">send_low_watermark</span><span class="special">;</span> +</pre> +<p> + Implements the SOL_SOCKET/SO_SNDLOWAT socket option. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.send_low_watermark.h0"></a> + <span><a name="boost_asio.reference.basic_socket.send_low_watermark.examples"></a></span><a class="link" href="send_low_watermark.html#boost_asio.reference.basic_socket.send_low_watermark.examples">Examples</a> + </h6> +<p> + Setting the option: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">send_low_watermark</span> <span class="identifier">option</span><span class="special">(</span><span class="number">1024</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +</pre> +<p> + Getting the current option value: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket_base</span><span class="special">::</span><span class="identifier">send_low_watermark</span> <span class="identifier">option</span><span class="special">;</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span> +<span class="keyword">int</span> <span class="identifier">size</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">value</span><span class="special">();</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.send_low_watermark.h1"></a> + <span><a name="boost_asio.reference.basic_socket.send_low_watermark.requirements"></a></span><a class="link" href="send_low_watermark.html#boost_asio.reference.basic_socket.send_low_watermark.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="send_buffer_size.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/service.html b/doc/html/boost_asio/reference/basic_socket/service.html new file mode 100755 index 0000000000..548e7de798 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/service.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::service</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="send_low_watermark.html" title="basic_socket::send_low_watermark"> +<link rel="next" href="service_type.html" title="basic_socket::service_type"> +</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="send_low_watermark.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="service_type.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.basic_socket.service"></a><a class="link" href="service.html" title="basic_socket::service">basic_socket::service</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="id1121071"></a> +(Deprecated: Use <code class="computeroutput"><span class="identifier">get_service</span><span class="special">()</span></code>.) The service associated with the I/O + object. + </p> +<pre class="programlisting"><span class="identifier">service_type</span> <span class="special">&</span> <span class="identifier">service</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.service.h0"></a> + <span><a name="boost_asio.reference.basic_socket.service.remarks"></a></span><a class="link" href="service.html#boost_asio.reference.basic_socket.service.remarks">Remarks</a> + </h6> +<p> + Available only for services that do not support movability. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="send_low_watermark.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="service_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/service_type.html b/doc/html/boost_asio/reference/basic_socket/service_type.html new file mode 100755 index 0000000000..e72658ec7b --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/service_type.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::service_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="service.html" title="basic_socket::service"> +<link rel="next" href="set_option.html" title="basic_socket::set_option"> +</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="service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="set_option.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.basic_socket.service_type"></a><a class="link" href="service_type.html" title="basic_socket::service_type">basic_socket::service_type</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="id1121181"></a> +The type of the service that will be used to provide + I/O operations. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">SocketService</span> <span class="identifier">service_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_socket.service_type.h0"></a> + <span><a name="boost_asio.reference.basic_socket.service_type.requirements"></a></span><a class="link" href="service_type.html#boost_asio.reference.basic_socket.service_type.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/basic_socket.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 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="service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="set_option.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/set_option.html b/doc/html/boost_asio/reference/basic_socket/set_option.html new file mode 100755 index 0000000000..c613f890d6 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/set_option.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::set_option</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="service_type.html" title="basic_socket::service_type"> +<link rel="next" href="set_option/overload1.html" title="basic_socket::set_option (1 of 2 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="service_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="set_option/overload1.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.basic_socket.set_option"></a><a class="link" href="set_option.html" title="basic_socket::set_option">basic_socket::set_option</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1121292"></a> +Set an option on the socket. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../SettableSocketOption.html" title="Settable socket option requirements">SettableSocketOption</a><span class="special">></span> +<span class="keyword">void</span> <a class="link" href="set_option/overload1.html" title="basic_socket::set_option (1 of 2 overloads)">set_option</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">SettableSocketOption</span> <span class="special">&</span> <span class="identifier">option</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="set_option/overload1.html" title="basic_socket::set_option (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../SettableSocketOption.html" title="Settable socket option requirements">SettableSocketOption</a><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> <a class="link" href="set_option/overload2.html" title="basic_socket::set_option (2 of 2 overloads)">set_option</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">SettableSocketOption</span> <span class="special">&</span> <span class="identifier">option</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> + <span class="emphasis"><em>» <a class="link" href="set_option/overload2.html" title="basic_socket::set_option (2 of 2 overloads)">more...</a></em></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-2012 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="service_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="set_option/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/set_option/overload1.html b/doc/html/boost_asio/reference/basic_socket/set_option/overload1.html new file mode 100755 index 0000000000..b4b8611eb4 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/set_option/overload1.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::set_option (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../set_option.html" title="basic_socket::set_option"> +<link rel="prev" href="../set_option.html" title="basic_socket::set_option"> +<link rel="next" href="overload2.html" title="basic_socket::set_option (2 of 2 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="../set_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set_option.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.set_option.overload1"></a><a class="link" href="overload1.html" title="basic_socket::set_option (1 of 2 overloads)">basic_socket::set_option + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Set an option on the socket. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../SettableSocketOption.html" title="Settable socket option requirements">SettableSocketOption</a><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">set_option</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">SettableSocketOption</span> <span class="special">&</span> <span class="identifier">option</span><span class="special">);</span> +</pre> +<p> + This function is used to set an option on the socket. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.set_option.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.set_option.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.set_option.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">option</span></dt> +<dd><p> + The new option value to be set on the socket. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.set_option.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_socket.set_option.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.set_option.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.set_option.overload1.h2"></a> + <span><a name="boost_asio.reference.basic_socket.set_option.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.set_option.overload1.example">Example</a> + </h6> +<p> + Setting the IPPROTO_TCP/TCP_NODELAY option: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">no_delay</span> <span class="identifier">option</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</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-2012 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="../set_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../set_option.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/basic_socket/set_option/overload2.html b/doc/html/boost_asio/reference/basic_socket/set_option/overload2.html new file mode 100755 index 0000000000..aede93690b --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/set_option/overload2.html @@ -0,0 +1,90 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::set_option (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../set_option.html" title="basic_socket::set_option"> +<link rel="prev" href="overload1.html" title="basic_socket::set_option (1 of 2 overloads)"> +<link rel="next" href="../shutdown.html" title="basic_socket::shutdown"> +</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="../set_option.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="../shutdown.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.set_option.overload2"></a><a class="link" href="overload2.html" title="basic_socket::set_option (2 of 2 overloads)">basic_socket::set_option + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Set an option on the socket. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../SettableSocketOption.html" title="Settable socket option requirements">SettableSocketOption</a><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">set_option</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">SettableSocketOption</span> <span class="special">&</span> <span class="identifier">option</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 is used to set an option on the socket. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.set_option.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.set_option.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.set_option.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">option</span></dt> +<dd><p> + The new option value to be set on the socket. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.set_option.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.set_option.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.set_option.overload2.example">Example</a> + </h6> +<p> + Setting the IPPROTO_TCP/TCP_NODELAY option: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">no_delay</span> <span class="identifier">option</span><span class="special">(</span><span class="keyword">true</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">socket</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</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-2012 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="../set_option.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="../shutdown.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/shutdown.html b/doc/html/boost_asio/reference/basic_socket/shutdown.html new file mode 100755 index 0000000000..c380823b04 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/shutdown.html @@ -0,0 +1,56 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::shutdown</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="set_option/overload2.html" title="basic_socket::set_option (2 of 2 overloads)"> +<link rel="next" href="shutdown/overload1.html" title="basic_socket::shutdown (1 of 2 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="set_option/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="shutdown/overload1.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.basic_socket.shutdown"></a><a class="link" href="shutdown.html" title="basic_socket::shutdown">basic_socket::shutdown</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1122424"></a> +Disable sends or receives on the socket. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="shutdown/overload1.html" title="basic_socket::shutdown (1 of 2 overloads)">shutdown</a><span class="special">(</span> + <span class="identifier">shutdown_type</span> <span class="identifier">what</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="shutdown/overload1.html" title="basic_socket::shutdown (1 of 2 overloads)">more...</a></em></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> <a class="link" href="shutdown/overload2.html" title="basic_socket::shutdown (2 of 2 overloads)">shutdown</a><span class="special">(</span> + <span class="identifier">shutdown_type</span> <span class="identifier">what</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> + <span class="emphasis"><em>» <a class="link" href="shutdown/overload2.html" title="basic_socket::shutdown (2 of 2 overloads)">more...</a></em></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-2012 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="set_option/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="shutdown/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/shutdown/overload1.html b/doc/html/boost_asio/reference/basic_socket/shutdown/overload1.html new file mode 100755 index 0000000000..e5f188babf --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/shutdown/overload1.html @@ -0,0 +1,91 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::shutdown (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../shutdown.html" title="basic_socket::shutdown"> +<link rel="prev" href="../shutdown.html" title="basic_socket::shutdown"> +<link rel="next" href="overload2.html" title="basic_socket::shutdown (2 of 2 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="../shutdown.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../shutdown.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><h5 class="title"> +<a name="boost_asio.reference.basic_socket.shutdown.overload1"></a><a class="link" href="overload1.html" title="basic_socket::shutdown (1 of 2 overloads)">basic_socket::shutdown + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Disable sends or receives on the socket. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">shutdown</span><span class="special">(</span> + <span class="identifier">shutdown_type</span> <span class="identifier">what</span><span class="special">);</span> +</pre> +<p> + This function is used to disable send operations, receive operations, + or both. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.shutdown.overload1.h0"></a> + <span><a name="boost_asio.reference.basic_socket.shutdown.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.shutdown.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">what</span></dt> +<dd><p> + Determines what types of operation will no longer be allowed. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.shutdown.overload1.h1"></a> + <span><a name="boost_asio.reference.basic_socket.shutdown.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.shutdown.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.shutdown.overload1.h2"></a> + <span><a name="boost_asio.reference.basic_socket.shutdown.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.shutdown.overload1.example">Example</a> + </h6> +<p> + Shutting down the send side of the socket: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span> +<span class="special">...</span> +<span class="identifier">socket</span><span class="special">.</span><span class="identifier">shutdown</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">::</span><span class="identifier">shutdown_send</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-2012 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="../shutdown.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../shutdown.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/basic_socket/shutdown/overload2.html b/doc/html/boost_asio/reference/basic_socket/shutdown/overload2.html new file mode 100755 index 0000000000..b2e0b9c004 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/shutdown/overload2.html @@ -0,0 +1,88 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::shutdown (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../shutdown.html" title="basic_socket::shutdown"> +<link rel="prev" href="overload1.html" title="basic_socket::shutdown (1 of 2 overloads)"> +<link rel="next" href="../shutdown_type.html" title="basic_socket::shutdown_type"> +</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="../shutdown.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="../shutdown_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_socket.shutdown.overload2"></a><a class="link" href="overload2.html" title="basic_socket::shutdown (2 of 2 overloads)">basic_socket::shutdown + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Disable sends or receives on the socket. + </p> +<pre class="programlisting"><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">shutdown</span><span class="special">(</span> + <span class="identifier">shutdown_type</span> <span class="identifier">what</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 is used to disable send operations, receive operations, + or both. + </p> +<h6> +<a name="boost_asio.reference.basic_socket.shutdown.overload2.h0"></a> + <span><a name="boost_asio.reference.basic_socket.shutdown.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.shutdown.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">what</span></dt> +<dd><p> + Determines what types of operation will no longer be allowed. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_socket.shutdown.overload2.h1"></a> + <span><a name="boost_asio.reference.basic_socket.shutdown.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.shutdown.overload2.example">Example</a> + </h6> +<p> + Shutting down the send side of the socket: + </p> +<pre class="programlisting"><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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</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">socket</span><span class="special">.</span><span class="identifier">shutdown</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">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">::</span><span class="identifier">shutdown_send</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-2012 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="../shutdown.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="../shutdown_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_socket/shutdown_type.html b/doc/html/boost_asio/reference/basic_socket/shutdown_type.html new file mode 100755 index 0000000000..c2ddfeea33 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_socket/shutdown_type.html @@ -0,0 +1,78 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_socket::shutdown_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_socket.html" title="basic_socket"> +<link rel="prev" href="shutdown/overload2.html" title="basic_socket::shutdown (2 of 2 overloads)"> +<link rel="next" href="_basic_socket.html" title="basic_socket::~basic_socket"> +</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="shutdown/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="_basic_socket.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.basic_socket.shutdown_type"></a><a class="link" href="shutdown_type.html" title="basic_socket::shutdown_type">basic_socket::shutdown_type</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from socket_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1123375"></a> +Different ways a socket may be shutdown. + </p> +<pre class="programlisting"><span class="keyword">enum</span> <span class="identifier">shutdown_type</span> +</pre> +<p> + <a class="indexterm" name="id1123404"></a> + <a class="indexterm" name="id1123413"></a> + <a class="indexterm" name="id1123422"></a> + </p> +<h6> +<a name="boost_asio.reference.basic_socket.shutdown_type.h0"></a> + <span><a name="boost_asio.reference.basic_socket.shutdown_type.values"></a></span><a class="link" href="shutdown_type.html#boost_asio.reference.basic_socket.shutdown_type.values">Values</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">shutdown_receive</span></dt> +<dd><p> + Shutdown the receive side of the socket. + </p></dd> +<dt><span class="term">shutdown_send</span></dt> +<dd><p> + Shutdown the send side of the socket. + </p></dd> +<dt><span class="term">shutdown_both</span></dt> +<dd><p> + Shutdown both send and receive on the socket. + </p></dd> +</dl> +</div> +</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-2012 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="shutdown/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.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="_basic_socket.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |