Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / log / doc / html / boost / log / sinks / event_log / basic_event_composer.html
index e8c9cb6..d3f1e0d 100644 (file)
@@ -7,13 +7,13 @@
 <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
 <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;">
 <link rel="prev" href="../drop_on_overflow.html" title="Class drop_on_overflow">
-<link rel="next" href="custom_e_idm45185964392608.html" title="Class template custom_event_category_mapping">
+<link rel="next" href="custom_e_idm45711345993040.html" title="Class template custom_event_category_mapping">
 </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="../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_idm45185964392608.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
+<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>
 </div>
 <div class="refentry">
 <a name="boost.log.sinks.event_log.basic_event_composer"></a><div class="titlepage"></div>
   <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>
 
   <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>
-  <span class="keyword">explicit</span> <a class="link" href="basic_event_composer.html#idm45185964399648-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>
-  <a class="link" href="basic_event_composer.html#idm45185964397152-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>
-  <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#idm45185964394736-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>
-  <a class="link" href="basic_event_composer.html#idm45185964395440-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>
+  <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>
+  <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>
+  <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>
+  <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>
 
-  <span class="comment">// <a class="link" href="basic_event_composer.html#idm45185964414960-bb">public member functions</a></span>
-  <span class="keyword">void</span> <a class="link" href="basic_event_composer.html#idm45185964414400-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>
-  <span class="identifier">event_map_reference</span> <a class="link" href="basic_event_composer.html#idm45185964411264-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>
-  <span class="identifier">event_map_reference</span> <a class="link" href="basic_event_composer.html#idm45185964408432-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>
-  <span class="identifier">event_id</span> <a class="link" href="basic_event_composer.html#idm45185964405600-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>
+  <span class="comment">// <a class="link" href="basic_event_composer.html#idm45711346015392-bb">public member functions</a></span>
+  <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>
+  <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>
+  <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>
+  <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>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
-<a name="idm46436902151264"></a><h2>Description</h2>
+<a name="idm45554733647280"></a><h2>Description</h2>
 <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>
 <p>Before using, the composer must be initialized with the following information: </p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 </pre>
 <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>
 <div class="refsect2">
-<a name="idm46436902129392"></a><h3>
+<a name="idm45554733625312"></a><h3>
 <a name="boost.log.sinks.event_log.basic_event_composerconstruct-copy-destruct"></a><code class="computeroutput">basic_event_composer</code> 
         public
        construct/copy/destruct</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45185964399648-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>
+<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>
 <p>Default constructor. Creates an empty map of events.</p>
 <p>
 </p>
 </table></div>
 </li>
 <li class="listitem">
-<pre class="literallayout"><a name="idm45185964397152-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>
+<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>
 <p>Copy constructor. Performs a deep copy of the object. </p>
 </li>
 <li class="listitem">
-<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="idm45185964394736-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>
+<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>
 <p>Assignment. Provides strong exception guarantee. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><a name="idm45185964395440-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>
+<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>
 <p>Destructor </p>
 </li>
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idm46436902099568"></a><h3>
-<a name="idm45185964414960-bb"></a><code class="computeroutput">basic_event_composer</code> public member functions</h3>
+<a name="idm45554733595488"></a><h3>
+<a name="idm45711346015392-bb"></a><code class="computeroutput">basic_event_composer</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">void</span> <a name="idm45185964414400-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>
+<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>
 <p>Swaps <code class="computeroutput">*this</code> and <code class="computeroutput">that</code> objects. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">event_map_reference</span> <a name="idm45185964411264-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>
+<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>
 <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>
 <p>
 </p>
 </table></div>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">event_map_reference</span> <a name="idm45185964408432-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>
+<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>
 <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>
 <p>
 </p>
 </table></div>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">event_id</span> <a name="idm45185964405600-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>
+<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>
 <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>
 <p>
 
 </tr></table>
 <hr>
 <div class="spirit-nav">
-<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_idm45185964392608.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
+<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>
 </div>
 </body>
 </html>