cliopatria.pl -- ClioPatria main module
This module loads the ClioPatria server as a library, providing the
public predicates defined in the header. Before loading this file, the
user should set up a the search path cliopatria
. For example:
:- dynamic user:file_search_path/2. :- multifile user:file_search_path/2. user:file_search_path(cliopatria, '/usr/local/cliopatria'). :- use_module(cliopatria(cliopatria)).
- cp_server is det
- cp_server(:Options) is det
- Start the HTTP server. This predicate preforms the following
steps:
- Load application settings from
settings.db
- Load user-data from
users.db
- Start the HTTP server
- Load the RDF persistent database from
RDF-store
- Execute `after load' options registered using cp_after_load/1.
Defined options are:
- port(Port)
- Attach to Port instead of the port specified in the configuration file settings.db.
- workers(+Count)
- Number of worker threads to use. Default is the setting
http:workers
- prefix(+Prefix)
- Rebase the server. See also the setting
http:prefix
. - store(+Store)
- Directory to use as persistent store. See also the
setting
cliopatria:persistent_store
. - settings(+Settings)
- Settings file. Default is
settings.db
.
- Load application settings from
- cp_after_load(:Goal) is det
- Register Goal to be executed after reloading the RDF persistent DB. Note that already registered goals are not duplicated. Running a goal after loading the database is commonly used to ensure presence of relevant schemas or build additional indices. Note that it is possible to start a thread for time-consuming tasks (see thread_create/3).
- cp_welcome
- Print welcome banner.
- http:create_pool(+Pool) is semidet[multifile]
- Create a thread-pool on-demand.
Re-exported predicates
The following predicates are exported from this file while their implementation is defined in imported modules or non-module files loaded by this module.
- cp_server is det
- cp_server(:Options) is det
- Start the HTTP server. This predicate preforms the following
steps:
- Load application settings from
settings.db
- Load user-data from
users.db
- Start the HTTP server
- Load the RDF persistent database from
RDF-store
- Execute `after load' options registered using cp_after_load/1.
Defined options are:
- port(Port)
- Attach to Port instead of the port specified in the configuration file settings.db.
- workers(+Count)
- Number of worker threads to use. Default is the setting
http:workers
- prefix(+Prefix)
- Rebase the server. See also the setting
http:prefix
. - store(+Store)
- Directory to use as persistent store. See also the
setting
cliopatria:persistent_store
. - settings(+Settings)
- Settings file. Default is
settings.db
.
- Load application settings from