linol/trace/Trace_subscriber/Callbacks/Dummy/index.html
2025-08-24 01:27:17 +00:00

38 lines
10 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>Dummy (trace.Trace_subscriber.Callbacks.Dummy)</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; <a href="../../index.html">Trace_subscriber</a> &#x00BB; <a href="../index.html">Callbacks</a> &#x00BB; Dummy</nav><header class="odoc-preamble"><h1>Module <code><span>Callbacks.Dummy</span></code></h1><p>Dummy callbacks. It can be useful to reuse some of these functions in a real subscriber that doesn't want to handle <b>all</b> events, but only some of them.</p><p>To write a subscriber that only supports some callbacks, this can be handy:</p><pre class="language-ocaml"><code> module My_callbacks = struct
type st = my_own_state
include Callbacks.Dummy
let on_counter (st:st) ~time_ns ~tid ~data ~name v : unit = ...
end</code></pre></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-on_init"><a href="#val-on_init" class="anchor"></a><code><span><span class="keyword">val</span> on_init : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_shutdown"><a href="#val-on_shutdown" class="anchor"></a><code><span><span class="keyword">val</span> on_shutdown : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_name_thread"><a href="#val-on_name_thread" class="anchor"></a><code><span><span class="keyword">val</span> on_name_thread : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:<span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_name_process"><a href="#val-on_name_process" class="anchor"></a><code><span><span class="keyword">val</span> on_name_process : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:<span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_message"><a href="#val-on_message" class="anchor"></a><code><span><span class="keyword">val</span> on_message : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">span</span>:<span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">data</span>:<span class="type-var">'e</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'f</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_counter"><a href="#val-on_counter" class="anchor"></a><code><span><span class="keyword">val</span> on_counter : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">data</span>:<span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:<span class="type-var">'e</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'f</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_enter_span"><a href="#val-on_enter_span" class="anchor"></a><code><span><span class="keyword">val</span> on_enter_span :
<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FUNCTION__</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FILE__</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__LINE__</span>:<span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">time_ns</span>:<span class="type-var">'e</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">tid</span>:<span class="type-var">'f</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">data</span>:<span class="type-var">'g</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">name</span>:<span class="type-var">'h</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="type-var">'i</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_exit_span"><a href="#val-on_exit_span" class="anchor"></a><code><span><span class="keyword">val</span> on_exit_span : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_add_data"><a href="#val-on_add_data" class="anchor"></a><code><span><span class="keyword">val</span> on_add_data : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">data</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_enter_manual_span"><a href="#val-on_enter_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> on_enter_manual_span :
<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FUNCTION__</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FILE__</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__LINE__</span>:<span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">time_ns</span>:<span class="type-var">'e</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">tid</span>:<span class="type-var">'f</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">parent</span>:<span class="type-var">'g</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">data</span>:<span class="type-var">'h</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">name</span>:<span class="type-var">'i</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">flavor</span>:<span class="type-var">'j</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">trace_id</span>:<span class="type-var">'k</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="type-var">'l</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_exit_manual_span"><a href="#val-on_exit_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> on_exit_manual_span :
<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">tid</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">name</span>:<span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">data</span>:<span class="type-var">'e</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">flavor</span>:<span class="type-var">'f</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">trace_id</span>:<span class="type-var">'g</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="type-var">'h</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_extension_event"><a href="#val-on_extension_event" class="anchor"></a><code><span><span class="keyword">val</span> on_extension_event : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>