libs/log/doc/html/boost/log/sinks/event_log/basic_event_composer.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template basic_event_composer</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="../../../../sinks.html#header.boost.log.sinks.event_log_backend_hpp" title="Header &lt;boost/log/sinks/event_log_backend.hpp&gt;">
   9 <link rel="prev" href="../drop_on_overflow.html" title="Class drop_on_overflow">
  10 <link rel="next" href="custom_e_idm45711345993040.html" title="Class template custom_event_category_mapping">
  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="../drop_on_overflow.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../sinks.html#header.boost.log.sinks.event_log_backend_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="custom_e_idm45711345993040.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sinks.event_log.basic_event_composer"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template basic_event_composer</span></h2>
  22 <p>boost::log::sinks::event_log::basic_event_composer &#8212; An event composer. </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="../../../../sinks.html#header.boost.log.sinks.event_log_backend_hpp" title="Header &lt;boost/log/sinks/event_log_backend.hpp&gt;">boost/log/sinks/event_log_backend.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="basic_event_composer.html" title="Class template basic_event_composer">basic_event_composer</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">CharT</span>                          <a name="boost.log.sinks.event_log.basic_event_composer.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>             <span class="comment">// Character type. </span>
  32   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special">&lt;</span> <span class="identifier">char_type</span> <span class="special">&gt;</span> <a name="boost.log.sinks.event_log.basic_event_composer.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>           <span class="comment">// String type to be used as a message text holder. </span>
  33   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                    <a name="boost.log.sinks.event_log.basic_event_composer.event_id_mapper_type"></a><span class="identifier">event_id_mapper_type</span><span class="special">;</span>  <span class="comment">// Event identifier mapper type. </span>
  34   <span class="keyword">typedef</span> <span class="identifier">basic_formatter</span><span class="special">&lt;</span> <span class="identifier">char_type</span> <span class="special">&gt;</span>   <a name="boost.log.sinks.event_log.basic_event_composer.formatter_type"></a><span class="identifier">formatter_type</span><span class="special">;</span>        <span class="comment">// Type of an insertion composer (a formatter) </span>
  35   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">string_type</span> <span class="special">&gt;</span>     <a name="boost.log.sinks.event_log.basic_event_composer.insertion_list"></a><span class="identifier">insertion_list</span><span class="special">;</span>        <span class="comment">// Type of the composed insertions list. </span>
  36
  37   <span class="comment">// <a class="link" href="basic_event_composer.html#boost.log.sinks.event_log.basic_event_composerconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <span class="keyword">explicit</span> <a class="link" href="basic_event_composer.html#idm45711346000080-bb"><span class="identifier">basic_event_composer</span></a><span class="special">(</span><span class="identifier">event_id_mapper_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  39   <a class="link" href="basic_event_composer.html#idm45711345997584-bb"><span class="identifier">basic_event_composer</span></a><span class="special">(</span><a class="link" href="basic_event_composer.html" title="Class template basic_event_composer">basic_event_composer</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  40   <a class="link" href="basic_event_composer.html" title="Class template basic_event_composer">basic_event_composer</a> <span class="special">&amp;</span> <a class="link" href="basic_event_composer.html#idm45711345995168-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_event_composer.html" title="Class template basic_event_composer">basic_event_composer</a><span class="special">)</span><span class="special">;</span>
  41   <a class="link" href="basic_event_composer.html#idm45711345995872-bb"><span class="special">~</span><span class="identifier">basic_event_composer</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="basic_event_composer.html#idm45711346015392-bb">public member functions</a></span>
  44   <span class="keyword">void</span> <a class="link" href="basic_event_composer.html#idm45711346014832-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_event_composer.html" title="Class template basic_event_composer">basic_event_composer</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  45   <span class="identifier">event_map_reference</span> <a class="link" href="basic_event_composer.html#idm45711346011696-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">event_id</span><span class="special">)</span><span class="special">;</span>
  46   <span class="identifier">event_map_reference</span> <a class="link" href="basic_event_composer.html#idm45711346008864-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span>
  47   <span class="identifier">event_id</span> <a class="link" href="basic_event_composer.html#idm45711346006032-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">record_view</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">insertion_list</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  48 <span class="special">}</span><span class="special">;</span></pre></div>
  49 <div class="refsect1">
  50 <a name="idm45554733647280"></a><h2>Description</h2>
  51 <p>This class is a function object that extracts event identifier from the attribute values set and formats insertion strings for the particular event. Each insertion string is formatted with a distinct formatter, which can be created just like regular sinks formatters.</p>
  52 <p>Before using, the composer must be initialized with the following information: </p>
  53 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  54 <li class="listitem"><p>Event identifier extraction logic. One can use <code class="computeroutput">basic_direct_event_id_mapping</code> or <code class="computeroutput">basic_custom_event_id_mapping</code> classes in order to create such extractor and pass it to the composer constructor. </p></li>
  55 <li class="listitem"><p>Event identifiers and insertion string formatters. The composer provides the following syntax to provide this information:</p></li>
  56 </ul></div>
  57 <p>
  58 </p>
  59 <pre class="programlisting"><span class="identifier">event_composer</span> <span class="identifier">comp</span><span class="special">;</span>
  60 <span class="identifier">comp</span><span class="special">[</span><span class="identifier">MY_EVENT_ID1</span><span class="special">]</span> <span class="special">%</span> <span class="identifier">formatter1</span> <span class="special">%</span> <span class="special">...</span> <span class="special">%</span> <span class="identifier">formatterN</span><span class="special">;</span>
  61 <span class="identifier">comp</span><span class="special">[</span><span class="identifier">MY_EVENT_ID2</span><span class="special">]</span> <span class="special">%</span> <span class="identifier">formatter1</span> <span class="special">%</span> <span class="special">...</span> <span class="special">%</span> <span class="identifier">formatterN</span><span class="special">;</span>
  62 <span class="special">...</span>
  63 </pre>
  64 <p>The event identifiers in square brackets are provided by the message compiler generated header (the actual names are specified in the .mc file). The formatters represent the insertion strings that will be used to replace placeholders in event messages, thus the number and the order of the formatters must correspond to the message definition. </p>
  65 <div class="refsect2">
  66 <a name="idm45554733625312"></a><h3>
  67 <a name="boost.log.sinks.event_log.basic_event_composerconstruct-copy-destruct"></a><code class="computeroutput">basic_event_composer</code>
  68         public
  69        construct/copy/destruct</h3>
  70 <div class="orderedlist"><ol class="orderedlist" type="1">
  71 <li class="listitem">
  72 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45711346000080-bb"></a><span class="identifier">basic_event_composer</span><span class="special">(</span><span class="identifier">event_id_mapper_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> id_mapper<span class="special">)</span><span class="special">;</span></pre>
  73 <p>Default constructor. Creates an empty map of events.</p>
  74 <p>
  75 </p>
  76 <div class="variablelist"><table border="0" class="variablelist compact">
  77 <colgroup>
  78 <col align="left" valign="top">
  79 <col>
  80 </colgroup>
  81 <tbody><tr>
  82 <td><p><span class="term">Parameters:</span></p></td>
  83 <td><div class="variablelist"><table border="0" class="variablelist compact">
  84 <colgroup>
  85 <col align="left" valign="top">
  86 <col>
  87 </colgroup>
  88 <tbody><tr>
  89 <td><p><span class="term"><code class="computeroutput">id_mapper</code></span></p></td>
  90 <td><p>An event identifier mapping function that will be used to extract event ID from attribute values </p></td>
  91 </tr></tbody>
  92 </table></div></td>
  93 </tr></tbody>
  94 </table></div>
  95 </li>
  96 <li class="listitem">
  97 <pre class="literallayout"><a name="idm45711345997584-bb"></a><span class="identifier">basic_event_composer</span><span class="special">(</span><a class="link" href="basic_event_composer.html" title="Class template basic_event_composer">basic_event_composer</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  98 <p>Copy constructor. Performs a deep copy of the object. </p>
  99 </li>
 100 <li class="listitem">
 101 <pre class="literallayout"><a class="link" href="basic_event_composer.html" title="Class template basic_event_composer">basic_event_composer</a> <span class="special">&amp;</span> <a name="idm45711345995168-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_event_composer.html" title="Class template basic_event_composer">basic_event_composer</a> that<span class="special">)</span><span class="special">;</span></pre>
 102 <p>Assignment. Provides strong exception guarantee. </p>
 103 </li>
 104 <li class="listitem">
 105 <pre class="literallayout"><a name="idm45711345995872-bb"></a><span class="special">~</span><span class="identifier">basic_event_composer</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 106 <p>Destructor </p>
 107 </li>
 108 </ol></div>
 109 </div>
 110 <div class="refsect2">
 111 <a name="idm45554733595488"></a><h3>
 112 <a name="idm45711346015392-bb"></a><code class="computeroutput">basic_event_composer</code> public member functions</h3>
 113 <div class="orderedlist"><ol class="orderedlist" type="1">
 114 <li class="listitem">
 115 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45711346014832-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_event_composer.html" title="Class template basic_event_composer">basic_event_composer</a> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
 116 <p>Swaps <code class="computeroutput">*this</code> and <code class="computeroutput">that</code> objects. </p>
 117 </li>
 118 <li class="listitem">
 119 <pre class="literallayout"><span class="identifier">event_map_reference</span> <a name="idm45711346011696-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">event_id</span> id<span class="special">)</span><span class="special">;</span></pre>
 120 <p>Initiates creation of a new event description. The result of the operator can be used to add formatters for insertion strings construction. The returned reference type is implementation detail.</p>
 121 <p>
 122 </p>
 123 <div class="variablelist"><table border="0" class="variablelist compact">
 124 <colgroup>
 125 <col align="left" valign="top">
 126 <col>
 127 </colgroup>
 128 <tbody><tr>
 129 <td><p><span class="term">Parameters:</span></p></td>
 130 <td><div class="variablelist"><table border="0" class="variablelist compact">
 131 <colgroup>
 132 <col align="left" valign="top">
 133 <col>
 134 </colgroup>
 135 <tbody><tr>
 136 <td><p><span class="term"><code class="computeroutput">id</code></span></p></td>
 137 <td><p>Event identifier. </p></td>
 138 </tr></tbody>
 139 </table></div></td>
 140 </tr></tbody>
 141 </table></div>
 142 </li>
 143 <li class="listitem">
 144 <pre class="literallayout"><span class="identifier">event_map_reference</span> <a name="idm45711346008864-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="keyword">int</span> id<span class="special">)</span><span class="special">;</span></pre>
 145 <p>Initiates creation of a new event description. The result of the operator can be used to add formatters for insertion strings construction. The returned reference type is implementation detail.</p>
 146 <p>
 147 </p>
 148 <div class="variablelist"><table border="0" class="variablelist compact">
 149 <colgroup>
 150 <col align="left" valign="top">
 151 <col>
 152 </colgroup>
 153 <tbody><tr>
 154 <td><p><span class="term">Parameters:</span></p></td>
 155 <td><div class="variablelist"><table border="0" class="variablelist compact">
 156 <colgroup>
 157 <col align="left" valign="top">
 158 <col>
 159 </colgroup>
 160 <tbody><tr>
 161 <td><p><span class="term"><code class="computeroutput">id</code></span></p></td>
 162 <td><p>Event identifier. </p></td>
 163 </tr></tbody>
 164 </table></div></td>
 165 </tr></tbody>
 166 </table></div>
 167 </li>
 168 <li class="listitem">
 169 <pre class="literallayout"><span class="identifier">event_id</span> <a name="idm45711346006032-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">record_view</span> <span class="keyword">const</span> <span class="special">&amp;</span> rec<span class="special">,</span> <span class="identifier">insertion_list</span> <span class="special">&amp;</span> insertions<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 170 <p>Event composition operator. Extracts an event identifier from the attribute values by calling event ID mapper. Then runs all formatters that were registered for the event with the extracted ID. The results of formatting are returned in the <span class="emphasis"><em>insertions</em></span> parameter.</p>
 171 <p>
 172
 173 </p>
 174 <div class="variablelist"><table border="0" class="variablelist compact">
 175 <colgroup>
 176 <col align="left" valign="top">
 177 <col>
 178 </colgroup>
 179 <tbody>
 180 <tr>
 181 <td><p><span class="term">Parameters:</span></p></td>
 182 <td><div class="variablelist"><table border="0" class="variablelist compact">
 183 <colgroup>
 184 <col align="left" valign="top">
 185 <col>
 186 </colgroup>
 187 <tbody>
 188 <tr>
 189 <td><p><span class="term"><code class="computeroutput">insertions</code></span></p></td>
 190 <td><p>A sequence of formatted insertion strings </p></td>
 191 </tr>
 192 <tr>
 193 <td><p><span class="term"><code class="computeroutput">rec</code></span></p></td>
 194 <td><p>Log record view </p></td>
 195 </tr>
 196 </tbody>
 197 </table></div></td>
 198 </tr>
 199 <tr>
 200 <td><p><span class="term">Returns:</span></p></td>
 201 <td><p>An event identifier that was extracted from <code class="computeroutput">attributes</code> </p></td>
 202 </tr>
 203 </tbody>
 204 </table></div>
 205 </li>
 206 </ol></div>
 207 </div>
 208 </div>
 209 </div>
 210 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 211 <td align="left"></td>
 212 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 213         Distributed under the Boost Software License, Version 1.0. (See accompanying
 214         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>).
 215       </p>
 216 </div></td>
 217 </tr></table>
 218 <hr>
 219 <div class="spirit-nav">
 220 <a accesskey="p" href="../drop_on_overflow.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../sinks.html#header.boost.log.sinks.event_log_backend_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="custom_e_idm45711345993040.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 221 </div>
 222 </body>
 223 </html>