Did you know ... Search Documentation:
Title for pldoc(dir_index)

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 libraris are

  • library(http/thread_httpd) implements the server
  • library(http/http_dispatch) implements binding locations predicates
  • library(http/http_unix_daemon) implements integration in various Unix server managers and in general provides a suitable entry point for HTTP servers on Unix.
  • library(http/html_write) implements generating HTML
  • library(http/http_json) implements reading and writing JSON documents.

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

ax.pl  -- Attribute Exchange libraryShow source
html_head.pl  -- Automatic inclusion of CSS and scripts linksShow source
html_quasiquotations.pl  -- HTML quasi quotationsShow source
html/4The predicate html/4 implements HTML quasi quotations.Source
html_write.pl  -- Write HTML textShow source
http_authenticate.pl  -- Authenticate HTTP connections using 401 headersShow source
http_client.pl  -- HTTP client libraryShow source
http_cors.pl  -- Enable CORS: Cross-Origin Resource SharingShow source
http_dirindex.pl  -- HTTP directory listingsShow source
http_dispatch.pl  -- Dispatch requests in the HTTP serverShow source
http_dyn_workers.pl  -- Dynamically schedule HTTP workers.Show source
http_error.pl  -- Decorate uncaught HTTP exceptions with stack-traceShow source
http_exception.pl  -- Map Prolog exceptions to HTTP errorsShow source
http_files.pl  -- Serve plain files from a hierarchyShow source
http_header.pl  -- Handling HTTP headersShow source
http_hook.pl  -- HTTP library hooksShow source
http_host.pl  -- Obtain public server locationShow source
http_json.pl  -- HTTP JSON Plugin moduleShow source
http_log.pl  -- HTTP Logging moduleShow source
http_multipart_plugin.pl  -- Multipart form-data pluginShow source
http_open.pl  -- HTTP client libraryShow source
http_openid.pl  -- OpenID consumer and server libraryShow source
http_parameters.pl  -- Extract parameters (GET and POST) from HTTP requestsShow source
http_path.pl  -- Abstract specification of HTTP server locationsShow 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_server_files.pl  -- Serve files needed by modules from the serverShow source
http_session.pl  -- HTTP Session managementShow source
http_close_session/1Closes an HTTP session.Source
http_current_session/2Enumerate the current sessions and associated data.Source
http_in_session/1True if SessionId is an identifier for the current session.Source
http_open_session/2Establish a new session.Source
http_session_assert/1Versions of assert/1, retract/1 and retractall/1 that associate data with the current HTTP session.Source
http_session_assert/2Versions of assert/1, retract/1 and retractall/1 that associate data with an explicit HTTP session.Source
http_session_asserta/1Versions of assert/1, retract/1 and retractall/1 that associate data with the current HTTP session.Source
http_session_asserta/2Versions of assert/1, retract/1 and retractall/1 that associate data with an explicit HTTP session.Source
http_session_cookie/1Generate a random cookie that can be used by a browser to identify the current session.Source
http_session_data/1True if Data is associated using http_session_assert/1 to the current HTTP session.Source
http_session_data/2Versions of assert/1, retract/1 and retractall/1 that associate data with an explicit HTTP session.Source
http_session_id/1True if SessionId is an identifier for the current session.Source
http_session_option/1True if Option is a current option of the session system.Source
http_session_retract/1Versions of assert/1, retract/1 and retractall/1 that associate data with the current HTTP session.Source
http_session_retract/2Versions of assert/1, retract/1 and retractall/1 that associate data with an explicit HTTP session.Source
http_session_retractall/1Versions of assert/1, retract/1 and retractall/1 that associate data with the current HTTP session.Source
http_session_retractall/2Versions of assert/1, retract/1 and retractall/1 that associate data with an explicit HTTP session.Source
http_set_session/1Overrule a setting for the current or specified session.Source
http_set_session/2Overrule a setting for the current or specified session.Source
http_set_session_options/1Set options for the session library.Source
http_ssl_plugin.pl  -- SSL plugin for HTTP librariesShow source
http_stream.pl  -- HTTP StreamsShow source
http_unix_daemon.pl  -- Run SWI-Prolog HTTP server as a Unix system daemonShow source
sni_options/2Hook to provide Server Name Indication (SNI) for TLS servers.
http_certificate_hook/3Hook called before starting the server if the --https option is used.Source
http_daemon/0Start the HTTP server as a daemon process.Source
http_daemon/1Start the HTTP server as a daemon process.Source
http_server_hook/1Hook that is called to start the HTTP server.Source
http_wrapper.pl  -- Server processing of an HTTP requestShow source
jquery.pl  -- Provide JQueryShow source
js_grammar.pl  -- JavaScript grammarShow source
js_write.pl  -- Utilities for including JavaScriptShow source
json.pl  -- Reading and writing JSON serializationShow 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.pl  -- Threaded HTTP serverShow source
schedule_workers/1Hook called if a new connection or a keep-alive connection cannot be scheduled immediately to a worker.Source
http_add_worker/2Add a new worker to the HTTP server for port Port.Source
http_close_connection/1Close connection associated to Request.Source
http_current_server/2True if Goal is the goal of a server at Port.Source
http_current_worker/2True if ThreadID is the identifier of a Prolog thread serving Port.Source
http_enough_workers/3Check that we have enough workers in our queue.Source
http_requeue/1Re-queue a connection to the worker pool.Source
http_server/2Create a server at Port that calls Goal for each parsed request.Source
http_server_property/2True if Property is a property of the HTTP server running at Port.Source
http_spawn/2Continue this connection on a new thread.Source
http_stop_server/2Stop the indicated HTTP server gracefully.Source
http_workers/2Query or set the number of workers for the server at this port.Source
message_level/2Determine the message stream used for exceptions that may occur during server_loop/5.Source
yadis.pl  -- Yadis discoveryShow source