mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-05-05 17:04:52 -04:00
6 lines
5.8 KiB
HTML
6 lines
5.8 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Send (opentelemetry-client.Opentelemetry_client.Bounded_queue.Send)</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> » Send</nav><header class="odoc-preamble"><h1>Module <code><span>Bounded_queue.Send</span></code></h1><p>Sending side</p></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> <span>'a t</span></span><span> = </span><span>{</span></code><ol><li id="type-t.push" class="def record field anchored"><a href="#type-t.push" class="anchor"></a><code><span>push : <span><span><span class="type-var">'a</span> list</span> <span class="arrow">-></span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Push items. This might discard some of them.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <a href="../index.html#exception-Closed"><code>Closed</code></a> <p>if the queue is closed.</p></li></ul><span class="comment-delim">*)</span></div></li><li id="type-t.close" class="def record field anchored"><a href="#type-t.close" class="anchor"></a><code><span>close : <span>unit <span class="arrow">-></span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Close the queue. Items currently in the queue will still be accessible to consumers until the queue is emptied out. Idempotent.</p><span class="comment-delim">*)</span></div></li><li id="type-t.common" class="def record field anchored"><a href="#type-t.common" class="anchor"></a><code><span>common : <a href="../Common/index.html#type-t">Common.t</a>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-push"><a href="#val-push" class="anchor"></a><code><span><span class="keyword">val</span> push : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> list</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-close"><a href="#val-close" class="anchor"></a><code><span><span class="keyword">val</span> close : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> unit</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><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> bool</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><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> int</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><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <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><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-map"><a href="#val-map" class="anchor"></a><code><span><span class="keyword">val</span> map : <span><span>(<span><span><span class="type-var">'a</span> list</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> list</span>)</span> <span class="arrow">-></span></span> <span><span><span class="type-var">'b</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_emitter"><a href="#val-to_emitter" class="anchor"></a><code><span><span class="keyword">val</span> to_emitter :
|
||
<span><span class="label">signal_name</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="label">close_queue_on_close</span>:bool <span class="arrow">-></span></span>
|
||
<span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span>
|
||
<span><span class="type-var">'a</span> <a href="../../../../opentelemetry/Opentelemetry_emitter/Emitter/index.html#type-t">Opentelemetry_emitter.Emitter.t</a></span></span></code></div><div class="spec-doc"><p>Turn the writing end of the queue into an emitter.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">close_queue_on_close</span> <p>if true, closing the emitter will close the queue</p></li></ul></div></div></div></body></html>
|