This module can be placed between http_wrapper.pl and the application code to associate HTTP locations to predicates that serve the pages. In addition, it associates parameters with locations that deal with timeout handling and user authentication. The typical setup is:
server(Port, Options) :- http_server(http_dispatch, [ port(Port) | Options ]). :- http_handler('/index.html', write_index, ). write_index(Request) :- ...
- http_handler(+Path, :Closure, +Options) is det
- Register Closure as a handler for HTTP requests. Path is a
specification as provided by http_path.pl. If an HTTP
request arrives at the server that matches Path, Closure
is called with one extra argument: the parsed HTTP request.
Options is a list containing the following options:
- Demand authentication. Authentication methods are
pluggable. The library http_authenticate.pl provides
a plugin for user/password based
Transfer-encoding: chunkedif the client allows for it.
- If present, the handler is ignored if Goal does not succeed.
- Specifies the content-type of the reply. This value is currently not used by this library. It enhances the reflexive capabilities of this library through http_current_handler/3.
- Identifier of the handler. The default identifier is the predicate name. Used by http_location_by_id/2.
trueon a prefix-handler (see prefix), possible children are masked. This can be used to (temporary) overrule part of the tree.
- Declare that the handler processes Method. This is
method(*)allows for all methods.
- Declare that the handler processes all of the given methods. If this option appears multiple times, the methods are combined.
- Call Pred on any location that is a specialisation of
Path. If multiple handlers match, the one with the
longest path is used. Options defined with a prefix
handler are the default options for paths that start
with this prefix. Note that the handler acts as a
fallback handler for the tree below it:
:- http_handler(/, http_404([index('index.html')]), [spawn(my_pool),prefix]).
- If two handlers handle the same path, the one with the highest priority is used. If equal, the last registered is used. Please be aware that the order of clauses in multifile predicates can change due to reloading files. The default priority is 0 (zero).
- Run the handler in a seperate thread. If SpawnOptions is an atom, it is interpreted as a thread pool name (see create_thread_pool/3). Otherwise the options are passed to http_spawn/2 and from there to thread_create/3. These options are typically used to set the stack limits.
- One of
defaultor a positive number (seconds). If
default, the value from the setting
http:time_limitis taken. The default of this setting is 300 (5 minutes). See setting/2.
Note that http_handler/3 is normally invoked as a directive and processed using term-expansion. Using term-expansion ensures proper update through make/0 when the specification is modified. We do not expand when the cross-referencer is running to ensure proper handling of the meta-call.
The following predicates are exported, but not or incorrectly documented.
- http_current_handler(Arg1, Arg2)
- http_switch_protocol(Arg1, Arg2)
- http_redirect(Arg1, Arg2, Arg3)
- http_404(Arg1, Arg2)
- http_reply_file(Arg1, Arg2, Arg3)
- http_safe_file(Arg1, Arg2)
- http_link_to_id(Arg1, Arg2, Arg3)
- http_reload_with_parameters(Arg1, Arg2, Arg3)
- http_current_handler(Arg1, Arg2, Arg3)
- http_location_by_id(Arg1, Arg2)