@ciao-lang/ts-ciao-interface
Version:
Simple Ciao interface for node.
22 lines • 7.79 kB
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>HTTP client — 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="http_doc.html">↑</a><a class="lpdoc-navbutton" href="http_doc.html">←</a><a class="lpdoc-navbutton" href="http_server.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="ExtraLibs.html">PART VIII - Additional libraries</a> »<br/> </li><li><a href="http_doc.html">HTTP client/server libraries</a> »<br/> </li><li><a href=""><strong>HTTP client</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 exports">Documentation on exports</a></li><li><a href="#Documentation on imports">Documentation on imports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>HTTP client</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#http_client"></a>
<strong>Author(s):</strong> <a class="lpdoc-idx-anchor" id="Daniel Cabeza" href="ciaosearch.html#Daniel Cabeza">Daniel Cabeza</a>, <a class="lpdoc-idx-anchor" id="Jose F. Morales" href="ciaosearch.html#Jose F. Morales">Jose F. Morales (fixes, improvements)</a>.<p>
<p>This module implements a client the <a class="lpdoc-idx-anchor" id="0" href="ciaosearch.html#HTTP">HTTP</a> protocol.<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(http/http_client)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="1" href="#fetch_url/3"><tt>fetch_url/3</tt></a>.
</ul></ul></div></div><div id="Documentation on exports"><h2>Documentation on exports</h2><div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="fetch_url/3" href="ciaosearch.html#fetch_url/3">fetch_url/3</a></div><div class="lpdoc-deftext"><span class="lpdoc-usage-decl"><tt>fetch_url(URL,Request,Response)</tt>
</span><p>Fetches the document pointed to by <span class="lpdoc-var">URL</span> from Internet, using request parameters <span class="lpdoc-var">Request</span> (<tt>get</tt> method by default), and unifies <span class="lpdoc-var">Response</span> with the parameters of the response. Fails on timeout. Note that redirections are not handled automatically, that is, if <span class="lpdoc-var">Response</span> contains terms of the form <tt>status(redirection,301,_)</tt> and <tt>location(NewURL)</tt>, the program should in most cases access location <tt>NewURL</tt>.<p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>fetch_url(URL,Request,Response)</tt>
</span><p></p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="2" href="url.html#url_term/1"><tt>url:url_term/1</tt></a>)</span><span><span class="lpdoc-var">URL</span> specifies a URL.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="3" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)</span><span><span class="lpdoc-var">Request</span> is a list of <span class="lpdoc-var">http_request_param</span>s.
</span>
<li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="4" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)</span><span><span class="lpdoc-var">Response</span> is a list of <span class="lpdoc-var">http_response_param</span>s.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="http_request_param/1" href="ciaosearch.html#http_request_param/1">http_request_param/1</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="5" href="http_messages.html"><tt>http_messages</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="http_request_param/1" href="ciaosearch.html#http_request_param/1">http_request_param/1</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="6" href="http_messages.html"><tt>http_messages</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="http_response_param/1" href="ciaosearch.html#http_response_param/1">http_response_param/1</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="7" href="http_messages.html"><tt>http_messages</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="http_response_param/1" href="ciaosearch.html#http_response_param/1">http_response_param/1</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="8" href="http_messages.html"><tt>http_messages</tt></a> (see the corresponding documentation for details).<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="9" href="lists.html"><tt>lists</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="url.html"><tt>url</tt></a>, <a class="lpdoc-idx-anchor" id="11" href="http_messages.html"><tt>http_messages</tt></a>, <a class="lpdoc-idx-anchor" id="12" href="sockets.html"><tt>sockets</tt></a>, <a class="lpdoc-idx-anchor" id="13" href="stream_utils.html"><tt>stream_utils</tt></a>.
<li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="14" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="15" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="16" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="17" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="19" href="isomodes_doc.html"><tt>isomodes</tt></a>, <a class="lpdoc-idx-anchor" id="20" href="regtypes_doc.html"><tt>regtypes</tt></a>, <a class="lpdoc-idx-anchor" id="21" href="dcg_doc.html"><tt>dcg</tt></a>, <a class="lpdoc-idx-anchor" id="22" href="ciaosearch.html#hiord"><tt>hiord</tt></a>, <a class="lpdoc-idx-anchor" id="23" href="doccomments_doc.html"><tt>doccomments</tt></a>.
</ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>