1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template bounded_fifo_queue</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 1. Boost.Log v2"> 8<link rel="up" href="../../../sinks.html#header.boost.log.sinks.bounded_fifo_queue_hpp" title="Header <boost/log/sinks/bounded_fifo_queue.hpp>"> 9<link rel="prev" href="block_on_overflow.html" title="Class block_on_overflow"> 10<link rel="next" href="bounded_ordering_queue.html" title="Class template bounded_ordering_queue"> 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="block_on_overflow.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.bounded_fifo_queue_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="bounded_ordering_queue.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 17</div> 18<div class="refentry"> 19<a name="boost.log.sinks.bounded_fifo_queue"></a><div class="titlepage"></div> 20<div class="refnamediv"> 21<h2><span class="refentrytitle">Class template bounded_fifo_queue</span></h2> 22<p>boost::log::sinks::bounded_fifo_queue — Bounded FIFO log record queueing strategy. </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: <<a class="link" href="../../../sinks.html#header.boost.log.sinks.bounded_fifo_queue_hpp" title="Header <boost/log/sinks/bounded_fifo_queue.hpp>">boost/log/sinks/bounded_fifo_queue.hpp</a>> 26 27</span><span class="keyword">template</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> MaxQueueSizeV<span class="special">,</span> <span class="keyword">typename</span> OverflowStrategyT<span class="special">></span> 28<span class="keyword">class</span> <a class="link" href="bounded_fifo_queue.html" title="Class template bounded_fifo_queue">bounded_fifo_queue</a> <span class="special">:</span> <span class="keyword">private</span> <span class="identifier">OverflowStrategyT</span> <span class="special">{</span> 29<span class="keyword">public</span><span class="special">:</span> 30 <span class="comment">// <a class="link" href="bounded_fifo_queue.html#boost.log.sinks.bounded_fifo_queueconstruct-copy-destruct">construct/copy/destruct</a></span> 31 <a class="link" href="bounded_fifo_queue.html#idm46079576772608-bb"><span class="identifier">bounded_fifo_queue</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 32 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ArgsT<span class="special">></span> <span class="keyword">explicit</span> <a class="link" href="bounded_fifo_queue.html#idm46079576772032-bb"><span class="identifier">bounded_fifo_queue</span></a><span class="special">(</span><span class="identifier">ArgsT</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 33 34 <span class="comment">// <a class="link" href="bounded_fifo_queue.html#idm46079576784320-bb">protected member functions</a></span> 35 <span class="keyword">void</span> <a class="link" href="bounded_fifo_queue.html#idm46079576783744-bb"><span class="identifier">enqueue</span></a><span class="special">(</span><span class="identifier">record_view</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 36 <span class="keyword">bool</span> <a class="link" href="bounded_fifo_queue.html#idm46079576781904-bb"><span class="identifier">try_enqueue</span></a><span class="special">(</span><span class="identifier">record_view</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 37 <span class="keyword">bool</span> <a class="link" href="bounded_fifo_queue.html#idm46079576780048-bb"><span class="identifier">try_dequeue_ready</span></a><span class="special">(</span><span class="identifier">record_view</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 38 <span class="keyword">bool</span> <a class="link" href="bounded_fifo_queue.html#idm46079576778128-bb"><span class="identifier">try_dequeue</span></a><span class="special">(</span><span class="identifier">record_view</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 39 <span class="keyword">bool</span> <a class="link" href="bounded_fifo_queue.html#idm46079576776240-bb"><span class="identifier">dequeue_ready</span></a><span class="special">(</span><span class="identifier">record_view</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 40 <span class="keyword">void</span> <a class="link" href="bounded_fifo_queue.html#idm46079576774368-bb"><span class="identifier">interrupt_dequeue</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 41<span class="special">}</span><span class="special">;</span></pre></div> 42<div class="refsect1"> 43<a name="idm44984864810592"></a><h2>Description</h2> 44<p>The <code class="computeroutput"><a class="link" href="bounded_fifo_queue.html" title="Class template bounded_fifo_queue">bounded_fifo_queue</a></code> class is intended to be used with the <code class="computeroutput"><a class="link" href="asynchronous_sink.html" title="Class template asynchronous_sink">asynchronous_sink</a></code> frontend as a log record queueing strategy.</p> 45<p>This strategy describes log record queueing logic. The queue has a limited capacity, upon reaching which the enqueue operation will invoke the overflow handling strategy specified in the <code class="computeroutput">OverflowStrategyT</code> template parameter to handle the situation. The library provides overflow handling strategies for most common cases: <code class="computeroutput"><a class="link" href="drop_on_overflow.html" title="Class drop_on_overflow">drop_on_overflow</a></code> will silently discard the log record, and <code class="computeroutput"><a class="link" href="block_on_overflow.html" title="Class block_on_overflow">block_on_overflow</a></code> will put the enqueueing thread to wait until there is space in the queue.</p> 46<p>The log record queue imposes no ordering over the queued elements aside from the order in which they are enqueued. </p> 47<div class="refsect2"> 48<a name="idm44984864802976"></a><h3> 49<a name="boost.log.sinks.bounded_fifo_queueconstruct-copy-destruct"></a><code class="computeroutput">bounded_fifo_queue</code> 50 public 51 construct/copy/destruct</h3> 52<div class="orderedlist"><ol class="orderedlist" type="1"> 53<li class="listitem"> 54<pre class="literallayout"><a name="idm46079576772608-bb"></a><span class="identifier">bounded_fifo_queue</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default constructor. </li> 55<li class="listitem"> 56<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ArgsT<span class="special">></span> <span class="keyword">explicit</span> <a name="idm46079576772032-bb"></a><span class="identifier">bounded_fifo_queue</span><span class="special">(</span><span class="identifier">ArgsT</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre>Initializing constructor. </li> 57</ol></div> 58</div> 59<div class="refsect2"> 60<a name="idm44984864788064"></a><h3> 61<a name="idm46079576784320-bb"></a><code class="computeroutput">bounded_fifo_queue</code> protected member functions</h3> 62<div class="orderedlist"><ol class="orderedlist" type="1"> 63<li class="listitem"> 64<pre class="literallayout"><span class="keyword">void</span> <a name="idm46079576783744-bb"></a><span class="identifier">enqueue</span><span class="special">(</span><span class="identifier">record_view</span> <span class="keyword">const</span> <span class="special">&</span> rec<span class="special">)</span><span class="special">;</span></pre>Enqueues log record to the queue. </li> 65<li class="listitem"> 66<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079576781904-bb"></a><span class="identifier">try_enqueue</span><span class="special">(</span><span class="identifier">record_view</span> <span class="keyword">const</span> <span class="special">&</span> rec<span class="special">)</span><span class="special">;</span></pre>Attempts to enqueue log record to the queue. </li> 67<li class="listitem"> 68<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079576780048-bb"></a><span class="identifier">try_dequeue_ready</span><span class="special">(</span><span class="identifier">record_view</span> <span class="special">&</span> rec<span class="special">)</span><span class="special">;</span></pre>Attempts to dequeue a log record ready for processing from the queue, does not block if the queue is empty. </li> 69<li class="listitem"> 70<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079576778128-bb"></a><span class="identifier">try_dequeue</span><span class="special">(</span><span class="identifier">record_view</span> <span class="special">&</span> rec<span class="special">)</span><span class="special">;</span></pre>Attempts to dequeue log record from the queue, does not block if the queue is empty. </li> 71<li class="listitem"> 72<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079576776240-bb"></a><span class="identifier">dequeue_ready</span><span class="special">(</span><span class="identifier">record_view</span> <span class="special">&</span> rec<span class="special">)</span><span class="special">;</span></pre>Dequeues log record from the queue, blocks if the queue is empty. </li> 73<li class="listitem"> 74<pre class="literallayout"><span class="keyword">void</span> <a name="idm46079576774368-bb"></a><span class="identifier">interrupt_dequeue</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Wakes a thread possibly blocked in the <code class="computeroutput">dequeue</code> method. </li> 75</ol></div> 76</div> 77</div> 78</div> 79<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 80<td align="left"></td> 81<td align="right"><div class="copyright-footer">Copyright © 2007-2019 Andrey Semashev<p> 82 Distributed under the Boost Software License, Version 1.0. (See accompanying 83 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>). 84 </p> 85</div></td> 86</tr></table> 87<hr> 88<div class="spirit-nav"> 89<a accesskey="p" href="block_on_overflow.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.bounded_fifo_queue_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="bounded_ordering_queue.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 90</div> 91</body> 92</html> 93
