@ciao-lang/ts-ciao-interface

Version:

Simple Ciao interface for node.

61 lines • 14.4 kB

HTML

<!DOCTYPE HTML><html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1"/><meta name="theme-color" content="#273f79"/><link rel="stylesheet" href="lpdoc.css" type="text/css"/><script type="text/javascript" src="lpdoc.js"></script><title>The ``webbased'' registry protocol — The Ciao System v1.22</title></head><body><div class="lpdoc-page fixleftbar"><a href="#" id="sidebar-toggle-button" class="lpdoc-navbutton"><span id="sidebar-button-arrow">☰</span></a><div id="sidebar" class="lpdoc-sidebar"><div style="height: 40px; margin-left: auto; margin-right: auto"><img src="ciao-logo_autofig.png" width=auto height=100%></div><div class="lpdoc-nav"><span class="lpdoc-on-right"><a class="lpdoc-navbutton" href="actmod_dist.html">↑</a><a class="lpdoc-navbutton" href="regp_platformbased.html">←</a><a class="lpdoc-navbutton" href="actmod_process.html">→</a><a class="lpdoc-navbutton" href="ciaosearch.html">🔍</a></span><span><a href="ciaofulltoc.html">TOC</a></span></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="ciao.html">The Ciao System</a> »<br/> </li><li><a href="ExtendLang.html">PART IV - Language extensions</a> »<br/> </li><li><a href="actmod_doc.html">Active modules</a> »<br/> </li><li><a href="actmod_dist.html">Distribution protocol for active modules</a> »<br/> </li><li><a href=""><strong>The ``webbased'' registry protocol</strong></a></li></ul><hr></hr><em>ON THIS PAGE</em><ul><li><a href="#Usage and interface">Usage and interface</a></li><li><a href="#Documentation on multifiles">Documentation on multifiles</a></li><li><a href="#Documentation on imports">Documentation on imports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>The ``webbased'' registry protocol</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#regp_webbased"></a> The <tt>webbased</tt> registry is also based on another active module working as a <a class="lpdoc-idx-anchor" id="0" href="ciaosearch.html#name server">name server</a>. The address of the registry must be specified in an application file named <tt>webbased_common.pl</tt> (see section below).<p>An application using a name server for active modules must have a file named <tt>webbased_common.pl</tt> that specifies where the name server resides. It must have the <tt>URL</tt> and the path which corresponds to that <tt>URL</tt> in the file system of the server machine (the one that hosts the <tt>URL</tt>) of the file that will hold the name server address.<p>The current distribution provides a file <tt>webbased_common.pl</tt> that can be used (after proper setting of its contents) for a server of active modules for a whole installation. Alternatively, particular servers for each application can be set up (see below).<p>The example implementation <a class="lpdoc-idx-anchor" id="1" href="ciaosearch.html#examples/nameserver/nameserver.pl"><tt>examples/nameserver/nameserver.pl</tt></a> can also be used for this registry protocol.<p>To set up a name server edit <tt>webbased_common.pl</tt> to change its contents appropriately as described above (<tt>URL</tt> and corresponding complete file path). Then recompile this library module:<p><pre class="lpdoc-codeblock">ciaoc -c webbased_common </pre> <br/><div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li><strong>Library usage:</strong><br/><tt>:- use_module(library(actmod/regp_webbased)).</tt></ul></div></div><div id="Documentation on multifiles"><h2>Documentation on multifiles</h2><div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="$curr_mod/1" href="ciaosearch.html#$curr_mod/1">$curr_mod/1</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="fnct.decl_at_mod/2" href="ciaosearch.html#fnct.decl_at_mod/2">fnct.decl_at_mod/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="fnct.prop/2" href="ciaosearch.html#fnct.prop/2">fnct.prop/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="$fnct_stub_rename/2" href="ciaosearch.html#$fnct_stub_rename/2">$fnct_stub_rename/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="$handle_stream/2" href="ciaosearch.html#$handle_stream/2">$handle_stream/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="$current_msg/3" href="ciaosearch.html#$current_msg/3">$current_msg/3</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="gsusp.guard/4" href="ciaosearch.html#gsusp.guard/4">gsusp.guard/4</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="gsusp.run/2" href="ciaosearch.html#gsusp.run/2">gsusp.run/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="async.ftypes/2" href="ciaosearch.html#async.ftypes/2">async.ftypes/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="async.run/2" href="ciaosearch.html#async.run/2">async.run/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="$fiber_susp_hook/2" href="ciaosearch.html#$fiber_susp_hook/2">$fiber_susp_hook/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="transient.decl/1" href="ciaosearch.html#transient.decl/1">transient.decl/1</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="actmod_publish.save_addr/6" href="ciaosearch.html#actmod_publish.save_addr/6">actmod_publish.save_addr/6</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="actmod_locate.remote_address/4" href="ciaosearch.html#actmod_locate.remote_address/4">actmod_locate.remote_address/4</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="actmod_locate.cleanup_actI/2" href="ciaosearch.html#actmod_locate.cleanup_actI/2">actmod_locate.cleanup_actI/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="$dist_addr_retry/1" href="ciaosearch.html#$dist_addr_retry/1">$dist_addr_retry/1</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="$dmod_reg_protocol/2" href="ciaosearch.html#$dmod_reg_protocol/2">$dmod_reg_protocol/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="$dmod_src/2" href="ciaosearch.html#$dmod_src/2">$dmod_src/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="$dmod_prop/2" href="ciaosearch.html#$dmod_prop/2">$dmod_prop/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="$local_actmod/1" href="ciaosearch.html#$local_actmod/1">$local_actmod/1</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="$static_named_actRef/2" href="ciaosearch.html#$static_named_actRef/2">$static_named_actRef/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="$dmod_proxy/2" href="ciaosearch.html#$dmod_proxy/2">$dmod_proxy/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="$actmod_exe/3" href="ciaosearch.html#$actmod_exe/3">$actmod_exe/3</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="qprot.collect/3" href="ciaosearch.html#qprot.collect/3">qprot.collect/3</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="qprot.dec/4" href="ciaosearch.html#qprot.dec/4">qprot.dec/4</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="qprot.enc/3" href="ciaosearch.html#qprot.enc/3">qprot.enc/3</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="qprot.prepare_query/4" href="ciaosearch.html#qprot.prepare_query/4">qprot.prepare_query/4</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="qprot.join_answers/7" href="ciaosearch.html#qprot.join_answers/7">qprot.join_answers/7</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is <em>multifile</em>.<br/></div></div><p> </div><div id="Documentation on imports"><h2>Documentation on imports</h2>This module has the following direct dependencies:<ul class="lpdoc-itemize-minus"><li><em>System library modules:</em><br/><a class="lpdoc-idx-anchor" id="2" href="ciaosearch.html#fibers_rt"><tt>fibers_rt</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="actmod_rt.html"><tt>actmod_rt</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="ciaosearch.html#regp_webserver"><tt>regp_webserver</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="regp_filebased.html"><tt>regp_filebased</tt></a>. <li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="6" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="actmod_doc.html"><tt>actmod</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="ciaosearch.html#fibers"><tt>fibers</tt></a>, <a class="lpdoc-idx-anchor" id="11" href="traits_doc.html"><tt>traits</tt></a>, <a class="lpdoc-idx-anchor" id="12" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="13" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>. </ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>