SWI-Prolog 10.1.17
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.pl  -- Write HTML textShow 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.plShow source
cors_enable/0Emit the HTTP header Access-Control-Allow-Origin using domains from the setting http:cors.Source
cors_enable/2CORS reply to a Preflight OPTIONS request.Source
http_dispatch.plShow source
http_404/2Reply using an "HTTP 404 not found" page.Source
http_current_handler/2True if Location is handled by Closure.Source
http_current_handler/3Resolve the current handler and options to execute it.Source
http_delete_handler/1Delete handler for Spec.Source
http_dispatch/1Dispatch a Request using http_handler/3 registrations.Source
http_handler/3Register Closure as a handler for HTTP requests.Source
http_link_to_id/3HREF is a link on the local server to a handler with given ID, passing the given Parameters.Source
http_location_by_id/2True when Location represents the HTTP path to which the handler with identifier ID is bound.Source
http_redirect/3Redirect to a new location.Source
http_reload_with_parameters/3Create a request on the current handler with replaced search parameters.Source
http_reply_file/3Options is a list of.Source
http_request_expansion/2Register Goal for expanding the HTTP request handler.Source
http_safe_file/2True if FileSpec is considered safe.Source
http_switch_protocol/2Send an "HTTP 101 Switching Protocols" reply.Source
http_dyn_workers.plShow source
schedule_workers/1Called if there is no immediately free worker to handle the incoming request.Source
http_exception.plShow source
bad_request_error/2If an exception of the term error(Formal, context(Stack, Context)) is caught and subsumes_term(ContextTemplate, Context) is true, translate the exception into an HTTP 400 exception.
in_or_exclude_backtrace/2Remove the stacktrace from the exception, unless setting http:client_backtrace is true.Source
map_exception_to_http_status/4Map certain exceptions to HTTP status codes.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.plShow source
http_current_host/4Source
http_public_host/4Current global host and port of the HTTP server.Source
http_public_host_url/2True when URL is the public URL at which this server can be contacted.Source
http_public_url/2True when URL is an absolute URL for the current request.Source
http_log.pl  -- HTTP Logging moduleShow source
http_multipart_plugin.pl  -- Multipart form-data pluginShow 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.pl  -- Abstract specification of HTTP server locationsShow source
http_redis_plugin.pl  -- Hook session management to use RedisShow source
http_server.pl  -- HTTP server libraryShow source
http_server_files.plShow source
serve_files_in_directory/2Serve files from the directory Alias from the path-info from Request.Source
http_server_health.pl  -- HTTP Server health statisticsShow source
http_session.plShow 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
session_setting/2Find setting for SessionID.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.pl  -- Manage a hub for websocketsShow source
js_write.pl  -- Utilities for including JavaScriptShow source
mimepack.pl  -- Create a MIME messageShow source
mime_pack/3Pack a number of inputs into a MIME package using a specified or generated boundary.Source
mimetype.pl  -- Determine mime-type for a fileShow source
term_html.plShow source
term/4Render a Prolog term as a structured HTML tree.Source
thread_httpd.pl  -- Threaded HTTP serverShow source
websocket.plShow source
http_open_websocket/3Establish a client websocket connection.Source
http_upgrade_to_websocket/3Create a websocket connection running call(Goal, WebSocket), where WebSocket is a socket-pair.Source
ws_close/3Close a WebSocket connection by sending a close message if this was not already sent and wait for the close reply.Source
ws_mask/1Produce a good random number of the mask of a client message.Source
ws_open/3Turn a raw TCP/IP (or any other binary stream) into a websocket stream.Source
ws_property/2True if Property is a property WebSocket.Source
ws_receive/2Receive the next message from WebSocket.Source
ws_receive/3Receive the next message from WebSocket.Source
ws_send/2Send a message over a websocket.Source