SWI-Prolog 10.1.6
All Application Manual Name SummaryHelp

SWI-Prolog HTTP support library

This directory provides the SWI-Prolog libraries for accessing and providing HTTP services.

Client library

The main client library is library(http/http_open), which can open both HTTP and HTTPS connections and handle all request methods.

Server library

The main server libraries are

For simplicity, you can use library(http/http_server), which combines the typical HTTP libraries that most servers need. The idea of a common request handling system and three controlling libraries is outdated; the threaded server now being the only sensible controlling library.

Requirements

This library uses functionality from the ssl package to support HTTPS, the sgml package to read XML/HTML and the clib package for various extensions.

Prolog files

html_decl.plShow source
html_meta/1This directive can be used to declare that an HTML rendering rule takes HTML content as argument.Source
html_no_content/1True when Element has no content.Source
html_head.pl  -- Automatic inclusion of CSS and scripts linksShow source
html_quasiquotations.plShow source
html/4The predicate html/4 implements HTML quasi quotations.Source
html_write.plShow source
html/3Generate HTML from Content.Source
html_begin/3For html_begin//1, Env is a term Env(Attributes); for html_end//1 it is the plain environment name.Source
html_current_option/1True if Option is an active option for the HTML generator.Source
html_end/3For html_begin//1, Env is a term Env(Attributes); for html_end//1 it is the plain environment name.Source
html_header_hook/1This multifile hook is called just before the Content-type header is emitted.Source
html_post/4Reposition HTML to the receiving Id.Source
html_quoted/3Quote the value for normal (CDATA) text.Source
html_quoted_attribute/3Quote the value according to the rules for tag-attributes included in double-quotes.Source
html_receive/3Receive posted HTML tokens.Source
html_receive/4This extended version of html_receive//1 causes Handler to be called to process all messages posted to the channel at the time output is generated.Source
html_root_attribute/4Add an attribute to the HTML root element of the page.Source
html_set_options/1Set options for the HTML output.Source
layout/3Define required newlines before and after tags.Source
page/3Generate a page including the HTML <!DOCTYPE> header.Source
page/4Generate a page including the HTML <!DOCTYPE> header.Source
print_html/1Print list of atoms and layout instructions.Source
print_html/2Print list of atoms and layout instructions.Source
reply_html_page/2Provide the complete reply as required by http_wrapper.pl for a page constructed from Head and Body.Source
reply_html_page/3Provide the complete reply as required by http_wrapper.pl for a page constructed from Head and Body.Source
reply_html_partial/1Reply with partial HTML document.Source
xhtml_ns/4Demand an xmlns:id=Value in the outer html tag.Source
http_client.plShow source
post_data_hook/3Hook to extend the datatypes supported by the post(Data) option of http_open/3.Source
http_convert_data/4Multi-file hook to convert a HTTP payload according to the Content-Type header.Source
http_delete/3Execute a DELETE method on the server.Source
http_disconnect/1Close down some connections.Source
http_get/3Get data from a URL server and convert it to a suitable Prolog representation based on the Content-Type header and plugins.Source
http_patch/4Issue an HTTP PATCH request.Source
http_post/4Issue an HTTP POST request.Source
http_put/4Issue an HTTP PUT request.Source
http_read_data/3Read data from an HTTP connection and convert it according to the supplied to(Format) option or based on the Content-type in the Request.Source
http_cors.pl  -- Enable CORS: Cross-Origin Resource SharingShow source
http_dispatch.pl  -- Dispatch requests in the HTTP serverShow source
http_dyn_workers.plShow source
schedule_workers/1Called if there is no immediately free worker to handle the incoming request.Source
http_exception.pl  -- Map Prolog exceptions to HTTP errorsShow source
http_header.pl  -- Handling HTTP headersShow source
http_hook.plShow source
convert_parameter/3Hook to execute a step in the HTTP parameter conversion process.
http_connection_over_proxy/6Try to connect to the host Endpoint via Proxy for the purposes of retrieving the resource identified by URLParts.Source
http_host.pl  -- Obtain public server locationShow source
http_log.plShow source
http_log/2Write message from Format and Args to log-stream.Source
http_log_close/1If there is a currently open HTTP logfile, close it after adding a term server(Reason, Time).Source
http_log_stream/1True when Stream is a stream to the opened HTTP log file.Source
http_logrotate/1Rotate the available log files.Source
http_schedule_logrotate/2Schedule log rotation based on maintenance broadcasts.Source
nolog/1Multifile predicate that can be defined to hide request parameters from the request logfile.Source
password_field/1Multifile predicate that can be defined to hide passwords from the logfile.Source
post_data_encoded/2Encode the POST body for inclusion into the HTTP log file.Source
http_multipart_plugin.plShow source
http_convert_data/4Convert multipart/form-data messages for http_read_data/3.Source
http_open.plShow source
disable_encoding_filter/1Do not use the Content-encoding as Transfer-encoding encoding for specific values of ContentType.Source
http_close_keep_alive/1Close all keep-alive connections matching Address.Source
http_open/3Open the data at the HTTP server as a Prolog stream.Source
http_set_authorization/2Set user/password to supply with URLs that have URL as prefix.Source
keep_alive/4Callback when closing the range stream used to process the content of the reply.Source
map_method/2Support additional METHOD keywords.Source
open_hook/6Hook implementation that makes open_any/5 support http and https URLs for Mode == read.Source
http_parameters.pl  -- Extract parameters (GET and POST) from HTTP requestsShow source
http_path.plShow source
location/3Multifile hook used to specify new HTTP locations.Source
http_absolute_location/3Path is the HTTP location for the abstract specification Spec.Source
http_absolute_uri/2URI is the absolute (i.e., starting with http://) URI for the abstract specification Spec.Source
http_clean_location_cache/0HTTP locations resolved through http_absolute_location/3 are cached.Source
http_redis_plugin.pl  -- Hook session management to use RedisShow source
http_server.pl  -- HTTP server libraryShow source
http_server_files.pl  -- Serve files needed by modules from the serverShow source
http_server_health.pl  -- HTTP Server health statisticsShow source
http_session.pl  -- HTTP Session managementShow source
http_stream.pl  -- HTTP StreamsShow source
http_unix_daemon.pl  -- Run SWI-Prolog HTTP server as a Unix system daemonShow source
http_wrapper.pl  -- Server processing of an HTTP requestShow source
hub.plShow source
current_hub/2True when there exists a hub Hub with Name.Source
hub_add/3Add a WebSocket to the hub.Source
hub_broadcast/2Send Message to all websockets associated with Hub for which call(Condition, Id) succeeds.Source
hub_broadcast/3Send Message to all websockets associated with Hub for which call(Condition, Id) succeeds.Source
hub_create/3Create a new hub.Source
hub_member/2True when Id is a member of the hub HubName.Source
hub_send/2Send message to the indicated ClientId.Source
js_write.pl  -- Utilities for including JavaScriptShow source
mimepack.pl  -- Create a MIME messageShow source
mimetype.pl  -- Determine mime-type for a fileShow source
term_html.pl  -- Represent Prolog terms as HTMLShow source
thread_httpd.plShow source
websocket.pl  -- WebSocket supportShow source