This directory provides the SWI-Prolog libraries for accessing and
providing HTTP services.
html_decl.pl -- HTML emitter analysis and IDE support |
|---|
| html_head.pl |
|---|
| html_current_resource/1 | True when About is a currently known resource. | |
| html_insert_resource/3 | Actually include HTML head resources. | |
| html_requires/3 | Include ResourceOrList and all dependencies derived from it and add them to the HTML head using html_post/2. | |
| html_resource/2 | Register an HTML head resource. | |
| mime_include/4 | Hook called to include a link to an HTML resource of type Mime into the HTML head. | |
| html_quasiquotations.pl -- HTML quasi quotations |
|---|
| html_write.pl |
|---|
| html/3 | Generate HTML from Content. | |
| html_begin/3 | For html_begin//1, Env is a term Env(Attributes); for html_end//1 it is the plain environment name. | |
| html_current_option/1 | True if Option is an active option for the HTML generator. | |
| html_end/3 | For html_begin//1, Env is a term Env(Attributes); for html_end//1 it is the plain environment name. | |
| html_header_hook/1 | This multifile hook is called just before the Content-type header is emitted. | |
| html_post/4 | Reposition HTML to the receiving Id. | |
| html_quoted/3 | Quote the value for normal (CDATA) text. | |
| html_quoted_attribute/3 | Quote the value according to the rules for tag-attributes included in double-quotes. | |
| html_receive/3 | Receive posted HTML tokens. | |
| html_receive/4 | This 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. | |
| html_root_attribute/4 | Add an attribute to the HTML root element of the page. | |
| html_set_options/1 | Set options for the HTML output. | |
| layout/3 | Define required newlines before and after tags. | |
| page/3 | Generate a page including the HTML <!DOCTYPE> header. | |
| page/4 | Generate a page including the HTML <!DOCTYPE> header. | |
| print_html/1 | Print list of atoms and layout instructions. | |
| print_html/2 | Print list of atoms and layout instructions. | |
| reply_html_page/2 | Provide the complete reply as required by http_wrapper.pl for a page constructed from Head and Body. | |
| reply_html_page/3 | Provide the complete reply as required by http_wrapper.pl for a page constructed from Head and Body. | |
| reply_html_partial/1 | Reply with partial HTML document. | |
| xhtml_ns/4 | Demand an xmlns:id=Value in the outer html tag. | |
| http_client.pl -- HTTP client library |
|---|
| http_cors.pl |
|---|
| cors_enable/0 | Emit the HTTP header Access-Control-Allow-Origin using domains from the setting http:cors. | |
| cors_enable/2 | CORS reply to a Preflight OPTIONS request. | |
| http_dispatch.pl |
|---|
| http_404/2 | Reply using an "HTTP 404 not found" page. | |
| http_current_handler/2 | True if Location is handled by Closure. | |
| http_current_handler/3 | Resolve the current handler and options to execute it. | |
| http_delete_handler/1 | Delete handler for Spec. | |
| http_dispatch/1 | Dispatch a Request using http_handler/3 registrations. | |
| http_handler/3 | Register Closure as a handler for HTTP requests. | |
| http_link_to_id/3 | HREF is a link on the local server to a handler with given ID, passing the given Parameters. | |
| http_location_by_id/2 | True when Location represents the HTTP path to which the handler with identifier ID is bound. | |
| http_redirect/3 | Redirect to a new location. | |
| http_reload_with_parameters/3 | Create a request on the current handler with replaced search parameters. | |
| http_reply_file/3 | Options is a list of. | |
| http_request_expansion/2 | Register Goal for expanding the HTTP request handler. | |
| http_safe_file/2 | True if FileSpec is considered safe. | |
| http_switch_protocol/2 | Send an "HTTP 101 Switching Protocols" reply. | |
| http_dyn_workers.pl -- Dynamically schedule HTTP workers. |
|---|
| http_exception.pl |
|---|
| bad_request_error/2 | If 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/2 | Remove the stacktrace from the exception, unless setting http:client_backtrace is true. | |
| map_exception_to_http_status/4 | Map certain exceptions to HTTP status codes. | |
| http_header.pl -- Handling HTTP headers |
|---|
| http_hook.pl |
|---|
| convert_parameter/3 | Hook to execute a step in the HTTP parameter conversion process. | |
| http_connection_over_proxy/6 | Try to connect to the host Endpoint via Proxy for the purposes of retrieving the resource identified by URLParts. | |
| http_host.pl |
|---|
| http_current_host/4 | | |
| http_public_host/4 | Current global host and port of the HTTP server. | |
| http_public_host_url/2 | True when URL is the public URL at which this server can be contacted. | |
| http_public_url/2 | True when URL is an absolute URL for the current request. | |
| http_log.pl -- HTTP Logging module |
|---|
| http_multipart_plugin.pl |
|---|
| http_convert_data/4 | Convert multipart/form-data messages for http_read_data/3. | |
| http_open.pl |
|---|
| disable_encoding_filter/1 | Do not use the Content-encoding as Transfer-encoding encoding for specific values of ContentType. | |
| http_close_keep_alive/1 | Close all keep-alive connections matching Address. | |
| http_open/3 | Open the data at the HTTP server as a Prolog stream. | |
| http_set_authorization/2 | Set user/password to supply with URLs that have URL as prefix. | |
| keep_alive/4 | Callback when closing the range stream used to process the content of the reply. | |
| map_method/2 | Support additional METHOD keywords. | |
| open_hook/6 | Hook implementation that makes open_any/5 support http and https URLs for Mode == read. | |
| http_parameters.pl -- Extract parameters (GET and POST) from HTTP requests |
|---|
| http_path.pl -- Abstract specification of HTTP server locations |
|---|
| http_redis_plugin.pl -- Hook session management to use Redis |
|---|
| http_server.pl -- HTTP server library |
|---|
| http_server_files.pl -- Serve files needed by modules from the server |
|---|
| http_server_health.pl -- HTTP Server health statistics |
|---|
| http_session.pl |
|---|
| http_close_session/1 | Closes an HTTP session. | |
| http_current_session/2 | Enumerate the current sessions and associated data. | |
| http_in_session/1 | True if SessionId is an identifier for the current session. | |
| http_open_session/2 | Establish a new session. | |
| http_session_assert/1 | Versions of assert/1, retract/1 and retractall/1 that associate data with the current HTTP session. | |
| http_session_assert/2 | Versions of assert/1, retract/1 and retractall/1 that associate data with an explicit HTTP session. | |
| http_session_asserta/1 | Versions of assert/1, retract/1 and retractall/1 that associate data with the current HTTP session. | |
| http_session_asserta/2 | Versions of assert/1, retract/1 and retractall/1 that associate data with an explicit HTTP session. | |
| http_session_cookie/1 | Generate a random cookie that can be used by a browser to identify the current session. | |
| http_session_data/1 | True if Data is associated using http_session_assert/1 to the current HTTP session. | |
| http_session_data/2 | Versions of assert/1, retract/1 and retractall/1 that associate data with an explicit HTTP session. | |
| http_session_id/1 | True if SessionId is an identifier for the current session. | |
| http_session_option/1 | True if Option is a current option of the session system. | |
| http_session_retract/1 | Versions of assert/1, retract/1 and retractall/1 that associate data with the current HTTP session. | |
| http_session_retract/2 | Versions of assert/1, retract/1 and retractall/1 that associate data with an explicit HTTP session. | |
| http_session_retractall/1 | Versions of assert/1, retract/1 and retractall/1 that associate data with the current HTTP session. | |
| http_session_retractall/2 | Versions of assert/1, retract/1 and retractall/1 that associate data with an explicit HTTP session. | |
| http_set_session/1 | Overrule a setting for the current or specified session. | |
| http_set_session/2 | Overrule a setting for the current or specified session. | |
| http_set_session_options/1 | Set options for the session library. | |
| session_setting/2 | Find setting for SessionID. | |
| http_stream.pl |
|---|
| current_transfer_encoding/1 | True if Encoding is supported. | |
| encoding_filter/3 | Install a filter to deal with chunked encoded messages. | |
| cgi_discard/1 | Discard content produced so far. | |
| cgi_open/4 | Process CGI output. | |
| cgi_property/2 | Inquire the status of the CGI stream. | |
| cgi_set/2 | Change one of the properties. | |
| cgi_statistics/1 | Return statistics on the CGI stream subsystem. | |
| http_chunked_add_trailer/3 | Add a trailer key/value to DataStream. | |
| http_chunked_flush/2 | Emits the next chunk flush_output/1 on DataStream, but in addition adds extension parameters to the chunk. | |
| http_chunked_open/3 | Create a stream to realise HTTP chunked encoding or decoding. | |
| http_is_chunked/1 | True if DataStream is created using http_chunked_open/3. | |
| is_cgi_stream/1 | True if Stream is a CGI stream created using cgi_open/4. | |
| multipart_open/3 | DataStream is a stream that signals end_of_file if the multipart boundary is encountered. | |
| multipart_open_next/1 | Prepare DataStream to read the next part from the multipart input data. | |
| stream_range_open/3 | DataStream is a stream whose size is defined by the option size(ContentLength). | |
| http_unix_daemon.pl -- Run SWI-Prolog HTTP server as a Unix system daemon |
|---|
| http_wrapper.pl -- Server processing of an HTTP request |
|---|
| hub.pl |
|---|
| current_hub/2 | True when there exists a hub Hub with Name. | |
| hub_add/3 | Add a WebSocket to the hub. | |
| hub_broadcast/2 | Send Message to all websockets associated with Hub for which call(Condition, Id) succeeds. | |
| hub_broadcast/3 | Send Message to all websockets associated with Hub for which call(Condition, Id) succeeds. | |
| hub_create/3 | Create a new hub. | |
| hub_member/2 | True when Id is a member of the hub HubName. | |
| hub_send/2 | Send message to the indicated ClientId. | |
| js_write.pl -- Utilities for including JavaScript |
|---|
| mimepack.pl -- Create a MIME message |
|---|
| mimetype.pl |
|---|
| charset/3 | Hook that determines the Charset for File that has media type MediaType. | |
| mime_extension/2 | Hook that is called by file_mime_type/2 before the default table is examined. | |
| file_content_type/2 | True if File should be served using ContentType: ContentType. | |
| file_content_type/3 | True if File should be served using ContentType: ContentType. | |
| file_mime_type/2 | True when MimeType is the mime-type to be used for sending FileName. | |
| term_html.pl -- Represent Prolog terms as HTML |
|---|
| thread_httpd.pl |
|---|
| schedule_workers/1 | Hook called if a new connection or a keep-alive connection cannot be scheduled immediately to a worker. | |
| http_add_worker/2 | Add a new worker to the HTTP server for port Port. | |
| http_close_connection/1 | Close connection associated to Request. | |
| http_current_server/2 | True if Goal is the goal of a server at Port. | |
| http_current_worker/2 | True if ThreadID is the identifier of a Prolog thread serving Port. | |
| http_enough_workers/3 | Check that we have enough workers in our queue. | |
| http_requeue/1 | Re-queue a connection to the worker pool. | |
| http_server/2 | Create a server at Port that calls Goal for each parsed request. | |
| http_server_property/2 | True if Property is a property of the HTTP server running at Port. | |
| http_spawn/2 | Continue this connection on a new thread. | |
| http_stop_server/2 | Stop the indicated HTTP server gracefully. | |
| http_workers/2 | Query or set the number of workers for the server at this port. | |
| message_level/2 | Determine the message stream used for exceptions that may occur during server_loop/5. | |
| websocket.pl -- WebSocket support |
|---|