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

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Service (capnp-rpc.Capnp_rpc.Service)</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; Service</nav><header class="odoc-preamble"><h1>Module <code><span>Capnp_rpc.Service</span></code></h1><p>Functions for service implementors.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-method_t"><a href="#type-method_t" class="anchor"></a><code><span><span class="keyword">type</span> <span>('a, 'b) method_t</span></span><span> = <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span>unit <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="../StructRef/index.html#type-t">StructRef.t</a></span></span></code></div><div class="spec-doc"><p>An ('a, 'b) method_t is a method implementation that takes a reader for the parameters and a function to release the capabilities in the parameters, and returns a promise for the results.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Response"><a href="#module-Response" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Response/index.html">Response</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span><span class="type-var">'a</span> <a href="Response/index.html#type-t">Response.t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="../StructRef/index.html#type-t">StructRef.t</a></span></span></code></div><div class="spec-doc"><p><code>return r</code> wraps up a simple local result as a promise.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-return_empty"><a href="#val-return_empty" class="anchor"></a><code><span><span class="keyword">val</span> return_empty : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="../StructRef/index.html#type-t">StructRef.t</a></span></span></code></div><div class="spec-doc"><p><code>return_empty ()</code> is a promise for a response with no payload.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-error"><a href="#val-error" class="anchor"></a><code><span><span class="keyword">val</span> error : <span><a href="../../Capnp_rpc_proto/Error/index.html#type-t">Error.t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="../StructRef/index.html#type-t">StructRef.t</a></span></span></code></div><div class="spec-doc"><p><code>error e</code> is a broken promise for a struct, with error <code>e</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fail"><a href="#val-fail" class="anchor"></a><code><span><span class="keyword">val</span> fail : 
  <span><span class="optlabel">?ty</span>:<a href="../../Capnp_rpc_proto/Exception/index.html#type-ty">Exception.ty</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span><span>(<span class="type-var">'a</span>, <span class="xref-unresolved">Stdlib</span>.Format.formatter, unit, <span><span class="type-var">'b</span> <a href="../StructRef/index.html#type-t">StructRef.t</a></span>)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">&#45;&gt;</span></span>
  <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>fail msg</code> is an exception <a href="#val-error"><code>error</code></a> with reason <code>msg</code>.</p></div></div></div></body></html>