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


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template basic_exception_handler_logger</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
<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;">
<link rel="prev" href="wchannel_logger_mt.html" title="Class template wchannel_logger_mt">
<link rel="next" href="exception_handler.html" title="Struct exception_handler">
</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></tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
<div class="refentry">
<a name="boost.log.sources.basic_exceptio_idp34291088"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template basic_exception_handler_logger</span></h2>
<p>boost::log::sources::basic_exception_handler_logger &#8212; Exception handler feature implementation. </p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<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;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BaseT<span class="special">&gt;</span> 
<span class="keyword">class</span> <a class="link" href="basic_exceptio_idp34291088.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>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// types</span>
  <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_idp34291088.threading_model"></a><span class="identifier">threading_model</span><span class="special">;</span>         <span class="comment">// Threading model being used. </span>
  <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_idp34291088.final_type"></a><span class="identifier">final_type</span><span class="special">;</span>              <span class="comment">// Final logger type. </span>
  <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                                                                              <a name="boost.log.sources.basic_exceptio_idp34291088.exception_handler_type"></a><span class="identifier">exception_handler_type</span><span class="special">;</span>  <span class="comment">// Exception handler function type. </span>
  <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_idp34291088.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>
  <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_idp34291088.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>
  <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                                                                              <a name="boost.log.sources.basic_exceptio_idp34291088.swap_lock"></a><span class="identifier">swap_lock</span><span class="special">;</span>               <span class="comment">// Lock requirement for the swap_unlocked method. </span>

  <span class="comment">// <a class="link" href="basic_exceptio_idp34291088.html#boost.log.sources.basic_exceptio_idp34291088construct-copy-destruct">construct/copy/destruct</a></span>
  <a class="link" href="basic_exceptio_idp34291088.html#idp33950032-bb"><span class="identifier">basic_exception_handler_logger</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="basic_exceptio_idp34291088.html#idp33950800-bb"><span class="identifier">basic_exception_handler_logger</span></a><span class="special">(</span><a class="link" href="basic_exceptio_idp34291088.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>
  <a class="link" href="basic_exceptio_idp34291088.html#idp33952496-bb"><span class="identifier">basic_exception_handler_logger</span></a><span class="special">(</span><a class="link" href="basic_exceptio_idp34291088.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>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgsT<span class="special">&gt;</span> 
    <span class="keyword">explicit</span> <a class="link" href="basic_exceptio_idp34291088.html#idp33954192-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>

  <span class="comment">// <a class="link" href="basic_exceptio_idp34291088.html#idp33941632-bb">public member functions</a></span>
  <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_idp34291088.html#idp33942192-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>

  <span class="comment">// <a class="link" href="basic_exceptio_idp34291088.html#idp33956752-bb">protected member functions</a></span>
  <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_idp34291088.html#idp33957328-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>
  <span class="keyword">void</span> <a class="link" href="basic_exceptio_idp34291088.html#idp33960576-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>
  <span class="keyword">void</span> <a class="link" href="basic_exceptio_idp34291088.html#idp33962976-bb"><span class="identifier">swap_unlocked</span></a><span class="special">(</span><a class="link" href="basic_exceptio_idp34291088.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>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp103889248"></a><h2>Description</h2>
<div class="refsect2">
<a name="idp103889664"></a><h3>
<a name="boost.log.sources.basic_exceptio_idp34291088construct-copy-destruct"></a><code class="computeroutput">basic_exception_handler_logger</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="idp33950032-bb"></a><span class="identifier">basic_exception_handler_logger</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Default constructor. The constructed logger does not have an exception handler. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp33950800-bb"></a><span class="identifier">basic_exception_handler_logger</span><span class="special">(</span><a class="link" href="basic_exceptio_idp34291088.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>
<p>Copy constructor </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp33952496-bb"></a><span class="identifier">basic_exception_handler_logger</span><span class="special">(</span><a class="link" href="basic_exceptio_idp34291088.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>
<p>Move constructor </p>
</li>
<li class="listitem">
<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="keyword">explicit</span> <a name="idp33954192-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>
<p>Constructor with arguments. Passes arguments to other features. </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp103916944"></a><h3>
<a name="idp33941632-bb"></a><code class="computeroutput">basic_exception_handler_logger</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><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 name="idp33942192-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>
<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>
<p>By default no handler is installed, thus any exception is propagated as usual.</p>
<p><span class="bold"><strong>See Also:</strong></span></p>
<p><code class="computeroutput">utility/exception_handler.hpp</code> </p>
<p>

</p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>The exception handler can be invoked in several threads concurrently.</p>
<p>Thread interruptions are not affected by exception handlers. </p>
</td></tr>
</table></div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">handler</code></span></p></td>
<td><p>Exception handling function</p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li></ol></div>
</div>
<div class="refsect2">
<a name="idp103936752"></a><h3>
<a name="idp33956752-bb"></a><code class="computeroutput">basic_exception_handler_logger</code> protected member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<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="idp33957328-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>
<p>Unlocked <code class="computeroutput">open_record</code> </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp33960576-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>
<p>Unlocked <code class="computeroutput">push_record</code> </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp33962976-bb"></a><span class="identifier">swap_unlocked</span><span class="special">(</span><a class="link" href="basic_exceptio_idp34291088.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>
<p>Unlocked swap </p>
</li>
</ol></div>
</div>
</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 &#169; 2007-2014 Andrey Semashev<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="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>
</div>
</body>
</html>