libs/log/doc/html/boost/log/nothrow_exception_handler.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template nothrow_exception_handler</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
   8 <link rel="up" href="../../utilities.html#header.boost.log.utility.exception_handler_hpp" title="Header &lt;boost/log/utility/exception_handler.hpp&gt;">
   9 <link rel="prev" href="exception_handler.html" title="Class template exception_handler">
  10 <link rel="next" href="make_exception_suppressor.html" title="Function make_exception_suppressor">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td></tr></table>
  14 <hr>
  15 <div class="spirit-nav">
  16 <a accesskey="p" href="exception_handler.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.exception_handler_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="make_exception_suppressor.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.nothrow_exception_handler"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template nothrow_exception_handler</span></h2>
  22 <p>boost::log::nothrow_exception_handler</p>
  23 </div>
  24 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  25 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../utilities.html#header.boost.log.utility.exception_handler_hpp" title="Header &lt;boost/log/utility/exception_handler.hpp&gt;">boost/log/utility/exception_handler.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SequenceT<span class="special">,</span> <span class="keyword">typename</span> HandlerT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="nothrow_exception_handler.html" title="Class template nothrow_exception_handler">nothrow_exception_handler</a> <span class="special">:</span>
  29   <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">log</span><span class="special">::</span><span class="identifier">exception_handler</span><span class="special">&lt;</span> <span class="identifier">SequenceT</span><span class="special">,</span> <span class="identifier">HandlerT</span> <span class="special">&gt;</span>
  30 <span class="special">{</span>
  31 <span class="keyword">public</span><span class="special">:</span>
  32   <span class="comment">// types</span>
  33   <span class="keyword">typedef</span> <span class="identifier">HandlerT</span> <a name="boost.log.nothrow_exception_handler.handler_type"></a><span class="identifier">handler_type</span><span class="special">;</span>  <span class="comment">// The exception handler type. </span>
  34   <span class="keyword">typedef</span> <span class="keyword">void</span>     <a name="boost.log.nothrow_exception_handler.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>   <span class="comment">// The handler result type. </span>
  35
  36   <span class="comment">// <a class="link" href="nothrow_exception_handler.html#boost.log.nothrow_exception_handlerconstruct-copy-destruct">construct/copy/destruct</a></span>
  37   <span class="keyword">explicit</span> <a class="link" href="nothrow_exception_handler.html#idm45711349748656-bb"><span class="identifier">nothrow_exception_handler</span></a><span class="special">(</span><span class="identifier">handler_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  38
  39   <span class="comment">// <a class="link" href="nothrow_exception_handler.html#idm45711349752448-bb">public member functions</a></span>
  40   <span class="keyword">void</span> <a class="link" href="nothrow_exception_handler.html#idm45711349751888-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  41 <span class="special">}</span><span class="special">;</span></pre></div>
  42 <div class="refsect1">
  43 <a name="idm45554730077936"></a><h2>Description</h2>
  44 <p>A no-throw exception handler functional object. Acts similar to <code class="computeroutput"><a class="link" href="exception_handler.html" title="Class template exception_handler">exception_handler</a></code>, but in case if the exception cannot be handled the exception is not propagated from the handler. Instead the user-defined functional object is called with no parameters. </p>
  45 <div class="refsect2">
  46 <a name="idm45554730075792"></a><h3>
  47 <a name="boost.log.nothrow_exception_handlerconstruct-copy-destruct"></a><code class="computeroutput">nothrow_exception_handler</code>
  48         public
  49        construct/copy/destruct</h3>
  50 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  51 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45711349748656-bb"></a><span class="identifier">nothrow_exception_handler</span><span class="special">(</span><span class="identifier">handler_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> handler<span class="special">)</span><span class="special">;</span></pre>
  52 <p>Initializing constructor. Creates an exception handler with the specified function object that will receive the exception. </p>
  53 </li></ol></div>
  54 </div>
  55 <div class="refsect2">
  56 <a name="idm45554730066576"></a><h3>
  57 <a name="idm45711349752448-bb"></a><code class="computeroutput">nothrow_exception_handler</code> public member functions</h3>
  58 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  59 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45711349751888-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  60 <p>Exception launcher. Rethrows the current exception in order to detect its type and pass it to the aggregated function object. If the type of the exception could not be detected, the user-defined handler is called with no arguments.</p>
  61 <div class="note"><table border="0" summary="Note">
  62 <tr>
  63 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
  64 <th align="left">Note</th>
  65 </tr>
  66 <tr><td align="left" valign="top"><p>Must be called from within a <code class="computeroutput">catch</code> statement. </p></td></tr>
  67 </table></div>
  68 <p>
  69 </p>
  70 </li></ol></div>
  71 </div>
  72 </div>
  73 </div>
  74 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  75 <td align="left"></td>
  76 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  77         Distributed under the Boost Software License, Version 1.0. (See accompanying
  78         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>).
  79       </p>
  80 </div></td>
  81 </tr></table>
  82 <hr>
  83 <div class="spirit-nav">
  84 <a accesskey="p" href="exception_handler.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.exception_handler_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="make_exception_suppressor.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  85 </div>
  86 </body>
  87 </html>