SWI-Prolog 10.1.4
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.pl  -- HTML emitter analysis and IDE supportShow 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.pl  -- HTTP client libraryShow 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.pl  -- Dispatch requests in the HTTP serverShow source
http_dyn_workers.pl  -- Dynamically schedule HTTP workers.Show 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.plShow source
http_address/2HTML-rule that emits the location of the HTTP server.
mime_type_encoding/2Encoding is the (default) character encoding for MimeType.
serialize_reply/2Multifile hook to serialize the result of status_reply/3 into a term.Source
status_page/3Hook called by http_status_reply/4 and http_status_reply/5 that allows for emitting custom error pages for the following HTTP page types:.
http_join_headers/3Append headers from Default to Header if they are not already part of it.Source
http_parse_header/2Header is a list of Name(Value)-terms representing the structure of the HTTP header in Text.Source
http_parse_header_value/3Translate Value in a meaningful Prolog term.Source
http_post_data/3Send data on behalf on an HTTP POST request.Source
http_read_header/2Read Name: Value lines from FD until an empty line is encountered.Source
http_read_reply_header/2Read the HTTP reply header.Source
http_read_request/2Read an HTTP request-header from FdIn and return the broken-down request fields as +Name(+Value) pairs in a list.Source
http_reply/2Compose a complete HTTP reply from the term Data using additional headers from HdrExtra to the output stream Out.Source
http_reply/3Compose a complete HTTP reply from the term Data using additional headers from HdrExtra to the output stream Out.Source
http_reply/4Compose a complete HTTP reply from the term Data using additional headers from HdrExtra to the output stream Out.Source
http_reply/5Compose a complete HTTP reply from the term Data using additional headers from HdrExtra to the output stream Out.Source
http_reply/6Compose a complete HTTP reply from the term Data using additional headers from HdrExtra to the output stream Out.Source
http_reply_header/3Create a reply header using reply_header//3 and send it to Stream.Source
http_status_reply/4Emit HTML non-200 status reports.Source
http_status_reply/5Emit HTML non-200 status reports.Source
http_timestamp/2Convert between a SWI-Prolog time stamp and a string in HTTP format (RFC1123).Source
http_update_connection/4Merge keep-alive information from Request and CGIHeader into Header.Source
http_update_encoding/3Allow for rewrite of the header, adjusting the encoding.Source
http_update_transfer/4Decide on the transfer encoding from the Request and the CGI header.Source
http_hook.pl  -- HTTP library hooksShow source
http_host.pl  -- Obtain public server locationShow 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.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.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.pl  -- HTTP Session managementShow source
http_stream.plShow source
current_transfer_encoding/1True if Encoding is supported.Source
encoding_filter/3Install a filter to deal with chunked encoded messages.Source
cgi_discard/1Discard content produced so far.Source
cgi_open/4Process CGI output.Source
cgi_property/2Inquire the status of the CGI stream.Source
cgi_set/2Change one of the properties.Source
cgi_statistics/1Return statistics on the CGI stream subsystem.Source
http_chunked_add_trailer/3Add a trailer key/value to DataStream.Source
http_chunked_flush/2Emits the next chunk flush_output/1 on DataStream, but in addition adds extension parameters to the chunk.Source
http_chunked_open/3Create a stream to realise HTTP chunked encoding or decoding.Source
http_is_chunked/1True if DataStream is created using http_chunked_open/3.Source
is_cgi_stream/1True if Stream is a CGI stream created using cgi_open/4.Source
multipart_open/3DataStream is a stream that signals end_of_file if the multipart boundary is encountered.Source
multipart_open_next/1Prepare DataStream to read the next part from the multipart input data.Source
stream_range_open/3DataStream is a stream whose size is defined by the option size(ContentLength).Source
http_unix_daemon.plShow 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_opt_help/2Allow reusing http option processing.Source
http_opt_meta/2Allow reusing http option processing.Source
http_opt_type/3Allow reusing http option processing.Source
http_server_hook/1Hook that is called to start the HTTP server.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
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.pl  -- Represent Prolog terms as HTMLShow source
thread_httpd.plShow 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
websocket.pl  -- WebSocket supportShow source