libs/log/doc/html/boost/log/exception_handler.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template exception_handler</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.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="../../utilities.html" title="Utilities">
  10 <link rel="next" href="nothrow_exception_handler.html" title="Class template nothrow_exception_handler">
  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="../../utilities.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="nothrow_exception_handler.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.exception_handler"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template exception_handler</span></h2>
  22 <p>boost::log::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="exception_handler.html" title="Class template exception_handler">exception_handler</a> <span class="special">{</span>
  29 <span class="keyword">public</span><span class="special">:</span>
  30   <span class="comment">// types</span>
  31   <span class="keyword">typedef</span> <span class="identifier">HandlerT</span> <a name="boost.log.exception_handler.handler_type"></a><span class="identifier">handler_type</span><span class="special">;</span>  <span class="comment">// The exception handler type. </span>
  32   <span class="keyword">typedef</span> <span class="keyword">void</span>     <a name="boost.log.exception_handler.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>   <span class="comment">// The handler result type. </span>
  33
  34   <span class="comment">// <a class="link" href="exception_handler.html#boost.log.exception_handlerconstruct-copy-destruct">construct/copy/destruct</a></span>
  35   <span class="keyword">explicit</span> <a class="link" href="exception_handler.html#idp34404848-bb"><span class="identifier">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>
  36
  37   <span class="comment">// <a class="link" href="exception_handler.html#idp34401312-bb">public member functions</a></span>
  38   <span class="keyword">void</span> <a class="link" href="exception_handler.html#idp34401872-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>
  39 <span class="special">}</span><span class="special">;</span></pre></div>
  40 <div class="refsect1">
  41 <a name="idp110990256"></a><h2>Description</h2>
  42 <p>An exception handler functional object. The handler aggregates a user-defined functional object that will be called when one of the specified exception types is caught. </p>
  43 <div class="refsect2">
  44 <a name="idp110991120"></a><h3>
  45 <a name="boost.log.exception_handlerconstruct-copy-destruct"></a><code class="computeroutput">exception_handler</code>
  46         public
  47        construct/copy/destruct</h3>
  48 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  49 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp34404848-bb"></a><span class="identifier">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>
  50 <p>Initializing constructor. Creates an exception handler with the specified function object that will receive the exception. </p>
  51 </li></ol></div>
  52 </div>
  53 <div class="refsect2">
  54 <a name="idp111000176"></a><h3>
  55 <a name="idp34401312-bb"></a><code class="computeroutput">exception_handler</code> public member functions</h3>
  56 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  57 <pre class="literallayout"><span class="keyword">void</span> <a name="idp34401872-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>
  58 <p>Exception launcher. Rethrows the current exception in order to detect its type and pass it to the aggregated function object.</p>
  59 <div class="note"><table border="0" summary="Note">
  60 <tr>
  61 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
  62 <th align="left">Note</th>
  63 </tr>
  64 <tr><td align="left" valign="top"><p>Must be called from within a <code class="computeroutput">catch</code> statement. </p></td></tr>
  65 </table></div>
  66 <p>
  67 </p>
  68 </li></ol></div>
  69 </div>
  70 </div>
  71 </div>
  72 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  73 <td align="left"></td>
  74 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2014 Andrey Semashev<p>
  75         Distributed under the Boost Software License, Version 1.0. (See accompanying
  76         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>).
  77       </p>
  78 </div></td>
  79 </tr></table>
  80 <hr>
  81 <div class="spirit-nav">
  82 <a accesskey="p" href="../../utilities.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="nothrow_exception_handler.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  83 </div>
  84 </body>
  85 </html>