ocaml-trace/trace/Trace_thread_local_storage/index.html

2 lines
2.2 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_thread_local_storage (trace.Trace_thread_local_storage)</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> &#x00BB; <a href="../index.html">trace</a> &#x00BB; Trace_thread_local_storage</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_thread_local_storage</span></code></h1><p>use <code>thread-local-storage</code> to store ambient spans.</p><p>This doesn't work with cooperative concurrency (Eio, Lwt, etc) but is fine in a threaded context.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.12</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-k_span"><a href="#val-k_span" class="anchor"></a><code><span><span class="keyword">val</span> k_span : <span><a href="../Trace_core/index.html#type-span">Trace_core.span</a> <a href="../../thread-local-storage/Thread_local_storage/index.html#type-t">Thread_local_storage.t</a></span></span></code></div><div class="spec-doc"><p>Key to access the current span</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-provider"><a href="#val-provider" class="anchor"></a><code><span><span class="keyword">val</span> provider : <a href="../Trace_core/Ambient_span_provider/index.html#type-t">Trace_core.Ambient_span_provider.t</a></span></code></div><div class="spec-doc"><p>Provider that uses <code>Thread_local_storage</code> to store the current ambient span. This works well when concurrency is based on thread, or if there is no concurrency.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-setup"><a href="#val-setup" class="anchor"></a><code><span><span class="keyword">val</span> setup : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Install the provider</p></div></div></div></body></html>