Index of values

Accessor for accept of request_info

Accessor for accept_encoding of request_info

Accessor for accept_language of request_info

Accessor for access_control_request_headers of request_info

Accessor for access_control_request_method of request_info

Write a message in access.log

activate () starts serving Comet requests.

activated () reflects the activation state of the Comet module.

add table key value associates value to key.

add name s h adds the header name: s to h.

Adds an element to the list, and possibly returns the element that has been removed if the maximum size was exceeded.

add_cookie path c v cookie_table adds the cookie c to the table cookie_table.

add_cookies newcookies oldcookies adds the cookies from newcookies to oldcookies.

Add a finalizer function.

Adds a path to the Findlib library search path.

attribute ~name f create a specification of a XML attribute.

Convenient function for raising Error_in_config_file exceptions with a sprintf-formatted argument.

Same as Ocsigen_http_client.raw_request, but does not try to reuse connections.

Cuts a string to the next separator

Cancel the stream, i.e.

accessor for charset of result

clear t remove all data from t

Clear the contents of all the existing caches

Accessor for client of request_info

Returns the connection

Returns the id number of the connection

closed conn is a thread waking up when the connection is closed

accessor for response code of result

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.

Compute the result to be sent to the client, by trying all extensions according the configuration file.

Concatenate two stream

Accessor for connection_closed of request_info

Write a message in the console (if not called in silent mode)

Consume without cancelling.

creates a non empty step.

Given the local file file, with a request originating at url url, returns a viewable content of file.

Accessor for content_length of request_info

accessor for Content-Length value of header of result

Accessor for content_type of request_info

accessor for Content-Type value of header of result

Accessor for content_type_string of request_info

Accessor for cookies of request_info

accessor for cookies of result

create () returns a channel with a freshly baked identifier while create ~name () returns a channel with the identifier name after checking for uniqueness.

creates a new table

Create a dlist.

Returns the value of the current buffer

deactivate () ceases all Comet related activity.

Default result to use as a base for constructing others.

Functions related to the default charset in the association

Default values, obtained by reading the file specified by Ocsigen_config.get_mimefile

Sender with only the server name, and HTTP/1.1

Compile a do_not_serve structure into a regexp.

Headers for dynamic pages (non cacheable)

Create the specification of a XML element.

result for an empty page.

returns an empty set of HTTP headers

Create an empty stream

creates an empty step.

All files are mapped to no_charset

Read more data in the buffer

Write a message in errors.log

Path to the error log file

accessor for ETag value of header of result

Accessor for files of request_info

Finalize the stream.

find table key gives the value associated to key.

find one of the values bound to name in the HTTP headers of the frame.

find one of the values bound to name in the HTTP header t.

find all the values bound to name in the HTTP headers of the frame.

find all the values bound to name in the HTTP header t.

findfiles pkg returns the list of files needed to load Findlib package pkg, including dependencies.

first_diff s1 s2 n last returns the index of the first difference between s1 and s2, starting from n and ending at last.

fold over the elements from the cache starting from the newest to the oldest

fold over the elements from the cache starting from the oldest to the newest

Infinite fold on circular lists (use with care!)

Important warning: this iterator may not iter on all data of the table if another thread is modifying it in the same time.

Legacy interface for fold_step

Accessor for forward_ip of request_info

Accessor for full_path of request_info

Accessor for full_path_string of request_info

get pv gives the value of pv

Do a GET HTTP request.

get t k returns the current binding of k in t or raises Not_found

call this function if you decide to start reading a stream.

This function combines all the parsers registered with register_basic_authentication_method.

Returns the hostname to be used for absolute links or redirections.

get_id c returns the unique identifier associated to c.

Profiling

Returns the current Findlib library search path.

Accessor for get_params of request_info

Accessor for get_params_string of request_info

Returns the port to be used for absolute links or redirections.

returns the timer of the Dlist

Do a GET HTTP request.

accessor for HTTP header of result

Accessor for host of request_info

Accessor for http_frame of request_info

Accessor for ifmatch of request_info

Accessor for ifmodifiedsince of request_info

Accessor for ifnonematch of request_info

Accessor for ifunmodifiedsince of request_info

The specification for ignoring blank PCDATA ('\n', '\r', ' ', '\t') and failing otherwise (a reasonable default).

Server internal functions:

init_module pre post force name runs the init function for the module name.

Accessor for initial_get_params of request_info

is_prefix_skip_end_slash path1 path2 returns true if path1 is the same as path2 before a first slash

Infinite iteration on circular lists

Important warning: this iterator may not iter on all data of the table if another thread is modifying it in the same time.

Legacy interface for iter_step

accessor for Last-Modified value of header of result

Size of a table.

The list to which the node belongs

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 pre post force file (dynamically) loads file.

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).

accessor for location of result

lwt version of fold

lwt version of fold_back

Make a request_info

creates a new stream

make_absolute_url https host port path generates a new absolute url

Generate an unique and cryptographically safe random string.

create a new key for each data you want to save

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.

Same as make_persistent but the default value is evaluated only if needed

Lwt version of make_persistent_lazy.

Accessor for method of request_info

Move a node from one dlist to another one, without finalizing.

Accessor for nb_tries of request_info

new_url_of_directory_request create a redirection and generating a new url for the client (depending on the server configuration and request)

get the next step of a stream.

returns a stream reading from a file.

Convert a Lwt_stream.t to an Ocsigen_stream.t.

returns a stream containing a string.

Open a store (and create it if it does not exist)

Open a table (and create it if it does not exist)

Accessor for origin of request_info

Accessor for original_full_path of request_info

Accessor for original_full_path_string of request_info

parse url returns a tuple containing information about url If url contains scheme 'https', host of url (ex: http://www.ocsigen.org/ -> www.ocsigen.org), port of url, path as string without first '/', path as string list, GET query of url, lazy value to decode GET query

Parses the hostfilter field of the configuration file, which is a disjunction of possible hostnames (that can themselves contain wildcards)

Parsing of a file containing mime associations, such as /etc/mime-types

Parse a size ("infinity" or using SI or binary units, e.g.

parse_size_tag tag s parses a size (same syntax as parse_size).

Parse a string (PCDATA) as XML content.

parse_string_tag tag s parses a string (same syntax as parse_string).

Accessor for port_from_host_field of request_info

Accessor for post_params of request_info

Do a POST HTTP request.

Do a GET HTTP request.

Do a POST HTTP request with URL encoded parameters as content.

Do a GET HTTP request with URL encoded parameters as content.

prefix_and_path_of_t url splits url in a couple (prefix, path) where prefix is "http(s)://host:port" and path is the path as string list

Process an XML element by the specifications.

Application of process_element on a list of XML elements.

Accessor for protocol of request_info

Create a stream with one element

Accessor for range of request_info

Do an HTTP request (low level).

This function registers an authentication plugin: it adds a new parser to the list of available authentication schemes.

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) See <<a_api module="Ocsigen_extensions.Configuration" | val process_elements >> for the easy construction of such a function., 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.

Accessor for remote_inet_addr of request_info

Accessor for remote_ip of request_info

Accessor for remote_ip_parsed of request_info

Accessor for remote_port of request_info

remove table key removes the entry in the table if it exists

remove t k remove the current binding of k in t if it exists

Removes an element from its list.

remove_cookie c cookie_table removes the cookie c from the table cookie_table.

remove_dotdot path cleans the path of ..

remove_end_slash str removes last /

remove_internal_slash path cleans the path of empty string

remove the n oldest values (or less if the list is not long enough) ; returns the list of removed values

remove_spaces s beg endd returns a copy of the string from beg to endd, removing spaces at the beginning and at the end

replace a header by another one.

replace_if_exists table key value associates value to key only if key is already bound.

replace or remove a header.

raises Not_found is the directory does not exist

Accessor for request_cache of request_info

Finds filename in the filesystem, with a possible redirection if it is a directory.

Parsing URLs.

Parsing URLs.

send an HTTP message.

send an HTTP/1.1 100 Continue message

Sending an error page

Cuts a string to the next separator, removing spaces.

Accessor for server_port of request_info

set pv value sets a persistent value pv to value

set t k v associates v to k in t

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 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)

If set to true, the module initialization functions passed to set_module_init_function will be executed directly.

change the maximum size ; returns the list of removed values, if any.

set_module_init_function name f registers the function f, which will be used to initialize the module when init_module name is called.

Sets the current Findlib library search path.

Use this function to make an action just before sending the result (for example observe the headers that will be sent).

set_timeout ?reset f sets the timeout value for future Comet connections to f.

Skips data.

Splits a string for words with separator, removing spaces.

split_fragment str splits str at first '#'

alias of (Ocamlnet) Neturl.split_path

Accessor for ssl of request_info

Start the server (does not return)

accessor for content of result

stream_want s len Returns a stream with at least len bytes in the buffer if possible

Creates a string from a stream.

Accessor for sub_path of request_info

Accessor for sub_path_string of request_info

Cut the stream at the position given by a string delimiter

returns the name of the table

Accessor for timeofday of request_info

Convert an Ocsigen_stream.t into a Lwt_stream.t.

translate filename translate .cmo/.cma extensions to .cmxs in native mode, and .cmxs to .cmo (.cma if it exists) in bytecode mode.

Use that function for all impossible cases in exception handlers (try ... with ... | e -> unexpected_exception ... or Lwt.catch ...).

Removes the element from its list without finalising, then adds it as newest.

Update result before sending.

Updates the mapping between extensions from a file to its charset.

Update nb_tries slot of request_info

Update cache of request_info

Accessor for url of request_info

Accessor for user_agent of request_info

Write a message in warnings.log

with_defaults h1 h2 adds headers from h1 to h2.

write c (s, u) sends the string s on the channel c.

This function may return any I/O error from the channel, or a interrupted stream exception.