libs/log/doc/html/boost/log/sources/basic_exceptio_idp42360704.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template basic_exception_handler_logger</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="../../../logging_sources.html#header.boost.log.sources.exception_handler_feature_hpp" title="Header &lt;boost/log/sources/exception_handler_feature.hpp&gt;">
   9 <link rel="prev" href="wchannel_logger_mt.html" title="Class template wchannel_logger_mt">
  10 <link rel="next" href="exception_handler.html" title="Struct 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="wchannel_logger_mt.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../logging_sources.html#header.boost.log.sources.exception_handler_feature_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="exception_handler.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sources.basic_exceptio_idp42360704"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template basic_exception_handler_logger</span></h2>
  22 <p>boost::log::sources::basic_exception_handler_logger &#8212; Exception handler feature implementation. </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="../../../logging_sources.html#header.boost.log.sources.exception_handler_feature_hpp" title="Header &lt;boost/log/sources/exception_handler_feature.hpp&gt;">boost/log/sources/exception_handler_feature.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BaseT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="basic_exceptio_idp42360704.html" title="Class template basic_exception_handler_logger">basic_exception_handler_logger</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">BaseT</span> <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">base_type</span><span class="special">::</span><span class="identifier">threading_model</span>                                                               <a name="boost.log.sources.basic_exceptio_idp42360704.threading_model"></a><span class="identifier">threading_model</span><span class="special">;</span>         <span class="comment">// Threading model being used. </span>
  32   <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">final_type</span>                                                                    <a name="boost.log.sources.basic_exceptio_idp42360704.final_type"></a><span class="identifier">final_type</span><span class="special">;</span>              <span class="comment">// Final logger type. </span>
  33   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                                                                              <a name="boost.log.sources.basic_exceptio_idp42360704.exception_handler_type"></a><span class="identifier">exception_handler_type</span><span class="special">;</span>  <span class="comment">// Exception handler function type. </span>
  34   <span class="keyword">typedef</span> <span class="identifier">strictest_lock</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">open_record_lock</span><span class="special">,</span> <span class="identifier">no_lock</span><span class="special">&lt;</span> <span class="identifier">threading_model</span> <span class="special">&gt;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="boost.log.sources.basic_exceptio_idp42360704.open_record_lock"></a><span class="identifier">open_record_lock</span><span class="special">;</span>        <span class="comment">// Lock requirement for the open_record_unlocked method. </span>
  35   <span class="keyword">typedef</span> <span class="identifier">strictest_lock</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">push_record_lock</span><span class="special">,</span> <span class="identifier">no_lock</span><span class="special">&lt;</span> <span class="identifier">threading_model</span> <span class="special">&gt;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="boost.log.sources.basic_exceptio_idp42360704.push_record_lock"></a><span class="identifier">push_record_lock</span><span class="special">;</span>        <span class="comment">// Lock requirement for the push_record_unlocked method. </span>
  36   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                                                                              <a name="boost.log.sources.basic_exceptio_idp42360704.swap_lock"></a><span class="identifier">swap_lock</span><span class="special">;</span>               <span class="comment">// Lock requirement for the swap_unlocked method. </span>
  37
  38   <span class="comment">// <a class="link" href="basic_exceptio_idp42360704.html#boost.log.sources.basic_exceptio_idp42360704construct-copy-destruct">construct/copy/destruct</a></span>
  39   <a class="link" href="basic_exceptio_idp42360704.html#idp42378624-bb"><span class="identifier">basic_exception_handler_logger</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  40   <a class="link" href="basic_exceptio_idp42360704.html#idp42379392-bb"><span class="identifier">basic_exception_handler_logger</span></a><span class="special">(</span><a class="link" href="basic_exceptio_idp42360704.html" title="Class template basic_exception_handler_logger">basic_exception_handler_logger</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  41   <a class="link" href="basic_exceptio_idp42360704.html#idp42381088-bb"><span class="identifier">basic_exception_handler_logger</span></a><span class="special">(</span><a class="link" href="basic_exceptio_idp42360704.html" title="Class template basic_exception_handler_logger">basic_exception_handler_logger</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  42   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgsT<span class="special">&gt;</span>
  43     <span class="keyword">explicit</span> <a class="link" href="basic_exceptio_idp42360704.html#idp42382784-bb"><span class="identifier">basic_exception_handler_logger</span></a><span class="special">(</span><span class="identifier">ArgsT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  44
  45   <span class="comment">// <a class="link" href="basic_exceptio_idp42360704.html#idp42370224-bb">public member functions</a></span>
  46   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HandlerT<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="basic_exceptio_idp42360704.html#idp42370784-bb"><span class="identifier">set_exception_handler</span></a><span class="special">(</span><span class="identifier">HandlerT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  47
  48   <span class="comment">// <a class="link" href="basic_exceptio_idp42360704.html#idp42385344-bb">protected member functions</a></span>
  49   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgsT<span class="special">&gt;</span> <span class="identifier">record</span> <a class="link" href="basic_exceptio_idp42360704.html#idp42385920-bb"><span class="identifier">open_record_unlocked</span></a><span class="special">(</span><span class="identifier">ArgsT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  50   <span class="keyword">void</span> <a class="link" href="basic_exceptio_idp42360704.html#idp42389168-bb"><span class="identifier">push_record_unlocked</span></a><span class="special">(</span><span class="identifier">record</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  51   <span class="keyword">void</span> <a class="link" href="basic_exceptio_idp42360704.html#idp42391568-bb"><span class="identifier">swap_unlocked</span></a><span class="special">(</span><a class="link" href="basic_exceptio_idp42360704.html" title="Class template basic_exception_handler_logger">basic_exception_handler_logger</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  52 <span class="special">}</span><span class="special">;</span></pre></div>
  53 <div class="refsect1">
  54 <a name="idp110310368"></a><h2>Description</h2>
  55 <div class="refsect2">
  56 <a name="idp110310784"></a><h3>
  57 <a name="boost.log.sources.basic_exceptio_idp42360704construct-copy-destruct"></a><code class="computeroutput">basic_exception_handler_logger</code>
  58         public
  59        construct/copy/destruct</h3>
  60 <div class="orderedlist"><ol class="orderedlist" type="1">
  61 <li class="listitem">
  62 <pre class="literallayout"><a name="idp42378624-bb"></a><span class="identifier">basic_exception_handler_logger</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  63 <p>Default constructor. The constructed logger does not have an exception handler. </p>
  64 </li>
  65 <li class="listitem">
  66 <pre class="literallayout"><a name="idp42379392-bb"></a><span class="identifier">basic_exception_handler_logger</span><span class="special">(</span><a class="link" href="basic_exceptio_idp42360704.html" title="Class template basic_exception_handler_logger">basic_exception_handler_logger</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  67 <p>Copy constructor </p>
  68 </li>
  69 <li class="listitem">
  70 <pre class="literallayout"><a name="idp42381088-bb"></a><span class="identifier">basic_exception_handler_logger</span><span class="special">(</span><a class="link" href="basic_exceptio_idp42360704.html" title="Class template basic_exception_handler_logger">basic_exception_handler_logger</a> <span class="special">&amp;&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  71 <p>Move constructor </p>
  72 </li>
  73 <li class="listitem">
  74 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgsT<span class="special">&gt;</span>
  75   <span class="keyword">explicit</span> <a name="idp42382784-bb"></a><span class="identifier">basic_exception_handler_logger</span><span class="special">(</span><span class="identifier">ArgsT</span> <span class="keyword">const</span> <span class="special">&amp;</span> args<span class="special">)</span><span class="special">;</span></pre>
  76 <p>Constructor with arguments. Passes arguments to other features. </p>
  77 </li>
  78 </ol></div>
  79 </div>
  80 <div class="refsect2">
  81 <a name="idp110337936"></a><h3>
  82 <a name="idp42370224-bb"></a><code class="computeroutput">basic_exception_handler_logger</code> public member functions</h3>
  83 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  84 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HandlerT<span class="special">&gt;</span>
  85   <span class="keyword">void</span> <a name="idp42370784-bb"></a><span class="identifier">set_exception_handler</span><span class="special">(</span><span class="identifier">HandlerT</span> <span class="keyword">const</span> <span class="special">&amp;</span> handler<span class="special">)</span><span class="special">;</span></pre>
  86 <p>The method sets exception handler function. The function will be called with no arguments in case if an exception occurs during either <code class="computeroutput">open_record</code> or <code class="computeroutput">push_record</code> method execution. Since exception handler is called from a <code class="computeroutput">catch</code> statement, the exception can be rethrown in order to determine its type.</p>
  87 <p>By default no handler is installed, thus any exception is propagated as usual.</p>
  88 <p><span class="bold"><strong>See Also:</strong></span></p>
  89 <p><code class="computeroutput">utility/exception_handler.hpp</code> </p>
  90 <p>
  91
  92 </p>
  93 <div class="note"><table border="0" summary="Note">
  94 <tr>
  95 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
  96 <th align="left">Note</th>
  97 </tr>
  98 <tr><td align="left" valign="top">
  99 <p>The exception handler can be invoked in several threads concurrently.</p>
 100 <p>Thread interruptions are not affected by exception handlers. </p>
 101 </td></tr>
 102 </table></div>
 103 <p>
 104 </p>
 105 <div class="variablelist"><table border="0" class="variablelist compact">
 106 <colgroup>
 107 <col align="left" valign="top">
 108 <col>
 109 </colgroup>
 110 <tbody><tr>
 111 <td><p><span class="term">Parameters:</span></p></td>
 112 <td><div class="variablelist"><table border="0" class="variablelist compact">
 113 <colgroup>
 114 <col align="left" valign="top">
 115 <col>
 116 </colgroup>
 117 <tbody><tr>
 118 <td><p><span class="term"><code class="computeroutput">handler</code></span></p></td>
 119 <td><p>Exception handling function</p></td>
 120 </tr></tbody>
 121 </table></div></td>
 122 </tr></tbody>
 123 </table></div>
 124 </li></ol></div>
 125 </div>
 126 <div class="refsect2">
 127 <a name="idp110357744"></a><h3>
 128 <a name="idp42385344-bb"></a><code class="computeroutput">basic_exception_handler_logger</code> protected member functions</h3>
 129 <div class="orderedlist"><ol class="orderedlist" type="1">
 130 <li class="listitem">
 131 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgsT<span class="special">&gt;</span> <span class="identifier">record</span> <a name="idp42385920-bb"></a><span class="identifier">open_record_unlocked</span><span class="special">(</span><span class="identifier">ArgsT</span> <span class="keyword">const</span> <span class="special">&amp;</span> args<span class="special">)</span><span class="special">;</span></pre>
 132 <p>Unlocked <code class="computeroutput">open_record</code> </p>
 133 </li>
 134 <li class="listitem">
 135 <pre class="literallayout"><span class="keyword">void</span> <a name="idp42389168-bb"></a><span class="identifier">push_record_unlocked</span><span class="special">(</span><span class="identifier">record</span> <span class="special">&amp;&amp;</span> rec<span class="special">)</span><span class="special">;</span></pre>
 136 <p>Unlocked <code class="computeroutput">push_record</code> </p>
 137 </li>
 138 <li class="listitem">
 139 <pre class="literallayout"><span class="keyword">void</span> <a name="idp42391568-bb"></a><span class="identifier">swap_unlocked</span><span class="special">(</span><a class="link" href="basic_exceptio_idp42360704.html" title="Class template basic_exception_handler_logger">basic_exception_handler_logger</a> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
 140 <p>Unlocked swap </p>
 141 </li>
 142 </ol></div>
 143 </div>
 144 </div>
 145 </div>
 146 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 147 <td align="left"></td>
 148 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 149         Distributed under the Boost Software License, Version 1.0. (See accompanying
 150         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>).
 151       </p>
 152 </div></td>
 153 </tr></table>
 154 <hr>
 155 <div class="spirit-nav">
 156 <a accesskey="p" href="wchannel_logger_mt.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../logging_sources.html#header.boost.log.sources.exception_handler_feature_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="exception_handler.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 157 </div>
 158 </body>
 159 </html>