libs/log/doc/html/boost/log/sinks/text_ipc_idm45185963976496.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template text_ipc_message_queue_backend</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.text_ipc_message_queue_backend_hpp" title="Header &lt;boost/log/sinks/text_ipc_message_queue_backend.hpp&gt;">
   9 <link rel="prev" href="text_file_backend.html" title="Class text_file_backend">
  10 <link rel="next" href="file/file_name_composer_adapter.html" title="Class template file_name_composer_adapter">
  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="text_file_backend.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.text_ipc_message_queue_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="file/file_name_composer_adapter.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.sinks.text_ipc_idm45185963976496"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template text_ipc_message_queue_backend</span></h2>
  22 <p>boost::log::sinks::text_ipc_message_queue_backend &#8212; An implementation of a text interprocess message queue sink backend and a supporting interprocess message queue. </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.text_ipc_message_queue_backend_hpp" title="Header &lt;boost/log/sinks/text_ipc_message_queue_backend.hpp&gt;">boost/log/sinks/text_ipc_message_queue_backend.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> QueueT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="text_ipc_idm45185963976496.html" title="Class template text_ipc_message_queue_backend">text_ipc_message_queue_backend</a> <span class="special">:</span>
  29   <span class="keyword">public</span> <span class="identifier">basic_formatted_sink_backend</span><span class="special">&lt;</span> <span class="keyword">char</span><span class="special">,</span> <span class="identifier">concurrent_feeding</span> <span class="special">&gt;</span>
  30 <span class="special">{</span>
  31 <span class="keyword">public</span><span class="special">:</span>
  32   <span class="comment">// types</span>
  33   <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">char_type</span>   <a name="boost.log.sinks.text_ipc_idm45185963976496.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>    <span class="comment">// Character type. </span>
  34   <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">string_type</span> <a name="boost.log.sinks.text_ipc_idm45185963976496.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>
  35   <span class="keyword">typedef</span> <span class="identifier">QueueT</span>                 <a name="boost.log.sinks.text_ipc_idm45185963976496.queue_type"></a><span class="identifier">queue_type</span><span class="special">;</span>   <span class="comment">// Interprocess message queue type. </span>
  36
  37   <span class="comment">// <a class="link" href="text_ipc_idm45185963976496.html#boost.log.sinks.text_ipc_idm45185963976496construct-copy-destruct">construct/copy/destruct</a></span>
  38   <a class="link" href="text_ipc_idm45185963976496.html#idm45185963955328-bb"><span class="identifier">text_ipc_message_queue_backend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  39   <span class="keyword">explicit</span> <a class="link" href="text_ipc_idm45185963976496.html#idm45185963954176-bb"><span class="identifier">text_ipc_message_queue_backend</span></a><span class="special">(</span><span class="identifier">queue_type</span> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  40   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span><span class="special">...</span> Args<span class="special">&gt;</span>
  41     <span class="keyword">explicit</span> <a class="link" href="text_ipc_idm45185963976496.html#idm45185963952096-bb"><span class="identifier">text_ipc_message_queue_backend</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="special">&amp;&amp;</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="text_ipc_idm45185963976496.html#idm45185963970192-bb">public member functions</a></span>
  44   <span class="identifier">queue_type</span> <span class="special">&amp;</span> <a class="link" href="text_ipc_idm45185963976496.html#idm45185963969632-bb"><span class="identifier">message_queue</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  45   <span class="identifier">queue_type</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a class="link" href="text_ipc_idm45185963976496.html#idm45185963966288-bb"><span class="identifier">message_queue</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  46   <span class="keyword">bool</span> <a class="link" href="text_ipc_idm45185963976496.html#idm45185963962944-bb"><span class="identifier">is_open</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  47   <span class="keyword">void</span> <a class="link" href="text_ipc_idm45185963976496.html#idm45185963959648-bb"><span class="identifier">consume</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">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  48 <span class="special">}</span><span class="special">;</span></pre></div>
  49 <div class="refsect1">
  50 <a name="idm46436899754608"></a><h2>Description</h2>
  51 <p>The sink backend sends formatted log messages to an interprocess message queue which can be extracted by a viewer process. Methods of this class are not thread-safe, unless otherwise specified. </p>
  52 <div class="refsect2">
  53 <a name="idm46436899753728"></a><h3>
  54 <a name="boost.log.sinks.text_ipc_idm45185963976496construct-copy-destruct"></a><code class="computeroutput">text_ipc_message_queue_backend</code>
  55         public
  56        construct/copy/destruct</h3>
  57 <div class="orderedlist"><ol class="orderedlist" type="1">
  58 <li class="listitem">
  59 <pre class="literallayout"><a name="idm45185963955328-bb"></a><span class="identifier">text_ipc_message_queue_backend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
  60 <p>Default constructor. The method constructs the backend using the default-constructed interprocess message queue. The queue may need additional setup in order to be able to send messages. </p>
  61 </li>
  62 <li class="listitem">
  63 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45185963954176-bb"></a><span class="identifier">text_ipc_message_queue_backend</span><span class="special">(</span><span class="identifier">queue_type</span> <span class="special">&amp;&amp;</span> queue<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
  64 <p>Initializing constructor. The method constructs the backend using the provided interprocess message queue. The constructor moves from the provided queue. </p>
  65 </li>
  66 <li class="listitem">
  67 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span><span class="special">...</span> Args<span class="special">&gt;</span>
  68   <span class="keyword">explicit</span> <a name="idm45185963952096-bb"></a><span class="identifier">text_ipc_message_queue_backend</span><span class="special">(</span><span class="identifier">Args</span> <span class="special">&amp;&amp;</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre>
  69 <p>Constructor that passes arbitrary named parameters to the interprocess queue constructor. Refer to the queue documentation for the list of supported parameters. </p>
  70 </li>
  71 </ol></div>
  72 </div>
  73 <div class="refsect2">
  74 <a name="idm46436899730080"></a><h3>
  75 <a name="idm45185963970192-bb"></a><code class="computeroutput">text_ipc_message_queue_backend</code> public member functions</h3>
  76 <div class="orderedlist"><ol class="orderedlist" type="1">
  77 <li class="listitem">
  78 <pre class="literallayout"><span class="identifier">queue_type</span> <span class="special">&amp;</span> <a name="idm45185963969632-bb"></a><span class="identifier">message_queue</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
  79 <p>The method returns a reference to the managed <code class="computeroutput">queue_type</code> object.</p>
  80 <p>
  81 </p>
  82 <div class="variablelist"><table border="0" class="variablelist compact">
  83 <colgroup>
  84 <col align="left" valign="top">
  85 <col>
  86 </colgroup>
  87 <tbody><tr>
  88 <td><p><span class="term">Returns:</span></p></td>
  89 <td><p>A reference to the managed <code class="computeroutput">queue_type</code> object. </p></td>
  90 </tr></tbody>
  91 </table></div>
  92 </li>
  93 <li class="listitem">
  94 <pre class="literallayout"><span class="identifier">queue_type</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a name="idm45185963966288-bb"></a><span class="identifier">message_queue</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
  95 <p>The method returns a constant reference to the managed <code class="computeroutput">queue_type</code> object.</p>
  96 <p>
  97 </p>
  98 <div class="variablelist"><table border="0" class="variablelist compact">
  99 <colgroup>
 100 <col align="left" valign="top">
 101 <col>
 102 </colgroup>
 103 <tbody><tr>
 104 <td><p><span class="term">Returns:</span></p></td>
 105 <td><p>A constant reference to the managed <code class="computeroutput">queue_type</code> object. </p></td>
 106 </tr></tbody>
 107 </table></div>
 108 </li>
 109 <li class="listitem">
 110 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45185963962944-bb"></a><span class="identifier">is_open</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
 111 <p>Tests whether the object is associated with any message queue. Only when the backend has an associated message queue, will any message be sent.</p>
 112 <p>
 113 </p>
 114 <div class="variablelist"><table border="0" class="variablelist compact">
 115 <colgroup>
 116 <col align="left" valign="top">
 117 <col>
 118 </colgroup>
 119 <tbody><tr>
 120 <td><p><span class="term">Returns:</span></p></td>
 121 <td><p><code class="computeroutput">true</code> if the object is associated with a message queue, and <code class="computeroutput">false</code> otherwise. </p></td>
 122 </tr></tbody>
 123 </table></div>
 124 </li>
 125 <li class="listitem">
 126 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45185963959648-bb"></a><span class="identifier">consume</span><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">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> formatted_message<span class="special">)</span><span class="special">;</span></pre>
 127 <p>The method writes the message to the backend. Concurrent calls to this method are allowed. Therefore, the backend may be used with unlocked frontend. <code class="computeroutput">stop_local()</code> can be used to have a blocked <code class="computeroutput">consume()</code> call return and prevent future calls to <code class="computeroutput">consume()</code> from blocking. </p>
 128 </li>
 129 </ol></div>
 130 </div>
 131 </div>
 132 </div>
 133 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 134 <td align="left"></td>
 135 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 136         Distributed under the Boost Software License, Version 1.0. (See accompanying
 137         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>).
 138       </p>
 139 </div></td>
 140 </tr></table>
 141 <hr>
 142 <div class="spirit-nav">
 143 <a accesskey="p" href="text_file_backend.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.text_ipc_message_queue_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="file/file_name_composer_adapter.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 144 </div>
 145 </body>
 146 </html>