@ciao-lang/ts-ciao-interface

Version:

Simple Ciao interface for node.

36 lines • 9.86 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 ``filebased'' 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="actmod_dist.html">←</a><a class="lpdoc-navbutton" href="regp_platformbased.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 ``filebased'' 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 ``filebased'' registry protocol</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#regp_filebased"></a> The <tt>filebased</tt> saves the IP address and socket number of the server in a <em><module_name></em><tt>.addr</tt> file at the address file directory or in the directory that a <tt>.addr</tt> file, if it exists, specifies.<p>The address file directory can be selected with the <a class="lpdoc-idx-anchor" id="0" href="ciaosearch.html#set_reg_dir/1"><tt>set_reg_dir/1</tt></a> predicate at <a class="lpdoc-idx-anchor" id="1" href="ciaosearch.html#filebased_common"><tt>filebased_common</tt></a> or the <tt>--reg-dir</tt> option for server startup.<p>By default, this directory is set to the temporary directory (see <a class="lpdoc-idx-anchor" id="2" href="system.html#get_tmp_dir/1"><tt>get_tmp_dir/1</tt></a> at <a class="lpdoc-idx-anchor" id="3" href="system.html"><tt>system</tt></a>).<p>Note that servers and clients can be started in different machines, provided this directory is shared (e.g., by NFS or Samba), or the file can be moved to an appropriate directory on a different machine --provided the full path is the same.<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_filebased)).</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="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="4" href="system.html"><tt>system</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="system_extra.html"><tt>system_extra</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="ciaosearch.html#filebased_common"><tt>filebased_common</tt></a>. <li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="7" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="11" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="12" href="traits_doc.html"><tt>traits</tt></a>. </ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>