Index of values


(>>=) [Ocsigen_pervasives]
(>|=) [Ocsigen_pervasives]

A
abort [Ocsigen_http_com]
accept [Http_headers]
accept_charset [Http_headers]
accept_encoding [Http_headers]
accept_language [Http_headers]
accept_ranges [Http_headers]
access_control_allow_credentials [Http_headers]
access_control_allow_headers [Http_headers]
access_control_allow_methods [Http_headers]
access_control_allow_origin [Http_headers]
access_control_expose_headers [Http_headers]
access_control_max_age [Http_headers]
access_control_request_headers [Http_headers]
access_control_request_method [Http_headers]
accesslog [Ocsigen_messages]
Write a message in access.log
activate [Ocsigen_comet.Security]
activate () starts serving Comet requests.
activated [Ocsigen_comet.Security]
activated () reflects the activation state of the Comet module.
add [Ocsipersist]
add table key value associates value to key.
add [Http_headers]
add name s h adds the header name: s to h.
add [Ocsigen_cache.Dlist]
Adds an element to the list, and possibly returns the element that has been removed if the maximum size was exceeded.
add_cookie [Ocsigen_cookies]
add_cookie path c v cookie_table adds the cookie c to the table cookie_table.
add_cookies [Ocsigen_cookies]
add_cookies newcookies oldcookies adds the cookies from newcookies to oldcookies.
add_end_slash_if_missing [Ocsigen_pervasives.Url]
add_finalizer [Ocsigen_stream]
Add a finalizer function
add_headers [Ocsigen_http_frame.Http_header]
add_ocamlpath [Ocsigen_loader]
Adds a path to the Findlib library search path.
advert [Ocsigen_pervasives]
assoc_remove [Ocsigen_pervasives.List]

B
badconfig [Ocsigen_extensions]
Convenient function for raising Error_in_config_file exceptions with a sprintf-formatted argument.
basic_raw_request [Ocsigen_http_client]
Same as Ocsigen_http_client.raw_request, but does not try to reuse connections.
block_next_request [Ocsigen_http_com]
builtin_packages [Ocsigen_config]

C
cache_control [Http_headers]
cancel [Ocsigen_stream]
Cancel the stream, i.e.
clear [Polytables]
clear t remove all data from t
clear_all_caches [Ocsigen_cache]
Clear the contents of all the existing caches
client_connection [Ocsigen_extensions]
Returns the connection
client_id [Ocsigen_extensions]
Returns the id number of the connection
closed [Ocsigen_http_com]
closed conn is a thread waking up when the connection is closed
commandline [Ocsigen_getcommandline]
comp [Ocsigen_pervasives]
compute_new_ri_cookies [Ocsigen_http_frame]
compute_new_ri_cookies now path ri_cookies cookies_to_set adds the cookies from cookies_to_set to ri_cookies, as if the cookies had been send to the browser and the browser was doing a new request to the url path.
concat [Ocsigen_stream.StringStream]
Concatenate two stream
connection [Http_headers]
connection_fd [Ocsigen_http_com]
connection_id [Ocsigen_http_com]
console [Ocsigen_messages]
Write a message in the console (if not called in silent mode)
console2 [Ocsigen_messages]
Write a message in the console (if not called in silent mode)
consume [Ocsigen_stream]
Consume without cancelling.
cont [Ocsigen_stream]
creates a non empty step.
content [Ocsigen_local_files]
Given the local file file, with a request originating at url url, returns a viewable content of file.
content_encoding [Http_headers]
content_length [Http_headers]
content_range [Http_headers]
content_type [Http_headers]
cookie [Http_headers]
create [Ocsigen_comet.Channels]
create () returns a channel with a freshly baked identifier while create ~name () returns a channel with the identifier name after checking for uniqueness.
create [Polytables]
creates a new table
create [Ocsigen_pervasives.Clist]
create [Ocsigen_cache.Dlist]
create_receiver [Ocsigen_http_com]
create_sender [Ocsigen_http_com]
current_buffer [Ocsigen_stream]
Returns the value of the current buffer

D
date [Http_headers]
deactivate [Ocsigen_comet.Security]
deactivate () ceases all Comet related activity.
debug [Ocsigen_messages]
Write a message only in debugging mode (-V option) - Non cooperative
debug [Ocsigen_pervasives]
debug2 [Ocsigen_messages]
Write a message only in debugging mode (-V option) - Non cooperative
debug_noel [Ocsigen_messages]
Same as debug without new line at the end - Non cooperative
debug_noel2 [Ocsigen_messages]
Same as debug without new line at the end - Non cooperative
decode [Ocsigen_pervasives.Url]
default_charset [Ocsigen_charset_mime]
Functions related to the default charset in the association
default_mime [Ocsigen_charset_mime]
default_mime_assoc [Ocsigen_charset_mime]
Default values, obtained by reading the file specified by Ocsigen_config.get_mimefile
default_mime_type [Ocsigen_charset_mime]
default_result [Ocsigen_http_frame]
Default result to use as a base for constructing others.
default_sender [Ocsigen_http_com]
Sender with only the server name, and HTTP/1.1
display_http_exception [Ocsigen_http_frame.Http_error]
display_version [Ocsigen_config]
do_not_serve_to_regexp [Ocsigen_extensions]
Compile a do_not_serve structure into a regexp.
dyn_headers [Http_headers]
Headers for dynamic pages (non cachable)

E
empty [Http_headers]
returns an empty set of HTTP headers
empty [Ocsigen_stream.StringStream]
Create an empty stream
empty [Ocsigen_stream]
creates an empty step.
empty_charset_assoc [Ocsigen_charset_mime]
All files are mapped to no_charset
empty_cookieset [Ocsigen_cookies]
empty_result [Ocsigen_http_frame]
result for an empty page.
encode [Ocsigen_pervasives.Url]
enlarge_stream [Ocsigen_stream]
Read more data in the buffer
equal_virtual_hosts [Ocsigen_extensions]
errlog [Ocsigen_messages]
Write a message in errors.log
error_log_path [Ocsigen_messages]
Path to the error log file
etag [Http_headers]
expires [Http_headers]
expl_of_code [Ocsigen_http_frame.Http_error]
extension_no_directory [Ocsigen_pervasives.Filename]

F
finalize [Ocsigen_stream]
Finalize the stream
find [Ocsipersist]
find table key gives the value associated to key.
find [Ocsigen_headers]
find one of the values bound to name in the HTTP headers of the frame.
find [Http_headers]
find one of the values bound to name in the HTTP header t.
find_all [Ocsigen_headers]
find all the values bound to name in the HTTP headers of the frame.
find_all [Http_headers]
find all the values bound to name in the HTTP header t.
find_charset [Ocsigen_charset_mime]
find_mime [Ocsigen_charset_mime]
find_redirection [Ocsigen_extensions]
findfiles [Ocsigen_loader]
findfiles pkg returns the list of files needed to load Findlib package pkg, including dependencies.
fixup_url_string [Ocsigen_pervasives.Url]
fold [Http_headers]
fold [Ocsigen_cache.Dlist]
fold over the elements from the cache starting from the newest to the oldest
fold_back [Ocsigen_cache.Dlist]
fold over the elements from the cache starting from the oldest to the newest
fold_left [Ocsigen_pervasives.Clist]
Infinite fold on circular lists (use with care!)
fold_step [Ocsipersist]
Important warning: this iterator may not iter on all data of the table if another thread is modifying it in the same time.
fold_table [Ocsipersist]
Legacy interface for fold_step
full_server_name [Ocsigen_config]

G
get [Ocsipersist]
get pv gives the value of pv
get [Ocsigen_http_client]
Do a GET HTTP request.
get [Polytables]
get t k returns the current binding of k in t or raises Not_found
get [Ocsigen_stream]
call this function if you decide to start reading a stream.
get_accept [Ocsigen_headers]
get_accept_charset [Ocsigen_headers]
get_accept_encoding [Ocsigen_headers]
get_accept_language [Ocsigen_headers]
get_access_control_request_headers [Ocsigen_headers]
get_access_control_request_method [Ocsigen_headers]
get_basic_authentication_method [Authbasic]
This function combines all the parsers registered with register_basic_authentication_method.
get_bindir [Ocsigen_config]
get_client_timeout [Ocsigen_config]
get_command_pipe [Ocsigen_config]
get_config_file [Ocsigen_config]
get_content_length [Ocsigen_headers]
get_content_type [Ocsigen_headers]
get_cookie_string [Ocsigen_headers]
get_daemon [Ocsigen_config]
get_datadir [Ocsigen_config]
get_debugmode [Ocsigen_config]
get_default_charset [Ocsigen_config]
get_default_group [Ocsigen_config]
get_default_port [Ocsigen_config]
get_default_sslport [Ocsigen_config]
get_default_user [Ocsigen_config]
get_disablepartialrequests [Ocsigen_config]
get_etag [Ocsigen_http_frame.HTTP_CONTENT]
get_extdir [Ocsigen_config]
get_filebuffersize [Ocsigen_config]
get_finaliser_after [Ocsigen_cache.Dlist]
get_finaliser_before [Ocsigen_cache.Dlist]
get_firstline [Ocsigen_http_frame.Http_header]
get_group [Ocsigen_config]
get_headers [Ocsigen_http_frame.Http_header]
get_headers_value [Ocsigen_http_frame.Http_header]
get_headers_values [Ocsigen_http_frame.Http_header]
get_host_from_host_header [Ocsigen_headers]
get_hostname [Ocsigen_extensions]
Returns the hostname to be used for absolute links or redirections.
get_http_frame [Ocsigen_http_com]
get_id [Ocsigen_comet.Channels]
get_id c returns the unique identifier associated to c.
get_if_match [Ocsigen_headers]
get_if_modified_since [Ocsigen_headers]
get_if_none_match [Ocsigen_headers]
get_if_unmodified_since [Ocsigen_headers]
get_inet_addr [Ocsigen_pervasives.Ip_address]
get_keepalive [Ocsigen_headers]
get_logdir [Ocsigen_config]
get_max_number_of_connections [Ocsigen_config]
get_max_number_of_threads_queued [Ocsigen_config]
get_maxrequestbodysize [Ocsigen_config]
get_maxrequestbodysizeinmemory [Ocsigen_config]
get_maxretries [Ocsigen_config]
get_maxthreads [Ocsigen_config]
get_mimefile [Ocsigen_config]
get_minthreads [Ocsigen_config]
get_netbuffersize [Ocsigen_config]
get_ocamlpath [Ocsigen_loader]
Returns the current Findlib library search path.
get_origin [Ocsigen_headers]
get_pidfile [Ocsigen_config]
get_port [Ocsigen_extensions]
Returns the port to be used for absolute links or redirections.
get_proto [Ocsigen_http_frame.Http_header]
get_referer [Ocsigen_headers]
get_referrer [Ocsigen_headers]
get_respect_pipeline [Ocsigen_config]
get_server_timeout [Ocsigen_config]
get_shutdown_timeout [Ocsigen_config]
get_silent [Ocsigen_config]
get_timer [Ocsigen_cache.Dlist]
returns the timer of the Dlist
get_url [Ocsigen_http_client]
Do a GET HTTP request.
get_usedefaulthostname [Ocsigen_config]
get_user [Ocsigen_config]
get_user_agent [Ocsigen_headers]
get_verbose [Ocsigen_config]
get_veryverbose [Ocsigen_config]

H
hash_virtual_hosts [Ocsigen_extensions]
host [Http_headers]
host_match [Ocsigen_extensions]

I
id [Ocsigen_pervasives]
if_match [Http_headers]
if_modified_since [Http_headers]
if_none_match [Http_headers]
if_range [Http_headers]
if_unmodified_since [Http_headers]
in_list [Ocsigen_pervasives.Clist]
init_module [Ocsigen_loader]
init_module pre post force name runs the init function for the module name.
init_preempt [Ocsigen_config]
insert [Ocsigen_pervasives.Clist]
is_empty [Ocsigen_pervasives.Clist]
is_native [Ocsigen_config]
is_prefix_skip_end_slash [Ocsigen_pervasives.Url]
iter [Http_headers]
iter [Ocsigen_pervasives.Clist]
Infinite iteration on circular lists
iter_step [Ocsipersist]
Important warning: this iterator may not iter on all data of the table if another thread is modifying it in the same time.
iter_table [Ocsipersist]
Legacy interface for iter_step

J
join_do_not_serve [Ocsigen_extensions]

L
last [Ocsigen_pervasives.List]
last_modified [Http_headers]
length [Ocsipersist]
Size of a table.
list_of [Ocsigen_cache.Dlist]
The list to which the node belongs
listeners [Ocsigen_comet.Channels]
listeners c returns the number of clients currently registered on c A client is "currently registered" on a channel if an actual connection is open for the server to push a message onto.
loadfile [Ocsigen_loader]
loadfile pre post force file (dynamically) loads file.
loadfiles [Ocsigen_loader]
loadfiles pre post force file loads all the files, using loadfile (fun () -> ()) (fun () -> ()) false for all the files but the last one, and loadfile pre post force for the last one (if any).
location [Http_headers]
lock_receiver [Ocsigen_http_com]

M
make [Ocsigen_stream.StringStream]
make [Ocsigen_stream]
creates a new stream
make [Ocsigen_pervasives.Clist]
make_absolute_url [Ocsigen_pervasives.Url]
make_cryptographic_safe [Ocsigen_pervasives.String]
make_key [Polytables]
create a new key for each data you want to save
make_persistent [Ocsipersist]
make_persistent store name default find a persistent value named name in store store from database, or create it with the default value default if it does not exist.
make_persistent_lazy [Ocsipersist]
Same as make_persistent but the default value is evaluated only if needed
match_ip [Ocsigen_pervasives.Ip_address]
maxsize [Ocsigen_cache.Dlist]
method_of_string [Framepp]
move [Ocsigen_cache.Dlist]
Move a node from one dlist to another one, without finalizing.

N
name [Http_headers]
name_to_string [Http_headers]
native_ext [Ocsigen_config]
newest [Ocsigen_cache.Dlist]
next [Ocsigen_stream]
get the next step of a stream.
no_charset [Ocsigen_charset_mime]

O
of_file [Ocsigen_stream]
returns a stream reading from a file.
of_string [Ocsigen_stream]
returns a stream containing a string.
oldest [Ocsigen_cache.Dlist]
open_store [Ocsipersist]
Open a store (and create it if it does not exist)
open_table [Ocsipersist]
Open a table (and create it if it does not exist)
origin [Http_headers]

P
parse [Ocsigen_pervasives.Ip_address]
parse [Ocsigen_pervasives.Url]
parse_condition [Accesscontrol]
parse_content_type [Ocsigen_headers]
parse_cookies [Ocsigen_headers]
parse_host_field [Ocsigen_parseconfig]
Parses the hostfilter field of the configuration file, which is a disjunction of possible hostnames (that can themselves contain wildcards)
parse_mime_type [Ocsigen_headers]
parse_mime_types [Ocsigen_charset_mime]
Parsing of a file containing mime associations, such as /etc/mime-types
parse_size [Ocsigen_parseconfig]
Parse a size ("infinity" or using SI or binary units, e.g.
parse_size_tag [Ocsigen_parseconfig]
parse_size_tag tag s parses a size (same syntax as parse_size).
parse_string [Ocsigen_parseconfig]
Parse a string (PCDATA) as XML content.
parse_string_tag [Ocsigen_parseconfig]
parse_string_tag tag s parses a string (same syntax as parse_string).
parse_user_dir [Ocsigen_extensions]
post_string [Ocsigen_http_client]
Do a POST HTTP request.
post_string_url [Ocsigen_http_client]
Do a GET HTTP request.
post_urlencoded [Ocsigen_http_client]
Do a POST HTTP request with URL encoded parameters as content.
post_urlencoded_url [Ocsigen_http_client]
Do a GET HTTP request with URL encoded parameters as content.
proto_of_string [Framepp]
put [Ocsigen_stream.StringStream]
Create a stream with one element

R
range [Http_headers]
raw_request [Ocsigen_http_client]
Do an HTTP request (low level).
referer [Http_headers]
register_basic_authentication_method [Authbasic]
This function registers an authentication plugin: it adds a new parser to the list of available authentication schemes.
register_command_function [Ocsigen_extensions]
Use a prefix for all your commands when you want to create extension-specific commands.
register_exn_printer [Ocsigen_pervasives.Printexc]
register_extension [Ocsigen_extensions]
For each extension generating pages, we register its name and six functions: a function fun_site of type parse_config. This function will be responsible for handling the options of the configuration files that are recognized by the extension, and potentially generating a page., a function user_fun_site of type parse_user_config which has the same role as fun_site, but inside userconf files. Specify nothing if your extension is disallowed in userconf files. Otherwise, compared to fun_site, you can selectively disallow some options, as user_fun_site must define only safe options (for example it is not safe to allow such options to load a cmo specified by a user, or to execute a program, as this program will be executed by ocsigen's user). Note that user_fun_site will be called for every request, whereas the fun_site is called only when starting or reloading the server., a function begin_init that will be called at the beginning of the initialisation phase of each site, and each time the config file is reloaded., a function end_init that will be called at the end of the initialisation phase of each site, a function init_fun that will be called just before registering the extension, taking as parameter the configuration options between <extension> and </extension>. This allows to give configuration options to extensions. If no function is supplied, the extension is supposed to accept no option (and loading will fail if an option is supplied), a function exn_handler that will create an error message from the exceptions that may be raised during the initialisation phase, and raise again all other exceptions Moreover, if the optional parameter ?respect_pipeline is true, the extension will ask the server to respect the order of the pipeline.
reload [Ocsigen_server]
remove [Ocsipersist]
remove table key removes the entry in the table if it exists
remove [Polytables]
remove t k remove the current binding of k in t if it exists
remove [Ocsigen_pervasives.Clist]
remove [Ocsigen_cache.Dlist]
Removes an element from its list.
remove_cookie [Ocsigen_cookies]
remove_cookie c cookie_table removes the cookie c from the table cookie_table.
remove_dotdot [Ocsigen_pervasives.Url]
remove_end_slash [Ocsigen_pervasives.Url]
remove_n_oldest [Ocsigen_cache.Dlist]
remove the n oldest values (or less if the list is not long enough) ; returns the list of removed values
remove_slash_at_beginning [Ocsigen_pervasives.Url]
remove_slash_at_end [Ocsigen_pervasives.Url]
remove_spaces [Ocsigen_pervasives.String]
replace [Http_headers]
replace a header by another one.
replace_if_exists [Ocsipersist]
replace_if_exists table key value associates value to key only if key is already bound.
replace_opt [Http_headers]
replace or remove a header.
replace_user_dir [Ocsigen_extensions]
raises Not_found is the directory does not exist
resolve [Ocsigen_local_files]
Finds filename in the filesystem, with a possible redirection if it is a directory.
result_of_content [Ocsigen_http_frame.HTTP_CONTENT]
ri_of_url [Ocsigen_extensions]
Parsing URLs.

S
send [Ocsigen_http_com]
send an HTTP message.
send_error [Ocsigen_senders]
Sending an error page
sep [Ocsigen_pervasives.String]
server [Http_headers]
server_name [Ocsigen_config]
set [Ocsipersist]
set pv value sets a persistent value pv to value
set [Polytables]
set t k v associates v to k in t
set_bindir [Ocsigen_config]
set_client_timeout [Ocsigen_config]
set_command_pipe [Ocsigen_config]
set_configfile [Ocsigen_config]
set_cookie [Http_headers]
set_daemon [Ocsigen_config]
set_datadir [Ocsigen_config]
set_debugmode [Ocsigen_config]
set_default_charset [Ocsigen_charset_mime]
set_default_charset [Ocsigen_config]
set_default_mime [Ocsigen_charset_mime]
set_default_port [Ocsigen_config]
set_default_sslport [Ocsigen_config]
set_disablepartialrequests [Ocsigen_config]
set_extdir [Ocsigen_config]
set_filebuffersize [Ocsigen_config]
set_finaliser_after [Ocsigen_cache.Dlist]
set a function to be called automatically on a piece of data just after it disappears from the list (either by explicit removal or because the maximum size is exceeded)
set_finaliser_before [Ocsigen_cache.Dlist]
set a function to be called automatically on a piece of data just before it disappears from the list (either by explicit removal or because the maximum size is exceeded)
set_group [Ocsigen_config]
set_init_on_load [Ocsigen_loader]
If set to true, the module initialization functions passed to set_module_init_function will be executed directly.
set_logdir [Ocsigen_config]
set_max_number_of_connections [Ocsigen_config]
set_max_number_of_threads_queued [Ocsigen_config]
set_maxrequestbodysize [Ocsigen_config]
set_maxrequestbodysizeinmemory [Ocsigen_config]
set_maxretries [Ocsigen_config]
set_maxsize [Ocsigen_cache.Dlist]
change the maximum size ; returns the list of removed values, if any.
set_maxthreads [Ocsigen_config]
set_mimefile [Ocsigen_config]
set_minthreads [Ocsigen_config]
set_module_init_function [Ocsigen_loader]
set_module_init_function name f registers the function f, which will be used to initialize the module when init_module name is called.
set_netbuffersize [Ocsigen_config]
set_ocamlpath [Ocsigen_loader]
Sets the current Findlib library search path.
set_pidfile [Ocsigen_config]
set_respect_pipeline [Ocsigen_config]
set_result_observer [Ocsigen_http_com]
Use this function to make an action just before sending the result (for example observe the headers that will be sent).
set_server_timeout [Ocsigen_config]
set_shutdown_timeout [Ocsigen_config]
set_silent [Ocsigen_config]
set_timeout [Ocsigen_comet.Security]
set_timeout ?reset f sets the timeout value for future Comet connections to f.
set_usedefaulthostname [Ocsigen_config]
set_user [Ocsigen_config]
set_verbose [Ocsigen_config]
set_veryverbose [Ocsigen_config]
size [Ocsigen_cache.Dlist]
skip [Ocsigen_stream]
Skips data.
split [Ocsigen_pervasives.String]
start_processing [Ocsigen_http_com]
start_server [Ocsigen_server]
Start the server (does not return)
status [Http_headers]
stream_want [Ocsigen_stream]
stream_want s len Returns a stream with at least len bytes in the buffer if possible
string_of_header [Framepp]
string_of_http_exception [Ocsigen_http_frame.Http_error]
string_of_method [Framepp]
string_of_proto [Framepp]
string_of_stream [Ocsigen_stream]
Creates a string from a stream.
string_of_url_path [Ocsigen_pervasives.Url]
substream [Ocsigen_stream]
Cut the stream at the position given by a string delimiter

T
table_name [Ocsipersist]
returns the name of the table
transfer_encoding [Http_headers]
translate [Ocsigen_loader]
translate filename translate .cmo/.cma extensions to .cmxs in native mode, and .cmxs to .cmo (.cma if it exists) in bytecode mode.

U
unexpected_exception [Ocsigen_messages]
Use that function for all impossible cases in exception handlers (try ... with ... | e -> unexpected_exception ... or Lwt.catch ...).
unlock_receiver [Ocsigen_http_com]
up [Ocsigen_cache.Dlist]
Removes the element from its list without finalising, then adds it as newest.
update_charset_ext [Ocsigen_charset_mime]
Updates the mapping between extensions from a file to its charset.
update_charset_file [Ocsigen_charset_mime]
update_charset_regexp [Ocsigen_charset_mime]
update_mime_ext [Ocsigen_charset_mime]
update_mime_file [Ocsigen_charset_mime]
update_mime_regexp [Ocsigen_charset_mime]
user_agent [Http_headers]

V
value [Ocsigen_pervasives.Clist]
value [Ocsigen_cache.Dlist]
version_number [Ocsigen_config]

W
wait_all_senders [Ocsigen_http_com]
wakeup_next_request [Ocsigen_http_com]
warning [Ocsigen_messages]
Write a message in warnings.log
with_defaults [Http_headers]
with_defaults h1 h2 adds headers from h1 to h2.
write [Ocsigen_comet.Channels]
write c (s, u) sends the string s on the channel c.
write_stream [Ocsigen_http_com]
This function may return any I/O error from the channel, or a interrupted stream exception.

X
x_forwarded_for [Http_headers]
x_forwarded_proto [Http_headers]