diff options
Diffstat (limited to 'doc/html/boost_asio/reference/ShutdownHandler.html')
-rwxr-xr-x | doc/html/boost_asio/reference/ShutdownHandler.html | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/ShutdownHandler.html b/doc/html/boost_asio/reference/ShutdownHandler.html new file mode 100755 index 0000000000..6dc073edfb --- /dev/null +++ b/doc/html/boost_asio/reference/ShutdownHandler.html @@ -0,0 +1,91 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>SSL shutdown handler requirements</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="../reference.html" title="Reference"> +<link rel="prev" href="SettableSocketOption.html" title="Settable socket option requirements"> +<link rel="next" href="SignalHandler.html" title="Signal handler requirements"> +</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="SettableSocketOption.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="SignalHandler.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="boost_asio.reference.ShutdownHandler"></a><a class="link" href="ShutdownHandler.html" title="SSL shutdown handler requirements">SSL shutdown handler + requirements</a> +</h3></div></div></div> +<p> + A shutdown handler must meet the requirements for a <a class="link" href="Handler.html" title="Handlers">handler</a>. + A value <code class="computeroutput"><span class="identifier">h</span></code> of a shutdown handler + class should work correctly in the expression <code class="computeroutput"><span class="identifier">h</span><span class="special">(</span><span class="identifier">ec</span><span class="special">)</span></code>, + where <code class="computeroutput"><span class="identifier">ec</span></code> is an lvalue of + type <code class="computeroutput"><span class="keyword">const</span> <span class="identifier">error_code</span></code>. + </p> +<h5> +<a name="boost_asio.reference.ShutdownHandler.h0"></a> + <span><a name="boost_asio.reference.ShutdownHandler.examples"></a></span><a class="link" href="ShutdownHandler.html#boost_asio.reference.ShutdownHandler.examples">Examples</a> + </h5> +<p> + A free function as a shutdown handler: + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">shutdown_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">ec</span><span class="special">)</span> +<span class="special">{</span> + <span class="special">...</span> +<span class="special">}</span> +</pre> +<p> + A shutdown handler function object: + </p> +<pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">shutdown_handler</span> +<span class="special">{</span> + <span class="special">...</span> + <span class="keyword">void</span> <span class="keyword">operator</span><span class="special">()(</span> + <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">ec</span><span class="special">)</span> + <span class="special">{</span> + <span class="special">...</span> + <span class="special">}</span> + <span class="special">...</span> +<span class="special">};</span> +</pre> +<p> + A non-static class member function adapted to a shutdown handler using <code class="computeroutput"><span class="identifier">bind</span><span class="special">()</span></code>: + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">my_class</span><span class="special">::</span><span class="identifier">shutdown_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">ec</span><span class="special">)</span> +<span class="special">{</span> + <span class="special">...</span> +<span class="special">}</span> +<span class="special">...</span> +<span class="identifier">ssl_stream</span><span class="special">.</span><span class="identifier">async_shutdown</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">bind</span><span class="special">(&</span><span class="identifier">my_class</span><span class="special">::</span><span class="identifier">shutdown_handler</span><span class="special">,</span> + <span class="keyword">this</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">placeholders</span><span class="special">::</span><span class="identifier">error</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="SettableSocketOption.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="SignalHandler.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |