@ciao-lang/ts-ciao-interface

Version:

Simple Ciao interface for node.

26 lines • 12.8 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>HTTP messages (response and request) — The Ciao System v1.22</title></head><body><div class="lpdoc-page fixleftbar"><a href="#" id="sidebar-toggle-button" class="lpdoc-navbutton">☰</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"><a class="lpdoc-navbutton" href="http_doc.html">↑</a><a class="lpdoc-navbutton" href="cgi.html">←</a><a class="lpdoc-navbutton" href="http_date.html">→</a><a class="lpdoc-navbutton" href="ciaosearch.html">🔍</a><a href="ciaofulltoc.html">TOC</a></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="ciao.html">The Ciao System</a> » </li><li><a href="ExtraLibs.html">PART VIII - Additional libraries</a> » </li><li><a href="http_doc.html">HTTP client/server libraries</a> » </li><li><a href="">HTTP messages (response and request)</a></li></ul><hr></hr>ON THIS PAGE<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 messages (response and request)</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#http_messages"></a> Author(s): <a class="lpdoc-idx-anchor" id="The Ciao Development Team" href="ciaosearch.html#The Ciao Development Team">The Ciao Development Team</a>. Parser/printer for HTTP response and request messages.See <a href="https://www.w3.org/Protocols/rfc2616/rfc2616.html">RFC2616</a> for a reference of HTTP/1.1 protocol.The request and response objects are represented as list of terms, which represent HTTP header fields and other elements (such as the status, and contents).The current list of request headers is:<ul> <li>method(Method): Method is the HTTP method in lowercase (<tt>head</tt>, <tt>get</tt>, <tt>post</tt>, etc.).<li>timeout(T): T specifies the time in seconds to wait for the response. Default is 300 seconds.<li>if_modified_since(Date): Get document only if newer than Date. Date has the format defined by <a class="lpdoc-idx-anchor" id="0" href="http_date.html#http_date/1"><tt>http_date/1</tt></a>.<li>user_agent(Agent): Provides a user-agent field, Agent is an atom.<li>authorization(Scheme,Params): To provide credentials. See RFC 1945 for details.<li>option(Value): Any unary term, being Value an atom, can be used to provide another valid option (e.g. <tt>from('user@machine')</tt>). </ul> The current list of response headers is: <ul> <li>status(Type,Code,Reason): Type is an atom denoting the response type, Code is the status code (an integer), and Reason is a string holding the reason phrase.<li>date(Date): Date is the date of the response, with format defined by <a class="lpdoc-idx-anchor" id="1" href="http_date.html#http_date/1"><tt>http_date/1</tt></a>.<li>location(Loc): This parameter appears when the document has moved, Loc is an atom holding the new location.<li>server(Server): Server is the server responding, as an atom.<li>www_authenticate(Params): Returned if document is protected, Params is a list of chagenges. See RFC 1945 for details.<li>allow(Methods): Methods are the methods allowed by the server, as a list of atoms.<li>content_encoding(Encoding): Encoding is an atom defining the encoding.<li>expires(Date): Date is the date after which the entity should be considered stale. Format defined by <a class="lpdoc-idx-anchor" id="2" href="http_date.html#http_date/1"><tt>http_date/1</tt></a>.<li>last_modified(Date): Date is the date at which the sender believes the resource was last modified. Format defined by <a class="lpdoc-idx-anchor" id="3" href="http_date.html#http_date/1"><tt>http_date/1</tt></a>.<li>pragma(String): Miscellaneous data.<li>header(String): Any other functor header/1 is an extension header. </ul> The current list of some common headers is: <ul> <li>content_length(Length): Length is the length of the document (an integer). <li>content_type(Type,Subtype,Params): Specifies the document content type, Type and Subtype are atoms, Params a list of parameters (e.g. <tt>content_type(text,html,[])</tt>). <li>content(Bytes): Bytes is the document content (bytelist/1). If <tt>method(head)</tt> of the HTTP request is used, an empty list is get here.</ul> <div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li>Library usage: <tt>:- use_module(library(http/http_messages)).</tt><li>Exports: <ul class="lpdoc-itemize-minus"><li>Predicates: <a class="lpdoc-idx-anchor" id="4" href="#http_request_str/4"><tt>http_request_str/4</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#name_to_method/2"><tt>name_to_method/2</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="#http_response_str/3"><tt>http_response_str/3</tt></a>. <li>Regular Types: <a class="lpdoc-idx-anchor" id="7" href="#http_request_param/1"><tt>http_request_param/1</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="#http_response_param/1"><tt>http_response_param/1</tt></a>. </ul></ul></div></div><div id="Documentation on exports"><h2>Documentation on exports</h2><div><div class="lpdoc-defname">REGTYPE<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">Usage:<tt>http_request_param(Request)</tt> Request is a parameter of an HTTP request.<ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="http_request_str/4" href="ciaosearch.html#http_request_str/4">http_request_str/4</a></div><div class="lpdoc-deftext">Usage 1:<tt>http_request_str(RequestURI,Request,RequestBytes,RequestBytesTail)</tt> Parse a string into an HTTP request<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="9" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)RequestURI is a free variable. (<a class="lpdoc-idx-anchor" id="10" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Request is a free variable. (<a class="lpdoc-idx-anchor" id="11" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)RequestBytes is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="12" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)RequestBytesTail is currently a term which is not a free variable. </ul>Usage 2:<tt>http_request_str(RequestURI,Request,RequestBytes,RequestBytesTail)</tt> Generate an HTTP request from a list of parameters<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="13" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)RequestURI is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="14" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Request is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="15" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)RequestBytes is a free variable. (<a class="lpdoc-idx-anchor" id="16" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)RequestBytesTail is a free variable. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="name_to_method/2" href="ciaosearch.html#name_to_method/2">name_to_method/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div> <div><div class="lpdoc-defname">REGTYPE<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">Usage:<tt>http_response_param(Response)</tt> Response is a parameter of an HTTP response.<ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="http_response_str/3" href="ciaosearch.html#http_response_str/3">http_response_str/3</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div> </div><div id="Documentation on imports"><h2>Documentation on imports</h2>This module has the following direct dependencies:<ul class="lpdoc-itemize-minus"><li>System library modules: <a class="lpdoc-idx-anchor" id="17" href="lists.html"><tt>lists</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="http_grammar.html"><tt>http_grammar</tt></a>, <a class="lpdoc-idx-anchor" id="19" href="http_date.html"><tt>http_date</tt></a>. <li>Packages: <a class="lpdoc-idx-anchor" id="20" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="21" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="22" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="23" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="24" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="25" href="regtypes_doc.html"><tt>regtypes</tt></a>, <a class="lpdoc-idx-anchor" id="26" href="isomodes_doc.html"><tt>isomodes</tt></a>, <a class="lpdoc-idx-anchor" id="27" href="dcg_doc.html"><tt>dcg</tt></a>, <a class="lpdoc-idx-anchor" id="28" href="ciaosearch.html#hiord"><tt>hiord</tt></a>, <a class="lpdoc-idx-anchor" id="29" 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>