mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-05-06 01:15:11 -04:00
2 lines
3.8 KiB
HTML
2 lines
3.8 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Common (opentelemetry-client.Opentelemetry_client.Bounded_queue.Common)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../../index.html">Index</a> » <a href="../../../index.html">opentelemetry-client</a> » <a href="../../index.html">Opentelemetry_client</a> » <a href="../index.html">Bounded_queue</a> » Common</nav><header class="odoc-preamble"><h1>Module <code><span>Bounded_queue.Common</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = </span><span>{</span></code><ol><li id="type-t.closed" class="def record field anchored"><a href="#type-t.closed" class="anchor"></a><code><span>closed : <span>unit <span class="arrow">-></span></span> bool;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Is the queue closed <b>for writing</b>. Consumers should only use <code>try_pop</code> because a queue that's closed-for-writing might still contain straggler items that need to be consumed.</p><p>This should be as fast and cheap as possible.</p><span class="comment-delim">*)</span></div></li><li id="type-t.num_discarded" class="def record field anchored"><a href="#type-t.num_discarded" class="anchor"></a><code><span>num_discarded : <span>unit <span class="arrow">-></span></span> int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>How many items were discarded?</p><span class="comment-delim">*)</span></div></li><li id="type-t.size" class="def record field anchored"><a href="#type-t.size" class="anchor"></a><code><span>size : <span>unit <span class="arrow">-></span></span> int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Snapshot of how many items are currently in the queue</p><span class="comment-delim">*)</span></div></li><li id="type-t.high_watermark" class="def record field anchored"><a href="#type-t.high_watermark" class="anchor"></a><code><span>high_watermark : <span>unit <span class="arrow">-></span></span> int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Maximum size of the queue</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-num_discarded"><a href="#val-num_discarded" class="anchor"></a><code><span><span class="keyword">val</span> num_discarded : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-closed"><a href="#val-closed" class="anchor"></a><code><span><span class="keyword">val</span> closed : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-size"><a href="#val-size" class="anchor"></a><code><span><span class="keyword">val</span> size : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-high_watermark"><a href="#val-high_watermark" class="anchor"></a><code><span><span class="keyword">val</span> high_watermark : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div></div></div></body></html>
|