1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template bounded_ordering_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_ordering_queue_hpp" title="Header <boost/log/sinks/bounded_ordering_queue.hpp>"> 9<link rel="prev" href="bounded_fifo_queue.html" title="Class template bounded_fifo_queue"> 10<link rel="next" href="basic_debug_output_backend.html" title="Class template basic_debug_output_backend"> 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="bounded_fifo_queue.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.bounded_ordering_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="basic_debug_output_backend.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 17</div> 18<div class="refentry"> 19<a name="boost.log.sinks.bounded_ordering_queue"></a><div class="titlepage"></div> 20<div class="refnamediv"> 21<h2><span class="refentrytitle">Class template bounded_ordering_queue</span></h2> 22<p>boost::log::sinks::bounded_ordering_queue — Bounded ordering 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_ordering_queue_hpp" title="Header <boost/log/sinks/bounded_ordering_queue.hpp>">boost/log/sinks/bounded_ordering_queue.hpp</a>> 26 27</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> OrderT<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> MaxQueueSizeV<span class="special">,</span> 28 <span class="keyword">typename</span> OverflowStrategyT<span class="special">></span> 29<span class="keyword">class</span> <a class="link" href="bounded_ordering_queue.html" title="Class template bounded_ordering_queue">bounded_ordering_queue</a> <span class="special">:</span> <span class="keyword">private</span> <span class="identifier">OverflowStrategyT</span> <span class="special">{</span> 30<span class="keyword">public</span><span class="special">:</span> 31 <span class="comment">// <a class="link" href="bounded_ordering_queue.html#boost.log.sinks.bounded_ordering_queueconstruct-copy-destruct">construct/copy/destruct</a></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_ordering_queue.html#idm46079576735952-bb"><span class="identifier">bounded_ordering_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_ordering_queue.html#idm46079576752384-bb">public member functions</a></span> 35 <span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">time_duration</span> <a class="link" href="bounded_ordering_queue.html#idm46079576751824-bb"><span class="identifier">get_ordering_window</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 36 37 <span class="comment">// <a class="link" href="bounded_ordering_queue.html#idm46079576750064-bb">public static functions</a></span> 38 <span class="keyword">static</span> <span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">time_duration</span> <a class="link" href="bounded_ordering_queue.html#idm46079576749504-bb"><span class="identifier">get_default_ordering_window</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 39 40 <span class="comment">// <a class="link" href="bounded_ordering_queue.html#idm46079576747664-bb">protected member functions</a></span> 41 <span class="keyword">void</span> <a class="link" href="bounded_ordering_queue.html#idm46079576747088-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> 42 <span class="keyword">bool</span> <a class="link" href="bounded_ordering_queue.html#idm46079576745248-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> 43 <span class="keyword">bool</span> <a class="link" href="bounded_ordering_queue.html#idm46079576743392-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> 44 <span class="keyword">bool</span> <a class="link" href="bounded_ordering_queue.html#idm46079576741472-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> 45 <span class="keyword">bool</span> <a class="link" href="bounded_ordering_queue.html#idm46079576739584-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> 46 <span class="keyword">void</span> <a class="link" href="bounded_ordering_queue.html#idm46079576737712-bb"><span class="identifier">interrupt_dequeue</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 47<span class="special">}</span><span class="special">;</span></pre></div> 48<div class="refsect1"> 49<a name="idm44984864658624"></a><h2>Description</h2> 50<p>The <code class="computeroutput"><a class="link" href="bounded_ordering_queue.html" title="Class template bounded_ordering_queue">bounded_ordering_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> 51<p>This strategy provides the following properties to the record queueing mechanism:</p> 52<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 53<li class="listitem"><p>The queue has limited capacity specified by the <code class="computeroutput">MaxQueueSizeV</code> template parameter. </p></li> 54<li class="listitem"><p>Upon reaching the size limit, the queue invokes 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></li> 55<li class="listitem"><p>The queue has a fixed latency window. This means that each log record put into the queue will normally not be dequeued for a certain period of time. </p></li> 56<li class="listitem"><p>The queue performs stable record ordering within the latency window. The ordering predicate can be specified in the <code class="computeroutput">OrderT</code> template parameter. </p></li> 57</ul></div> 58<p> 59</p> 60<div class="refsect2"> 61<a name="idm44984864646528"></a><h3> 62<a name="boost.log.sinks.bounded_ordering_queueconstruct-copy-destruct"></a><code class="computeroutput">bounded_ordering_queue</code> 63 public 64 construct/copy/destruct</h3> 65<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 66<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="idm46079576735952-bb"></a><span class="identifier">bounded_ordering_queue</span><span class="special">(</span><span class="identifier">ArgsT</span> <span class="keyword">const</span> <span class="special">&</span> args<span class="special">)</span><span class="special">;</span></pre>Initializing constructor. </li></ol></div> 67</div> 68<div class="refsect2"> 69<a name="idm44984864635184"></a><h3> 70<a name="idm46079576752384-bb"></a><code class="computeroutput">bounded_ordering_queue</code> public member functions</h3> 71<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 72<pre class="literallayout"><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">time_duration</span> <a name="idm46079576751824-bb"></a><span class="identifier">get_ordering_window</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 73<p>Returns ordering window size specified during initialization </p> 74</li></ol></div> 75</div> 76<div class="refsect2"> 77<a name="idm44984864626672"></a><h3> 78<a name="idm46079576750064-bb"></a><code class="computeroutput">bounded_ordering_queue</code> public static functions</h3> 79<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 80<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">time_duration</span> <a name="idm46079576749504-bb"></a><span class="identifier">get_default_ordering_window</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 81<p>Returns default ordering window size. The default window size is specific to the operating system thread scheduling mechanism. </p> 82</li></ol></div> 83</div> 84<div class="refsect2"> 85<a name="idm44984864618000"></a><h3> 86<a name="idm46079576747664-bb"></a><code class="computeroutput">bounded_ordering_queue</code> protected member functions</h3> 87<div class="orderedlist"><ol class="orderedlist" type="1"> 88<li class="listitem"> 89<pre class="literallayout"><span class="keyword">void</span> <a name="idm46079576747088-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> 90<li class="listitem"> 91<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079576745248-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> 92<li class="listitem"> 93<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079576743392-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> 94<li class="listitem"> 95<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079576741472-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> 96<li class="listitem"> 97<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079576739584-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> 98<li class="listitem"> 99<pre class="literallayout"><span class="keyword">void</span> <a name="idm46079576737712-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> 100</ol></div> 101</div> 102</div> 103</div> 104<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 105<td align="left"></td> 106<td align="right"><div class="copyright-footer">Copyright © 2007-2019 Andrey Semashev<p> 107 Distributed under the Boost Software License, Version 1.0. (See accompanying 108 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>). 109 </p> 110</div></td> 111</tr></table> 112<hr> 113<div class="spirit-nav"> 114<a accesskey="p" href="bounded_fifo_queue.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../sinks.html#header.boost.log.sinks.bounded_ordering_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="basic_debug_output_backend.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 115</div> 116</body> 117</html> 118
