mirror of
https://github.com/ocaml-tracing/ocaml-trace.git
synced 2026-03-09 12:23:32 -04:00
2 lines
3.5 KiB
HTML
2 lines
3.5 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Exporter (trace-fuchsia.Trace_fuchsia.Exporter)</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">trace-fuchsia</a> » <a href="../index.html">Trace_fuchsia</a> » Exporter</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_fuchsia.Exporter</span></code></h1><p>An exporter, takes buffers with fuchsia events, and writes them somewhere</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> t</span><span> = </span><span>{</span></code><ol><li id="type-t.write_bufs" class="def record field anchored"><a href="#type-t.write_bufs" class="anchor"></a><code><span>write_bufs : <span><span><a href="../Buf/index.html#type-t">Buf.t</a> <a href="../../../ocaml/Stdlib/Queue/index.html#type-t">Stdlib.Queue.t</a></span> <span class="arrow">-></span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Takes buffers and writes them somewhere. The buffers are only valid during this call and must not be stored. The queue must not be modified.</p><span class="comment-delim">*)</span></div></li><li id="type-t.flush" class="def record field anchored"><a href="#type-t.flush" class="anchor"></a><code><span>flush : <span>unit <span class="arrow">-></span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Force write</p><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 underlying resources</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>An exporter, takes buffers and writes them somewhere. This should be thread-safe if used in a threaded environment.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_out_channel"><a href="#val-of_out_channel" class="anchor"></a><code><span><span class="keyword">val</span> of_out_channel : <span><span class="label">close_channel</span>:bool <span class="arrow">-></span></span> <span><a href="../../../ocaml/Stdlib/index.html#type-out_channel">out_channel</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Export to the channel</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">close_channel</span> <p>if true, closing the exporter will close the channel</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_buffer"><a href="#val-of_buffer" class="anchor"></a><code><span><span class="keyword">val</span> of_buffer : <span><a href="../../../ocaml/Stdlib/Buffer/index.html#type-t">Stdlib.Buffer.t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></div></body></html>
|