| Did you know ... | Search Documentation: |
 | Title for pldoc(dir_index) |
- HOME
- DOWNLOAD
- DOCUMENTATION
- TUTORIALS
- Beginner▶
- Advanced▶
- Web applications▶
- Semantic web▶
- Graphics▶
- Machine learning▶
- External collections▶
- For packagers▶
- COMMUNITY
- COMMERCIAL
- WIKI
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
library(http/thread_httpd)implements the serverlibrary(http/http_dispatch)implements binding locations predicateslibrary(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 HTMLlibrary(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 | ||
|---|---|---|
| ax_alias/2 | True when Alias is an alias name for the AX schema URL. | |
| ax_form_attributes/2 | True if Values is a list Alias(Value) for each exchanged attribute. | |
| http_ax_attributes/2 | True when HTTPAttributes is a list of Name=Value pairs that can be used with an HTTP request to query for the attributes Spec. | |
| graphql.pl -- GraphQL interface | ||
| graphql/4 | Quasi-quotation syntax for embedding GraphQL in Prolog text. | |
| graphql_auth_token_hook/2 | Multifile, dynamic hook. | |
| graphql_document_to_codes/3 | Serialize Document, a Prolog term representing a GraphQL document as obtained from graphql_read_document/3 or the graphql/4 quasi-quotation, and unify Codes with the resulting list of character codes. | |
| graphql_document_to_string/3 | Serialize the GraphQL document Document and unify String with the resulting string. | |
| graphql_execute_document/4 | Send GraphQL document Document to be executed by the GraphQL endpoint at URI. | |
| graphql_read_document/3 | True when Document is a term representing the abstract syntax tree obtained from parsing Source as a GraphQL executable document. | |
| html_decl.pl | ||
| html_meta/1 | This directive can be used to declare that an HTML rendering rule takes HTML content as argument. | |
| html_no_content/1 | True when Element has no content. | |
| html_head.pl -- Automatic inclusion of CSS and scripts links | ||
| html_quasiquotations.pl | ||
| html/4 | The predicate html/4 implements HTML quasi quotations. | |
| html_write.pl -- Write HTML text | ||
| htmx.pl -- Support htmx.org | ||
| htmx_oob/4 | Emit an htmx out-of-band element. | |
| reply_htmx/1 | Reply a plain HTML element as opposed to a complete HTML page as created using reply_html_page/2,3. | |
| reply_htmx/2 | Reply a plain HTML element as opposed to a complete HTML page as created using reply_html_page/2,3. | |
| http_authenticate.pl -- Authenticate HTTP connections using 401 headers | ||
| http_client.pl | ||
| post_data_hook/3 | Hook to extend the datatypes supported by the post(Data) option of http_open/3. | |
| http_convert_data/4 | Multi-file hook to convert a HTTP payload according to the Content-Type header. | |
| http_delete/3 | Execute a DELETE method on the server. | |
| http_disconnect/1 | Close down some connections. | |
| http_get/3 | Get data from a URL server and convert it to a suitable Prolog representation based on the Content-Type header and plugins. | |
| http_patch/4 | Issue an HTTP PATCH request. | |
| http_post/4 | Issue an HTTP POST request. | |
| http_put/4 | Issue an HTTP PUT request. | |
| http_read_data/3 | Read data from an HTTP connection and convert it according to the supplied to(Format) option or based on the Content-type in the Request. | |
| http_cookie.pl -- HTTP client cookie handling | ||
| update_cookies/3 | Update the client cookie database. | |
| write_cookies/3 | Emit a cookie header for the current request. | |
| cookie_remove_all_clients/0 | Simply logout all clients. | |
| cookie_remove_client/1 | Fake user quitting a browser. | |
| http_cors.pl -- Enable CORS: Cross-Origin Resource Sharing | ||
| http_digest.pl -- HTTP Digest authentication | ||
| authenticate/3 | Plugin for library(http_dispatch) to perform basic HTTP authentication. | |
| authenticate_client/2 | This hooks is called by http_open/3 with the following Action value:. | |
| http_digest_challenge/4 | Generate the content for a 401 WWW-Authenticate: Digest header field. | |
| http_digest_password_hash/4 | Compute the password hash for the HTTP password file. | |
| http_digest_response/5 | Formulate a reply to a digest authentication request. | |
| http_parse_digest_challenge/2 | Parse the value of an HTTP WWW-Authenticate header into a list of Name(Value) terms. | |
| http_dirindex.pl -- HTTP directory listings | ||
| 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_error.pl | ||
| http_exception.pl -- Map Prolog exceptions to HTTP errors | ||
| http_files.pl -- Serve plain files from a hierarchy | ||
| http_header.pl -- Handling HTTP headers | ||
| http_hook.pl -- HTTP library hooks | ||
| http_host.pl -- Obtain public server location | ||
| http_json.pl -- HTTP JSON Plugin module | ||
| http_load.pl -- Load Prolog code from a web server | ||
| prolog_load_file/2 | Hook into load_files/2 that loads http:// and https:// resources directly from the web. | |
| http_log.pl -- HTTP Logging module | ||
| http_multipart_plugin.pl -- Multipart form-data plugin | ||
| http_open.pl -- HTTP client library | ||
| http_openid.pl -- OpenID consumer and server library | ||
| http_parameters.pl -- Extract parameters (GET and POST) from HTTP requests | ||
| http_path.pl -- Abstract specification of HTTP server locations | ||
| http_proxy.pl -- Use HTTP network proxies | ||
| try_proxy/4 | Connection is via an HTTP proxy for socket: Use HTTP CONNECT. | |
| http_pwp.pl -- Serve PWP pages through the HTTP server | ||
| pwp_handler/2 | Handle PWP files. | |
| reply_pwp_page/3 | Reply a PWP file. | |
| http_redis_plugin.pl -- Hook session management to use Redis | ||
| http_server.pl -- HTTP server library | ||
| http_server/1 | Create an HTTP server using http_dispatch/1 for handling requests. | |
| http_server_files.pl -- Serve files needed by modules from the server | ||
| http_server_health.pl -- HTTP Server health statistics | ||
| http_session.pl -- HTTP Session management | ||
| http_sgml_plugin.pl -- Parse of HTML and XML documents for the HTTP client libs | ||
| http_stream.pl -- HTTP Streams | ||
| http_unix_daemon.pl -- Run SWI-Prolog HTTP server as a Unix system daemon | ||
| http_wrapper.pl | ||
| cgi_hook/2 | Hook called from the CGI processing stream. | |
| http_current_request/1 | Returns the HTTP request currently being processed. | |
| http_peer/2 | True when PeerIP is the IP address of the connection peer. | |
| http_relative_path/2 | Convert an absolute path (without host, fragment or search) into a path relative to the current page. | |
| http_send_header/1 | This API provides an alternative for writing the header field as a CGI header. | |
| http_spawned/1 | Internal use only. | |
| http_wrap_spawned/3 | Internal use only. | |
| http_wrapper/5 | Simple wrapper to read and decode an HTTP header from `In', call :Goal while watching for exceptions and send the result to the stream `Out'. | |
| hub.pl -- Manage a hub for websockets | ||
| 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_grammar.pl -- JavaScript grammar | ||
| js_write.pl -- Utilities for including JavaScript | ||
| json.pl -- Reading and writing JSON serialization | ||
| json_convert.pl -- Convert between JSON terms and Prolog application terms | ||
| current_json_object/3 | Multifile predicate computed from the json_object/1 declarations. | |
| json_object/1 | Declare a JSON object. | |
| json_to_prolog/2 | Translate a JSON term into an application term. | |
| prolog_bool_to_json/2 | JSON is the JSON boolean for Prolog. | |
| prolog_to_json/2 | Translate a Prolog application Term into a JSON object term. | |
| mimepack.pl -- Create a MIME message | ||
| mime_pack/3 | Pack a number of inputs into a MIME package using a specified or generated boundary. | |
| mimetype.pl -- Determine mime-type for a file | ||
| 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 | ||
| yadis.pl | ||
| ssl_verify/5 | Accept all certificates. | |
| xrds_dom/2 | True when XRDS_DOM is a parsed XML document for the given resource. | |
| xrds_location/2 | Discover the location of the XRDS document from the given Id. | |