nanoev/trace/Trace_event/Event/index.html
2025-05-30 19:31:31 +00:00

2 lines
12 KiB
HTML
Raw Permalink 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>Event (trace.Trace_event.Event)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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_event</a> &#x00BB; Event</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_event.Event</span></code></h1><p>Events.</p><p>Each callback in a subscriber corresponds to an event, which can be for example queued somewhere or batched for further processing.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Sub"><a href="#module-Sub" class="anchor"></a><code><span><span class="keyword">module</span> Sub</span><span> = <a href="../../Trace_subscriber/index.html">Trace_subscriber</a></span></code></div></div><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></code><ol><li id="type-t.E_tick" class="def variant constructor anchored"><a href="#type-t.E_tick" class="anchor"></a><code><span>| </span><span><span class="constructor">E_tick</span></span></code></li><li id="type-t.E_init" class="def variant constructor anchored"><a href="#type-t.E_init" class="anchor"></a><code><span>| </span><span><span class="constructor">E_init</span> <span class="keyword">of</span> </span><span>{</span></code><ol><li id="type-t.time_ns" class="def record field anchored"><a href="#type-t.time_ns" class="anchor"></a><code><span>time_ns : int64;</span></code></li></ol><code><span>}</span></code></li><li id="type-t.E_shutdown" class="def variant constructor anchored"><a href="#type-t.E_shutdown" class="anchor"></a><code><span>| </span><span><span class="constructor">E_shutdown</span> <span class="keyword">of</span> </span><span>{</span></code><ol><li id="type-t.time_ns" class="def record field anchored"><a href="#type-t.time_ns" class="anchor"></a><code><span>time_ns : int64;</span></code></li></ol><code><span>}</span></code></li><li id="type-t.E_message" class="def variant constructor anchored"><a href="#type-t.E_message" class="anchor"></a><code><span>| </span><span><span class="constructor">E_message</span> <span class="keyword">of</span> </span><span>{</span></code><ol><li id="type-t.tid" class="def record field anchored"><a href="#type-t.tid" class="anchor"></a><code><span>tid : int;</span></code></li><li id="type-t.msg" class="def record field anchored"><a href="#type-t.msg" class="anchor"></a><code><span>msg : string;</span></code></li><li id="type-t.time_ns" class="def record field anchored"><a href="#type-t.time_ns" class="anchor"></a><code><span>time_ns : int64;</span></code></li><li id="type-t.data" class="def record field anchored"><a href="#type-t.data" class="anchor"></a><code><span>data : <span><span>(string * <a href="../../Trace_subscriber/index.html#type-user_data">Sub.user_data</a>)</span> list</span>;</span></code></li></ol><code><span>}</span></code></li><li id="type-t.E_define_span" class="def variant constructor anchored"><a href="#type-t.E_define_span" class="anchor"></a><code><span>| </span><span><span class="constructor">E_define_span</span> <span class="keyword">of</span> </span><span>{</span></code><ol><li id="type-t.tid" class="def record field anchored"><a href="#type-t.tid" class="anchor"></a><code><span>tid : int;</span></code></li><li id="type-t.name" class="def record field anchored"><a href="#type-t.name" class="anchor"></a><code><span>name : string;</span></code></li><li id="type-t.time_ns" class="def record field anchored"><a href="#type-t.time_ns" class="anchor"></a><code><span>time_ns : int64;</span></code></li><li id="type-t.id" class="def record field anchored"><a href="#type-t.id" class="anchor"></a><code><span>id : <a href="../../Trace_core/index.html#type-span">Trace_core.span</a>;</span></code></li><li id="type-t.fun_name" class="def record field anchored"><a href="#type-t.fun_name" class="anchor"></a><code><span>fun_name : <span>string option</span>;</span></code></li><li id="type-t.data" class="def record field anchored"><a href="#type-t.data" class="anchor"></a><code><span>data : <span><span>(string * <a href="../../Trace_subscriber/index.html#type-user_data">Sub.user_data</a>)</span> list</span>;</span></code></li></ol><code><span>}</span></code></li><li id="type-t.E_exit_span" class="def variant constructor anchored"><a href="#type-t.E_exit_span" class="anchor"></a><code><span>| </span><span><span class="constructor">E_exit_span</span> <span class="keyword">of</span> </span><span>{</span></code><ol><li id="type-t.id" class="def record field anchored"><a href="#type-t.id" class="anchor"></a><code><span>id : <a href="../../Trace_core/index.html#type-span">Trace_core.span</a>;</span></code></li><li id="type-t.time_ns" class="def record field anchored"><a href="#type-t.time_ns" class="anchor"></a><code><span>time_ns : int64;</span></code></li></ol><code><span>}</span></code></li><li id="type-t.E_add_data" class="def variant constructor anchored"><a href="#type-t.E_add_data" class="anchor"></a><code><span>| </span><span><span class="constructor">E_add_data</span> <span class="keyword">of</span> </span><span>{</span></code><ol><li id="type-t.id" class="def record field anchored"><a href="#type-t.id" class="anchor"></a><code><span>id : <a href="../../Trace_core/index.html#type-span">Trace_core.span</a>;</span></code></li><li id="type-t.data" class="def record field anchored"><a href="#type-t.data" class="anchor"></a><code><span>data : <span><span>(string * <a href="../../Trace_subscriber/index.html#type-user_data">Sub.user_data</a>)</span> list</span>;</span></code></li></ol><code><span>}</span></code></li><li id="type-t.E_enter_manual_span" class="def variant constructor anchored"><a href="#type-t.E_enter_manual_span" class="anchor"></a><code><span>| </span><span><span class="constructor">E_enter_manual_span</span> <span class="keyword">of</span> </span><span>{</span></code><ol><li id="type-t.tid" class="def record field anchored"><a href="#type-t.tid" class="anchor"></a><code><span>tid : int;</span></code></li><li id="type-t.name" class="def record field anchored"><a href="#type-t.name" class="anchor"></a><code><span>name : string;</span></code></li><li id="type-t.time_ns" class="def record field anchored"><a href="#type-t.time_ns" class="anchor"></a><code><span>time_ns : int64;</span></code></li><li id="type-t.id" class="def record field anchored"><a href="#type-t.id" class="anchor"></a><code><span>id : <a href="../../Trace_core/index.html#type-trace_id">Trace_core.trace_id</a>;</span></code></li><li id="type-t.flavor" class="def record field anchored"><a href="#type-t.flavor" class="anchor"></a><code><span>flavor : <span><a href="../../Trace_subscriber/index.html#type-flavor">Sub.flavor</a> option</span>;</span></code></li><li id="type-t.fun_name" class="def record field anchored"><a href="#type-t.fun_name" class="anchor"></a><code><span>fun_name : <span>string option</span>;</span></code></li><li id="type-t.data" class="def record field anchored"><a href="#type-t.data" class="anchor"></a><code><span>data : <span><span>(string * <a href="../../Trace_subscriber/index.html#type-user_data">Sub.user_data</a>)</span> list</span>;</span></code></li></ol><code><span>}</span></code></li><li id="type-t.E_exit_manual_span" class="def variant constructor anchored"><a href="#type-t.E_exit_manual_span" class="anchor"></a><code><span>| </span><span><span class="constructor">E_exit_manual_span</span> <span class="keyword">of</span> </span><span>{</span></code><ol><li id="type-t.tid" class="def record field anchored"><a href="#type-t.tid" class="anchor"></a><code><span>tid : int;</span></code></li><li id="type-t.name" class="def record field anchored"><a href="#type-t.name" class="anchor"></a><code><span>name : string;</span></code></li><li id="type-t.time_ns" class="def record field anchored"><a href="#type-t.time_ns" class="anchor"></a><code><span>time_ns : int64;</span></code></li><li id="type-t.flavor" class="def record field anchored"><a href="#type-t.flavor" class="anchor"></a><code><span>flavor : <span><a href="../../Trace_subscriber/index.html#type-flavor">Sub.flavor</a> option</span>;</span></code></li><li id="type-t.data" class="def record field anchored"><a href="#type-t.data" class="anchor"></a><code><span>data : <span><span>(string * <a href="../../Trace_subscriber/index.html#type-user_data">Sub.user_data</a>)</span> list</span>;</span></code></li><li id="type-t.id" class="def record field anchored"><a href="#type-t.id" class="anchor"></a><code><span>id : <a href="../../Trace_core/index.html#type-trace_id">Trace_core.trace_id</a>;</span></code></li></ol><code><span>}</span></code></li><li id="type-t.E_counter" class="def variant constructor anchored"><a href="#type-t.E_counter" class="anchor"></a><code><span>| </span><span><span class="constructor">E_counter</span> <span class="keyword">of</span> </span><span>{</span></code><ol><li id="type-t.name" class="def record field anchored"><a href="#type-t.name" class="anchor"></a><code><span>name : string;</span></code></li><li id="type-t.tid" class="def record field anchored"><a href="#type-t.tid" class="anchor"></a><code><span>tid : int;</span></code></li><li id="type-t.time_ns" class="def record field anchored"><a href="#type-t.time_ns" class="anchor"></a><code><span>time_ns : int64;</span></code></li><li id="type-t.n" class="def record field anchored"><a href="#type-t.n" class="anchor"></a><code><span>n : float;</span></code></li></ol><code><span>}</span></code></li><li id="type-t.E_name_process" class="def variant constructor anchored"><a href="#type-t.E_name_process" class="anchor"></a><code><span>| </span><span><span class="constructor">E_name_process</span> <span class="keyword">of</span> </span><span>{</span></code><ol><li id="type-t.name" class="def record field anchored"><a href="#type-t.name" class="anchor"></a><code><span>name : string;</span></code></li></ol><code><span>}</span></code></li><li id="type-t.E_name_thread" class="def variant constructor anchored"><a href="#type-t.E_name_thread" class="anchor"></a><code><span>| </span><span><span class="constructor">E_name_thread</span> <span class="keyword">of</span> </span><span>{</span></code><ol><li id="type-t.tid" class="def record field anchored"><a href="#type-t.tid" class="anchor"></a><code><span>tid : int;</span></code></li><li id="type-t.name" class="def record field anchored"><a href="#type-t.name" class="anchor"></a><code><span>name : string;</span></code></li></ol><code><span>}</span></code></li><li id="type-t.E_extension_event" class="def variant constructor anchored"><a href="#type-t.E_extension_event" class="anchor"></a><code><span>| </span><span><span class="constructor">E_extension_event</span> <span class="keyword">of</span> </span><span>{</span></code><ol><li id="type-t.tid" class="def record field anchored"><a href="#type-t.tid" class="anchor"></a><code><span>tid : int;</span></code></li><li id="type-t.time_ns" class="def record field anchored"><a href="#type-t.time_ns" class="anchor"></a><code><span>time_ns : int64;</span></code></li><li id="type-t.ext" class="def record field anchored"><a href="#type-t.ext" class="anchor"></a><code><span>ext : <a href="../../Trace_core/index.html#type-extension_event">Trace_core.extension_event</a>;</span></code></li></ol><code><span>}</span></code></li></ol></div><div class="spec-doc"><p>An event with TEF/fuchsia semantics</p></div></div></div></body></html>