ocaml-rpc/capnp-rpc/Capnp_rpc/Service/Response/index.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Response (capnp-rpc.Capnp_rpc.Service.Response)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/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">capnp-rpc</a> &#x00BB; <a href="../../index.html">Capnp_rpc</a> &#x00BB; <a href="../index.html">Service</a> &#x00BB; Response</nav><header class="odoc-preamble"><h1>Module <code><span>Service.Response</span></code></h1></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>'b t</span></span></code></div><div class="spec-doc"><p>An <code>'a t</code> is a builder for the out-going response.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span><span class="optlabel">?message_size</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span><span class="xref-unresolved">Capnp</span>.Message.rw <a href="../../Slice/index.html#type-t">Slice.t</a></span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span> * <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>create init</code> is a fresh response and contents builder. Use one of the generated <code>init_pointer</code> functions for <code>init</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create_empty"><a href="#val-create_empty" class="anchor"></a><code><span><span class="keyword">val</span> create_empty : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>empty ()</code> is an empty response.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-release"><a href="#val-release" class="anchor"></a><code><span><span class="keyword">val</span> release : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Clear the exported refs, dropping their ref-counts. This is called automatically when you send a message, but you might need it if you decide to abort.</p></div></div></div></body></html>