Index of values

Same as assign, but infix notation.

Same as assign, but infix notation.

Exit the program immediately without running the atexit handlers.

Tries to get rid of a running job.

Configures host-based access control

add tbl key value: Adds the binding of key to value to the table.

add tbl key value: Adds the binding of key to value to the table.

An abort action is added to the group.

add_buffer nb1 nb2: Adds the contents of nb2 to the end of nb1

add_call client proc_name arg f: add the call to the procedure name with argument arg to the queue of unprocessed calls.

add_char nb c: Adds a single char at the end of the buffer

A close action is added for the file descriptor.

Adds a command to a job.

Adds a consumer to the job.

Add an additional event.

Puts an event into the event queue of the system.

Add an event handler that is associated to the given group.

Adds a handler to the list of handlers of the system.

add_inplace nb f: Calls the function f to add bytes to the netbuffer nb.

Adds a pipeline which redirects the output of the command src to the input of the command dest.

Adds a producer to the job.

Add a resource such that it is watched for conditions described by the operation for the period given by the float number.

add_string nb s: Adds a copy of the string s to the logical end of the netbuffer nb.

add_sub_string nb s k n: Adds the substring of s starting at position k with length n to the logical end of the netbuffer nb.

Alias for add_sub_string

apply_relative_url base rel: Interprets rel relative to base and returns the new URL.

are_compatible: currently not implemented

arg_parse speclist anon_fun usage_msg parses the command line and return an associative list describing the content of the property file (see Netcgi_ajp.props_of_file).

let (opt_list, cmdline_cfg) = args(): Returns opt_list for inclusion in the Arg.parse option list.

Arranges a redirection such that writing to src or reading from src will actually write to target or read from target (i.e., the target descriptor is duplicated and replaces the src descriptor just before the process is launched.)

Returns the target and the source of the assignment as pair of descriptors (target,src).

The authentication method "AUTH_NONE", i.e.

The authentication method that does not perform authentication.

The method that always rejects.

Authenticate by trusting the transport layer.

Returns the list of all available encodings that can be used for input strings.

Returns the list of all available encodings that can be used for output strings.

Returns the best charset for a header and a list of supported charsets.

Returns the best encoding for a header and a list of supported encodings.

Return the best locking method other than No_locking

Returns the best media type for a header and a list of supported types.

Binds the program as specified by the binding list.

Compatibility name for blit_to_string, now deprecated

blit_from_string src srcpos dest destpos len: Copies the len bytes at position srcpos from the string src to the netbuffer dest at position destpos.

blit_to_string nb srcpos dest destpos len: Copies the len bytes at position srcpos from nb to the string dest at position destpos.

let p = blocking_read fd s pos len: Reads exactly p bytes from fd and stores them in s starting at pos where p is the minimum of len and the number of bytes that are available on fd until the end of the file.

Configuration with non_blocking_connect = false

Returns the bound programs

Splits into at most n substrings, based on full_split

Splits into at most n substrings, based on full_split

Splits into at most n substrings, based on split

Splits into at most n substrings, based on split

Splits into at most n substrings, based on split_delim

Splits into at most n substrings, based on split_delim

Returns the byte order mark that must occur at the beginning of files to indicate whether "little endian" or "big endian" is used.

Starts the pipeline represented by the list of commands; i.e.

Executes the command and waits until the process terminates (synchronous execution a la system, but no intermediate shell).

call simple_client procedure_name procedure_arg: Call the procedure with the given name and the given argument.

Starts the job (see run_job) and waits until it finishes (see finish_job); i.e.

callit pm_client program_spec proc_name argument: This is an alternate way of calling a remote procedure.

cgi_with_args (new cgi) env out op ?put_arg in_chan constructs a Netcgi.cgi object.

Converts the option name to the character representing it on the octet-stream level.

Set file permission bits, user and group ownership of the object

Deletes all contents from the buffer.

Terminate the whole group.

Pass the result of this function to Rpc_client.set_auth_methods to configure client authentication.

Creates a new authentication method using AUTH_DH.

Returns the client socket contained in the connect_status

Sets ulb_eof of the unicode_lexbuf.

Closes all descriptors known to the cache

Closes the object.

The same as command but with a slightly different interface: Use

 cmd "ls" [ "/dir/file" ] 

instead of

 command ~arguments:[|"/dir/file"|] "ls" 

Creates a command descriptor, to be used in call.

Creates a command from the passed arguments:

Execute the command

Returns the command that is now running as the process

Returns the comment associated to the cookie or "" if it does not exists.

Returns the comment URL associated to the cookie or "" if it does not exists.

Syntax descriptions for common URL schemes.

Composes a mail message with a main text, and optionally a number of attachments.

Returns the filename of the configuration file

configure client retransmissions timeout: sets the number of retransmissions and the timeout for the next calls.

Configures signal and at_exit handlers for jobs: The keyboard signals SIGINT and SIGQUIT are forwarded to all jobs which are running in the background (and thus are not automatically notified) and want to get such signals (forward_signals). After the signals have been forwarded, the previous signal action is performed., The signals SIGTERM and SIGHUP are (if the handler is installed) forwarded to all dependent processes (regardless whether they are running in their own Unix process group or not, and regardless of forward_signals). After the signals have been forwarded, the previous signal action is performed., The at_exit handler sends a SIGTERM to all dependent processes, too., the SIGCHLD handler calls watch_for_zombies. After this function is called, the previous signal action is performed; however if the previous action was Signal_ignore this is incorrectly interpreted as empty action (zombies are not avoided), The handler for SIGPIPE does nothing; note that a previous action is overwritten (the parameter is called set_sigpipe to stress this) Dependent processes are: For jobs with mode = Foreground or Background: the processes of the corresponding Unix process group, For jobs with mode = Same_as_caller: the actually started children processes Note that if an uncaught exception leads to program termination, this situation will not be detected; any running jobs will not be terminated (sorry, this cannot be fixed).

This engine connects to a socket as specified by the connect_address, optionally using the proxy, and changes to the state `Done(status) when the connection is established.

Reads a workload_manager section like

Returns the contents of the buffer as fresh string.

Converts the string from in_enc to out_enc, and returns it.

Returns a duplicate of the command description

Copies the cursor.

Copies an environment

The first parameter is the name of the TLI/XTI device.

Deprecated creation of an RPC server.

Connects to the portmapper service listening on the given connector.

Create a simple client that connects with the given server using the given protocol type.

Opens a connection to the server specified by the connector.

create program_nr version_nr type_system procedures

Connects to the keyserv daemon.

Convert the time (seconds since the epoch) to a date/time record

Creates a netbuffer which allocates initially this number of bytes.

Creates the command-line configuration object

Creates a new event system that has an event source, but is otherwise empty.

Creates a server according to the mode2 argument.

Creates a new style client.

Returns the list of s_tokens representing email addresses as structured value.

Internally used.

This type of cache tries to keep connections as long open as possible.

Creates a boundary string that can be used to separate multipart messages.

A constant number of threads is created (the int argument).

The container for normal services

Creates a new cursor for the passed string and the passed encoding.

Creates an empty environment

Connects to a portmapper listening on an Internet port.

Creates an input channel and a shutdown function for a netbuffer.

Creates a new mime_scanner scanning the passed string.

Creates a multiplex controller for a bidirectional socket (e.g.

Creates a multiplex controller for datagram sockets (e.g.

A restrictive cache closes connections as soon as there are no pending requests.

Creates a multiplex controller for an SSL socket.

Returns the list of s_tokens representing an informal text as structured value.

Create a shared memory object under a name that is derived from the passed shm_name.

Create a new, empty event system

Returns the name of the controlling tty of the current process as pathname to a device file

Returns the environment of the current process as abstract environment value

Returns whether the cursor is positioned past the last character.

cursor_blit cs ua pos len: Copies at most len characters as code points from the cursor position and the following positions to the array ua at index pos.

Returns the maximum number of characters cursor_blit can copy at the current cursor position.

Works like cursor_blit, but copies the byte positions of the characters into ua instead of the code points.

Returns the byte length of the representation of the character at the cursor.

Returns the character count of the cursor.

Returns the encoding of the cursor.

Returns the initial relative byte position of the cursor

Returns the byte position of the cursor, i.e.

Returns the valid range of the cursor as pair (range_pos, range_len)

Returns the string of the cursor

This engine creates a datagram socket as demanded by the datagram_type, optionally using proxy for sending and receiving datagrams.

The multiplex controller for datagrams

If set to true, the containers output when they are started and stopped, and when new connections are accepted.

Outputs a message in the debug log (when enabled).

These variables control debugging of Rpc_server.

If set to true, the controller and a few other components output a lot of debug messages, mostly scheduling-related.

These are the two debug logging facilities.

Converts entities &name; and &#num; into the corresponding characters.

The input string is recoded from in_enc to out_enc, and HTML entities (&name; or &#num;) are resolved.

Option plus: Whether '+' is converted to space.

Decodes the string and returns it.

Decodes the given string argument.

let ch' = decode_mime_body hdr ch: According to the value of the Content-transfer-encoding header field in hdr the encoded MIME body written to ch' is decoded and transferred to ch.

Splits the URI into a "script name" and a "query string"

This function is used if this program is a server and wants to check the identity of a contacting client.

The default configuration is: tmp_directory: one of /var/tmp, /tmp, C:\temp, current directory., tmp_prefix: "netcgi", permitted_http_methods: `GET, `HEAD, `POST., permitted_input_content_types: "multipart/form-data", "application/x-www-form-urlencoded"., input_content_length_limit: maxint (i.e., no limit)., workarounds: all of them., default_exn_handler: set to true. To create a custom configuration, it is recommended to use this syntax:

      let custom_config = { default_config with tmp_prefix = "my_prefix" }
      

(This syntax is also robust w.r.t.

Returns the default options

Creates a host record that matches any request.

Returns the default options

Default configuration with non_blocking_connect = true

Adds missing components and returns the modified URL.

Returns the default value

Deletes the number of characters from unicode_lexbuf.

delete nb k n: Deletes the n bytes at position k of netbuffer nb in-place.

dest_<t> destroy integer values and returns the corresponding char tuples.

The argument is the URL-encoded parameter string.

The domain of the cookie, if set.

Returns the socket domain of Internet addresses, i.e.

Returns the NIS domain name.

returns the list of known mappings.

Execute the computed command

Configures the dynamic service.

Reads a workload_manager section like

Do nothing

Converts problematic characters to their corresponding entities.

The input string that is encoded as in_enc is recoded to out_enc, and the following characters are encoded as HTML entity (&name; or &#num;): The ASCII characters contained in unsafe_chars, The characters that cannot be represented in out_enc. By default (out_enc=`Enc_usascii), only ASCII characters can be represented, and thus all code points >= 128 are encoded as HTML entities. If you pass out_enc=`Enc_utf8, all characters can be represented. For example, the string "(a<b) & (c>d)" is encoded as "(a<b) & (c>d)".

Option plus: Whether spaces are converted to '+'.

Note: All characters except alphanumeric characters are protected by hex tokens.

Encodes the string and returns it.

Compute the "base 64" encoding of the given string argument.

let ch' = encode_mime_body hdr ch: According to the value of the Content-transfer-encoding header field in hdr the unencoded MIME body written to ch' is encoded and transferred to ch.

Returns the encoding of the name of the encoding.

This function is used if this program is a client and wants to contact a server.

If the anonymous URL is absolute, it is just returned as result of this function.

Returns the unixqueue to which the client is attached

Executes the action for the given client PI.

Find out if a specific resource already exists (or better: is already watched by an operation).

exn_handler_default env ~exn_handler ~finally run_cgi will basically execute exn_handler env run_cgi.

Exceptions log: In event-based programming, it is sometimes not possible to handle exceptions appropriately.

If the execution of the action yields the passed state, continue normally, otherwise treat the situation as error

Returns the URL scheme from the string representation of an URL.

Reads a Netplex configuration section like

    processor {
      type = "netcgi";          (* or the overridden [name] *)
      timeout = 15;             (* optional *)
      mount_dir = "/url/path";  (* optional *)
      mount_at = "/url/path";   (* optional alternative to mount_dir *)
    }
 

Make a file descriptor from an integer

Writes messages to this file

Reads a logging section like

Configures a file service

Translates an URI path to a file name.

Generates a URL with "file" scheme from the passed path name.

find tbl key: Finds the current binding of key in tbl or raises Not_found if no such binding exists.

find tbl key: Finds the current binding of key in tbl or raises Not_found if no such binding exists.

find_all tbl key returns the list of all data associated with key in tbl.

find_all tbl key returns the list of all data associated with key in tbl.

Waits until all of the processes of the job have terminated.

Same as string_before

Same as string_before

fix_MSIE_Content_type_bug ct transforms the content-type string ct to fix the MSIE Content-Type bug.

Escapes some unsafe or "unwise" characters that are commonly used in URL strings: space, < > { } [ ] ^ \\ | and double quotes.

fold f tbl init computes (f kN dN ... (f k1 d1 init)...), where k1 ... kN are the keys of all bindings in tbl, and d1 ... dN are the associated values.

fold f tbl init computes (f kN dN ... (f k1 d1 init)...), where k1 ... kN are the keys of all bindings in tbl, and d1 ... dN are the associated values.

Returns whether the daemon runs in the foreground

Format a date/time record as a string

To put sval, an s_token list, into the header field name, call

Format a date/time record according to the format string and outputs the resulting string to the channel.

Note fp4_of_fp8: This conversion is not exact.

A producer taking the data from /dev/null.

Creates a producer taking the data from the file descriptor passed to this function.

Creates a producer taking the data from the file whose name is passed to this function.

Creates a producer taking the data from a function.

Creates a unicode_lexbuf to analyse strings of the passed encoding coming from the refill function.

Creates a unicode_lexbuf to analyse strings of the passed encoding coming from the object channel.

Creates a producer taking the data from a stream of strings.

from_stream ?epipe s returns a function which can be used as producer argument for add_producer.

Creates a producer taking the data from a string s.

from_string ?pos ?len ?epipe s returns a function which can be used as producer argument for add_producer.

Creates a unicode_lexbuf analysing the passed string encoded in the passed encoding.

Creates a unicode_lexbuf analysing the passed string encoded in the passed encoding.

Creates a new lexbuf from the unicode_lexbuf.

Maps the Unicode code point to the corresponding code point of the charset, or raises Cannot_represent when there is no such corresponding code point.

Returns the ftp_state at the beginning of the plan

Do the first action, then get the second action using the reply of the first action.

Like split_delim, but returns the delimiters in the result

Like split_delim, but returns the delimiters in the result

Generates a new conversation key (a 64 bit random number)

get nb pos: Get the character at pos

get a k: Returns the contents of the array element number k where 0 <= k < length a.

Example: module MyPool = DbiPool(Dbi_postgres)

Decode the cookie header, may they be version 0 or 1.

Returns the Accept header as list of triples (media_range, media_range_params, accept_params).

Returns the Accept-charset header as list of pairs (charset,params).

Returns the Accept-encoding header as list of pairs (coding,params).

Returns the Accept-language header as list of pairs (lang_range,params).

Returns the Accept-ranges header as list of tokens.

Returns the Age header as number

Returns the Allow header as list of tokens.

Returns the argument array of the command (skipping the command name)

Returns the list of assignments (fd_from,fd_to)

Returns the method that was used to authenticate the user.

Returns the Authorization header as pair (auth_scheme,auth_params), or raises Not_found if not present.

Returns the Cache-control header as list of tokens.

Return the decoded word (the contents of the word after decoding the "Q" or "B" representation), and the character set of the decoded word (uppercase).

Returns the chdir parameter of the command

Returns the name of the command

Return the column of the line where the token starts (first column is number 0)

Return the current position, line, and column of a mime_scanner.

Return the address of the socket serving the connection, and the client socket, resp.

Returns the Connection header as list of tokens.

Get the connection_id

Returns the Content-encoding header as list of tokens.

Returns the Content-language header as list of tokens.

Returns the Content-length header as number.

Returns the Content-location header as string.

Returns the Content-MD5 header as string.

Returns the Content-range header as `Bytes(byte_range_resp_spec, instance_length).

Returns the Content-type header as pair (media_type, params).

Get the cookies as (name,value) pairs (or Not_found)

Returns the Date header as number (seconds since the Epoch).

Returns the list of active descriptors

Gets the contents of the environment as string array

Returns the value of the variable in the environment

Returns the designated environment of the command

Returns the Etag header.

Find out the event system that contains the 'session'

Returns the Expect header as list of triples (token,value,params).

Returns the Expires header as number (seconds since the Epoch).

Returns the file name of the executable

Returns the From header as string.

Returns the Host header as pair (host,port).

Returns the If-match header.

Returns the If-modified-since header as number (seconds since the Epoch).

Returns the If-none-match header.

Returns the If-range header.

Returns the If-unmodified-since header as number (seconds since the Epoch).

Returns the language if the token is an EncodedWord, and "" for all other tokens.

Returns the Last-modified header as number (seconds since the Epoch).

Return the length of the token in bytes

Return the line number where the token starts (numbering begins usually with 1)

Returns the Location header as string.

Returns the address of the server socket, or the address of the bidirectional pipe.

Returns the Max-forwards header as number.

Return the pair (euid,egid) for a Unix domain socket.

Return the address of the socket serving the session, and the client socket, resp.

Return the addresses of the client socket and the server socket, resp.

Return the byte position where the token starts in the string (the first byte has position 0)

Returns the Pragma header as list of pairs (token,value).

Return whether Tcp or Udp

Get the protocol flavour

Returns the Proxy-authenticate header as list of challenges (auth_scheme,auth_params).

Returns the Proxy-authorization header as pair (auth_scheme,auth_params).

Returns the Range header as `Bytes ranges, where the list ranges has elements of the form (Some first_pos, Some last_pos), (Some first_pos, None) (prefix range), or (None, Some last_pos) (suffix range).

Returns the Referer header as string.

Same, for addicts of correct orthography

Returns the Retry-after header.

Return the address of the sender of the last received response.

Returns the server instance of the session

Returns the Server header as uninterpreted string (including comments).

Returns the event system

Returns the TE header as list of triples (te_token, te_params, accept_params).

Return the s_token within the s_extended_token

Returns the Trailer header as list of field names.

Returns the Transfer-encoding header as list of pairs (token, params).

Returns the Upgrade header as list of products.

Returns the user name as returned by the authentication method.

Returns the User-agent header as uninterpreted string (including comments).

Returns the Vary header.

Returns the WWW-Authenticate header as list of challenges (auth_scheme,auth_params).

Returns the session ID.

Return the process group ID of the process with the passed PID.

Same as getpgid 0, i.e.

getport pm_client program_nr version_nr protocol: finds out the port where the given service runs.

Returns the session ID of the process with the passed PID.

global_replace re templ s: Replaces all matchings of re in s by templ.

global_replace re templ s: Replaces all matchings of re in s by templ.

global_substitute re subst s: Applies the substitution function subst to all matchings of re in s, and returns the transformed string.

global_substitute re subst s: Applies the substitution function subst to all matchings of re in s, and returns the transformed string.

Execute a sequence of operations in a group:

Returns the position where the substring matching the nth group begins

Returns the position where the substring matching the nth group begins

Returns the position where the substring matching the nth group ends

Returns the position where the substring matching the nth group ends

handle_request config output_type arg_store eh f ~max_conns ~log fd: This is a lower-level interface that processes exactly one request arriving on the existing connection fd.

handle_request config output_type arg_store eh f ~log fd: This is a lower-level interface that processes exactly one request arriving on the existing connection fd.

handle_request config output_type arg_store eh f ~log fd: This is a lower-level interface that processes exactly one request arriving on the existing connection fd.

Returns whether the OS supports POSIX shared memory

Configures virtual hosting

The (transitional) HTML 4.0 DTD, expressed as simplified_dtd

Does a "DELETE" request with the given URL and returns the response body.

Does a "DELETE" request with the given URL and returns the reply.

Does a "GET" request with the given URL and returns the message body

Does a "GET" request with the given URL and returns the message

Does a "HEAD" request with the given URL and returns the reply.

The default password if authentication is required

Does a "POST" request with the given URL and returns the response body.

Does a "POST" request with the given URL and returns the reply.

Does a "PUT" request with the given URL and returns the response body.

Does a "PUT" request with the given URL and returns the reply.

Returns the status value for an integer code, or raises Not_found

number of times every request is tried.

The default user if authentication is required

Turns on debug messages on stderr.

index_from nb k c: Searches the character c in the netbuffer beginning at position k.

insert_char nb p c: Inserts character c at position p into the netbuffer nb

insert_string nb p s: Inserts the value of string s at position p into the netbuffer nb

insert_string nb p s k n: Inserts a substring of string s at position p into the netbuffer nb.

Installs handlers as configured before.

The identity representation manager

Represents an int32 as one-element int32_array

Represents an int64 as two-element int32_array

A specialisation of Array.blit for int arrays.

Uses either int32_manager or int64_manager to represent int, depending on the size of int.

Return the file descriptor as integer

Returns the integer code for a status value

int_series src srcpos dst dstpos len n: Computes for every i, 0 <= i < len: dst.(dstpos+i) = n + SUM(j=0..(i-1): src.(srcpos+j))

Syntax for IP based protocols.

is_MSIE user_agent tells whether the user_agent is Microsoft Internet Explorer.

"ASCII compatible" means: The bytes 1 to 127 represent the ASCII codes 1 to 127, and no other representation of a character contains the bytes 1 to 127.

is_cgi says whether the script is run in a CGI environment.

Returns true if there is an executable file for the command, and it is permitted to run this file (as stated by the file permissions).

is_prefix pre s checks whether pre is a prefix of s.

Whether the event loop is running

Returns whether the event loop is active

Returns whether the encoding is a single-byte encoding

iter f tbl applies f to all bindings in table tbl.

iter f tbl applies f to all bindings in table tbl.

Iterates over the strings of the environment, and calls f s for every string s.

Iterates over the variables of the environment, and calls f name value for every variable with name and value.

Iterates over the jobs in the list of active jobs and calls f for every job_instance.

iter_keys f tbl applies f to all keys in table tbl.

iter_keys f tbl applies f to all keys in table tbl.

Returns the status.

Concatenates the path components (reverse function of split_path).

Returns a connector that can be used to call the keyserv daemon.

Sends a signal to the passed process.

Kills the process group if it is still (at least partially) running.

Kills the individual processes of the job which are still running.

Same as string_after

Same as string_after

Uses the same representation as pair_manager, but the resulting data manager only reads the left value of the pair.

Returns the logical length of the buffer

Returns the length of the array

length tbl returns the number of bindings in tbl.

length tbl returns the number of bindings in tbl.

Creates a lexical buffer from an input channel.

Returns the lexeme as array of Unicode code points

Returns the code point of a certain character of the lexeme

The character position of the end of the lexeme

The length of the lexeme in characters

The character position of the start of the lexeme

Turns a rec_in_channel or raw_in_channel, depending on the passed variant, into a full in_obj_channel object.

Turns a rec_out_channel or raw_out_channel, depending on the passed variant, into a full out_obj_channel object.

Configures linear distribution

This engine creates a server socket listening on the listen_address.

Extracts the path from an absolute file URL, and returns a correct path name.

The offset in minutes for the local time zone from the UTC

Writes a log message

Writes a log message like printf

All built-in logger factories

Searches an executable file.

make ?expires ?domain ?path ?secure name value creates a new cookie with name name holding value.

Creates a temporary file in the directory tmp_directory with a name prefix tmp_prefix and a unique suffix.

Creates a URL from components:

makechar enc i: Creates the string representing the Unicode code point i in encoding enc.

Manages a shared memory object as an array, including the representation of arbitrary O'Caml values.

Manages a shared memory object as a hash table like Netshm.manage, and additionally represent arbitrary O'Caml values.

Starts managing an open shared memory object as shm_table.

map_list f doclst: Applies f to all attribute values and data strings (except the attributes of "?", "!", or "--" nodes).

Works for both XV_enum and XV_enum_fast

Works for both XV_struct and XV_struct_fast

Works for both XV_union_over_enum and XV_union_over_enum_fast.

Returns the position where the matched part begins

Returns the position where the matched part begins

Returns the position where the matched part ends

Returns the position where the matched part ends

Extracts the substring the nth group matches from the whole string.

Extracts the substring the nth group matches from the whole string.

Extracts the matched part from the string.

Extracts the matched part from the string.

The expiration time of the cookie, in seconds.

mem tbl key checks if key is bound in tbl.

mem tbl key checks if key is bound in tbl.

Configures method distribution

mime_arg ?name msg creates a MIME-structured CGI argument called name with contents msg.

Convert the time (seconds since the epoch) to a date string that conforms to RFC 1123 (which updates RFC 822).

Creates a parameter from a value (in decoded form).

mk_<t> create integer values from character tuples.

The argument is a list of (name,value) pairs.

Convert the time (seconds since the epoch) to a date string that conforms to RFC 1036 (which obsoletes RFC 850).

Modifies the passed components and returns the modified URL.

Moves the cursor one character to the right, or if num is passed, this number of characters to the right.

Uses Unix.fork to create new threads

Uses Thread.create to create new threads

Reads a logging section like

The name of the cookie.

Returns the name of an object

Uses either int32_manager or int64_manager to represent nativeint, depending on the size of nativeint.

Reads a configuration section like

    processor {
      type = "nethttpd";
      timeout = 300.0;
      timeout_next_request = 15.0;
      host {
        pref_name = "myhost";     (* optional *)
        pref_port = 80;           (* optional *)
        names = "myhost:80 yourhost:81";  (* use *:0 for any name *)
        uri {
          path = "/the/path";
          method {
            allow = "GET POST";
            (* or: deny = "..." *)
            service {
              type = "...";
              ...
            }
          }
        }
        uri {
          ...
        }
      }
      host {
        ...
      }
    }
 

netplex_processor mk_config http_service: Creates a Netplex processor for Nethttpd.

Create a new, empty group for the event system

Creates a new job descriptor.

Create a new unique wait identifier

Removes "." and ".." from the path if possible.

Alias for get

Calls the 'NULL' procedure of the portmapper.

A URL without any component and null_url_syntax

An URL syntax that recognizes nothing.

Portage: of_compat_activation converts an old style cgi_activation to a new CGI-like object.

Portage: of_compat_argument a converts an old style argument a to a new style one.

Portage: of_compat_config c transform the old configuration c into one suitable for the new interface.

Portage: of_compat_environment e converts the old environment e to the new interface.

Conversion from the deprecated style of cookie.

Arranges that the callback function is called once after the passed period of time (the float argument) has elapsed.

Opens the shared memory object.

Creates a data manager from an input data manager for optional values

Converts a character representing an option to the internal option name.

This service responds to "OPTIONS *" requests, and nothing else

Outputs the contents of a file as response body, together with the given status and the header (optional).

Outputs the string argument as response body, together with the given status and the header (optional).

Outputs a "standard response" for the http_status.

rm: If true, four null bytes are prepended to the string for the record mark

Creates a compound manager for pairs from two input managers

Return the decoded value of the parameter, the charset (uppercase), and the language.

Formats a parameter list.

Parses the HTML document from an object channel and returns it.

Parse a string and return a date/time record

Parse a list of addresses in string representation, and return them as list of mailboxes or groups.

Parses the HTML document from a lexbuf and returns it.

Parse a string and return the time (seconds since the epoch

Parses the string and returns the URL the string represents.

Parses a user name as returned by Rpc_server.get_user in conjunction with the AUTH_SYS authentication and `Full formatting.

Transforms the syntax into another syntax where all required parts are changed into optional parts.

The path of the cookie, if set.

Peeks at the next message and returns the pair (euid,egid) for a Unix domain socket.

Returns the location of the PID file (if any)

port_of_program program host protocol: queries the portmapper running on host for the program registered for protocol.

port c the ports to which the cookie may be returned or [] if not set.

Looks at the error codes of the job, and raises Subprocess_error when there is an error that cannot be ignored.

For the toploop

A top-loop printer for streams

Prints a parameter to the formatter (as toploop printer)

Printer for the toploop.

procedure_number p name returns only the procedure number of the procedure called name.

Sets up an engine that processes all requests using the service description.

Processes all HTTP requests in turn arriving at the file descriptor, and calls the service provider for every request.

true iff the group has mode=Background and forward_signals.

Returns the Unix ID of the process group as number > 1.

Returns the process group leader process.

Returns the process ID of the process

Returns the processes that have actually been started for this job by run_job; note that the corresponding Unix process group may have additional processes (e.g.

Returns the program the client represents

Return the program number

props_of_file fname parses the property file fname and returns it as an associative list.

Parses the protocol string, e.g.

put_string nb pos s: Copies the string s to the position pos of netbuffer nb

Quotes a string such that it can be included in a regexp

Quotes a string such that it can be included in a regexp

find_blocks tbl key f: The values may be stored in several disk blocks.

This function expects that the current position of the passed in_obj_stream is the first byte of the header.

Reads a text file with two columns where the left column is the media type and the right column the corresponding suffix.

Decodes the MIME header that begins at the current position of the netstream, and returns the header as class basic_mime_header.

Decodes the MIME message that begins at the current position of the passed netstream.

This is the "next generation" multipart message parser.

Reads a configuration file like:

read_<t> create integer values from the characters found at a certain position in the string.

really_read fd s pos len: Reads exactly len bytes from fd and stores them in s starting at pos.

really_write fd s pos len: Writes exactly the len bytes from s to fd starting at pos.

Converts the character sequence contained in the at most in_len bytes of in_buf starting at byte position in_pos, and writes the result into at most out_len bytes of out_buf starting at byte position out_pos.

Recodes a complete string from in_enc to out_enc, and returns it.

Tries to add characters to the unicode_lexbuf by calling the ulb_refill function.

Parses a regexp

Parses a regexp

Parses a case-insensitive regexp

Parses a case-insensitive regexp

Returns a regexp that matches exactly the string

Returns a regexp that matches exactly the string

Returns a case-insensitive regexp that matches exactly the string

Returns a case-insensitive regexp that matches exactly the string

Registers the job at the passed system_handler.

Reuses an existing cursor for a new purpose.

A relaxed version of the HTML 4.0 DTD that matches better common practice.

Returns the time of the passed server in seconds since the epoch.

remove tbl key removes the current binding of key in tbl, restoring the previous binding if it exists.

remove tbl key removes the current binding of key in tbl, restoring the previous binding if it exists.

Removes the true components from the URL, and returns the modified URL.

Removes the operation from the watch list of the group.

replace tbl key value replaces the current binding of key in tbl by a binding of key to value.

replace tbl key value replaces the current binding of key in tbl by a binding of key to value.

replace_first re templ s: Replaces the first match of re in s by templ.

replace_first re templ s: Replaces the first match of re in s by templ.

Asynchronous procedures can reply their results with this function.

Like reply, but an error condition is sent back to the caller.

Empty the buffer, deallocate the internal string, and replace it with a new string of length n that was allocated by Netbuffer.create n.

resize a n: Resizes the array to length n.

The predefined token for the "100 Continue" response

restart f arg calls f arg, and restarts this call if the exception Unix_error(EINTR,_,_) is caught.

A wrapper around Unix.select that handles the EINTR condition

split_rev is_delim s split s at each character is_delim and returns the list of substrings in reverse order.

rm_htspace is_space s low up returns the substring s.[low .. up - 1] stripped of possible heading and trailing spaces identified by the function is_space.

A factory for TCP-based RPC servers.

Executes the command concurrently with the current process.

run f register the function f as a main function of the script.

run f executes f cgi for each cgi request.

run f executes f cgi for each SCGI request.

run f executes f cgi for each AJP request.

Starts the event loop.

Running a system means that, unless the queue is empty, the events at the time of the run invocation and all later added events are gone through.

Invokes the commands of the job such that they run concurrently with the main process.

Whether both encodings are the same.

Scans a "text" value.

let params, header_end_pos = scan_header s start_pos end_pos:

let name, params = scan_mime_type s options: Scans MIME types like text/plain; charset=iso-8859-1 The name of the type and the names of the parameters are converted to lower case.

let name, params = scan_mime_type_ep s options: This version copes with RFC-2231-encoded parameters.

let [params1, value1; params2, value2; ...] = scan_multipart_body s start_pos end_pos boundary:

Same as scan_multipart_body, but decodes the bodies of the parts if they are encoded using the methods "base64" or "quoted printable".

scan_multipart_body_from_netstream s boundary create add stop:

This function is included for backwards compatibility, and for all cases not requiring extended tokens.

Returns the next token, or End if there is no more token.

Returns all following tokens as a list (excluding End)

let name, params = scan_value_with_parameters s options: Scans values with annotations like name ; p1=v1 ; p2=v2 ; ... For example, MIME types like "text/plain;charset=ISO-8859-1" can be parsed.

let name, params = scan_value_with_parameters_ep s options: This version of the scanner copes with encoded parameters according to RFC 2231.

Searches a match of the string with the regexp, starting at the position and in backward direction.

Searches a match of the string with the regexp, starting at the position and in backward direction.

Searches a match of the string with the regexp, starting at the position and in forward direction.

Searches a match of the string with the regexp, starting at the position and in forward direction.

Tells whether the cookie is secure.

Returns the container running the code of the caller

Sends the contents of a file as response body, together with the given status and the header (optional).

Sends the string argument as response body, together with the given status and the header (optional).

Sends the passed message.

True iff the current token is white space (i.e.

Do the list of actions in turn

Do the two actions in turn

Do the first action, then check the resulting command state.

Pass the result of this function to Rpc_server.set_auth_methods to configure authentication.

Return the authentication method AUTH_LOCAL.

Pass the result of this function to Rpc_server.set_auth_methods to configure AUTH_DH for an RPC server.

set pm_client program_nr version_nr protocol port_nr: Extends the mapping managed by the portmapper: The triple (program_nr, version_nr, protocol) is mapped to the given port_nr.

set nb pos c: Sets the character at pos to c

set a k x: Sets the contents of the array element number k to x where 0 <= k < length a.

set new_args args creates a list of argument from args deleting the arguments whose name appears in new_args and adding the new_args arguments.

set http_header cookies sets the cookies in http_header using version 0 or version 1 depending on whether version 1 fields are used.

Sets the Accept header

Sets the Accept-charset header

Sets the Accept-encoding header

Sets the Accept-language header

Sets the Accept-ranges header

Sets the Age header

Sets the Allow header

Sets the argument array

Sets the list of assignments (fd_from,fd_to)

Sets the available authentication methods.

Set the authentication methods for this client.

Sets the Authorization header.

Sets the Cache-control header

Sets the chdir parameter of the command

Sets the command name

set_comment c s sets the comment of the cookie c to s which must be UTF-8 encoded (RFC 2279).

set_comment_url c url same as Netcgi.Cookie.set_comment except that the cookie comment is available on the page pointed by url.

Sets the Connection header

Sets the Content-encoding header

Sets the Content-language header

Sets the Content-length header

Sets the Content-location header

Sets the Content-MD5 header

Sets the Content-range header

Sets the Content-type header

Set the Cookie header.

Sets the Date header

Whether to output debug messages.

Enables or disables debug mode.

Sets the list of active descriptors

set_dgram_destination client addr_opt: This function is required for using the client in conjunction with unconnected UDP sockets.

Cookies are bound to a certain domain, i.e.

Sets the encoding to the passed value.

Sets the contents of the environment to the passed string array

set_env_var env varname varval: Sets the value of the variable varname in the environment env to varval.

Sets the environment

Sets the Etag header

Sets the exception handler for the server.

sets an exception handler (the default prints the exception to stderr).

Sets the Expect header

Sets the Expires header

Sets the file name of the executable to start

Sets the From header

Sets the Host header

Sets the If-match header

Sets the If-modified-since header

Sets the If-none-match header

Sets the If-range header

Sets the If-unmodified-since header

Sets the Last-modified header

Sets the Location header

set_max_age c (Some t) sets the lifetime of the cookie c to t seconds.

Sets the Max-forwards header

Every time a connection is closed, the onclose function is called with the closed connection.

Cookies are also bound to certain path prefixes, i.e.

set ports c (Some p) says that the cookie c must only be returned if the server request comes from one of the listed ports.

Sets the Pragma header

Sets the Proxy-authenticate header

Sets the Proxy-authorization header The "Basic" authentication scheme is represented as explained for get_proxy_authorization.

Sets the Range header

Sets the Referer header

Same, for addicts of correct orthography

Sets the Retry-after header

Cookies are also bound to the type of the web server: set_secure false means servers without SSL, set_secure true means servers with activated SSL ("https").

Sets the Server header

If set, the filter function is invoked every time the beginning of a new RPC call is received, and the result of the filter function determines what to do with the call:

Same as set_session_filter, but the filter gets as second argument the connection ID.

Set the Set-Cookie header

Sets the TE header

Sets the timeout for the transport.

Sets the Trailer header

Sets the Transfer-encoding header

Sets the Upgrade header

Sets the User-agent header

set_value c v sets the value of the cookie c to v.

Sets the Vary header

Sets the WWW-Authenticate header

setpgid pid pgid: Set the process group ID of the process pid to pgid.

Same as setpgid 0 0: A new process group ID is created, and the current process becomes its sole member.

Changes both the real and the effective group ID of the current process.

Changes both the real and the effective user ID of the current process.

Creates a job like call, but does not execute it.

Opens a shared memory object.

Returns the underlying shared memory table used to implement hash tables

Returns the underlying shared memory table used to implement hash tables.

Unlinks the name for a shared memory object

Shuts down the connection to the portmapper.

Shut the connection down.

Shuts down the connection.

The default implementation to shut down the connector.

simple_arg name value creates an unstructured CGI argument called name with contents value.

Simple listing generator for `Enable_listings

Convert a date/time record into the time (seconds since the epoch)

The sets of special characters defined by the RFCs 822 and 2045.

Splits the string according to the regexp in substrings.

Splits the string according to the regexp in substrings.

Same as split, but occurrences of the delimiter at the beginning and the end are returned as empty strings

Same as split, but occurrences of the delimiter at the beginning and the end are returned as empty strings

Splits the Host header in hostname and optional port number.

let (main_type, sub_type) = split_mime_type content_type: Splits the MIME type into main and sub type, for example split_mime_type "text/plain" = ("text", "plain") .

Splits a '/'-separated path into components (e.g.

Splits a long URI according to the algorithm of RFC 2017.

This engine performs the server handshake.

SSL configuration object for clients

This engine performs the client handshake.

SSL configuration object for servers

Parses the configuration file and starts the Netplex daemon.

Reports the status as determined by wait (below): If the process has terminated, the status of the process is returned.

Returns the best response code for the error

Returns the status code and the status text corresponding to the Status header

Create the function for dyn_activation from a std_activation tag.

The standard descriptors; defined here for convenience.

Reads a logging section like

Schedules a special event that causes the connection to be stopped in the very near future.

Stops the server: If a TCP server socket is listening, it is immediately closed.

Creates a new storage facility for a mime body according to store.

The multiplex controller for stream encapsulation

The last n characters of a string

The last n characters of a string

The first n characters of a string

The first n characters of a string

Represents a string in the following way.

Matches the string at the position with the regexp.

Matches the string at the position with the regexp.

Convert error to a string, for logging

Returns the name of the encoding.

Convert error to a string, for logging

Returns the informational text for a status value

Reads from the input channel until EOF and returns the characters as string.

Returns the string representation, e.g.

Returns the URL as string

Whether the tags match strongly (see RFC 2616 for definition)

sub nb k n: returns the n characters starting at position n from netbuffer nb as fresh string

Returns a substring of the lexeme as array of Unicode code points.

substitute_first re subst s: Applies the substitution function subst to the first matching of re in s, and returns the transformed string.

substitute_first re subst s: Applies the substitution function subst to the first matching of re in s, and returns the transformed string.

The types supported for this OS

Return the maximum number of open file descriptor per process.

Return the process group ID of the foreground process group of the session associated with the file descriptor, which must be a tty.

default TCP port for SMTP

Default TCP port for POP version 3

Sets the foreground process group ID of the session associated with the file descriptor, which must be a tty.

Creates a consumer writing the data into the passed buffer.

to_buffer b returns a function which can be used as consumer argument for add_consumer.

Portage: to_compat_activation converts a new style cgi object to an old cgi_activation object.

Portage: to_compat_argument a converts a new style argument a to an old style one.

Portage: to_compat_config c transform the new configuration c into one suitable for the old interface.

Portage: to_compat_environment e converts the new environment e to the old interface.

A consumer redirecting the data to /dev/null.

Creates a consumer redirecting the data to the file descriptor

Creates a consumer writing the data into the file whose name is passed to this function.

Creates a consumer writing the data by calling a function.

Conversion to the deprecated style of cookie (some parameters are dropped).

Maps the code point of the charset to the corresponding Unicode code point, or raises Malformed_code, when the input number does not correspond to a code point.

try_shrinking nb: If the length of the buffer is less than half of the allocated space, the netbuffer is reallocated in order to save memory.

Returns the name of the controlling tty referred to by the file descriptor.

Returns the characters of the string as array of Unicode code points.

Returns the Unicode code point of the character at the cursor.

<t>_as_string: Returns the corresponding string in network byte order for an integer value

Unbinds the program if it is bound by the server

Removes components from the URL if they have the passed value, and returns the modified URL.

Removes the name permanently from the system

fast: whether to prefer the new "fast" values (default: false)

Warning! This is a low-level function! Returns the current string that internally holds the buffer.

The string contains '<', '>', '"', '&' and the control characters 0-8, 11-12, 14-31, 127.

unset pm_client program_nr version_nr protocol port_nr: removes the mapping.

Modifies program and/or version number

update_alist updl l: Returns the alist with all elements of updl and all elements of l that are not member of updl.

update_props_inheader (name, value) (props, inheader) returns (props, inheader) to which the new parameter name-value has been added -- to props or inheader, depending on name.

Configures URI distribution.

Decodes %XX sequences in URI paths.

Encodes unsafe characters in URI paths.

Same as encode but use slightly different characters that can be part of URLs without additional encodings.

Parses the passed string according to the passed url_syntax.

Return components of the URL.

Returns true iff the URL has all of the components passed with true value.

Checks whether the passed url_syntax is valid.

Returns the url_syntax record of a URL.

Compares two strings lexicographically.

Iterates over the characters of a string, and calls the passed function for every code point.

Returns the length of the string in characters.

Maps every character of a string to a list of characters, and returns the concatenated string.

Returns the array of Unicode code points as encoded string.

ustring_of_uchar enc i: Creates the string representing the Unicode code point i in encoding enc.

ustring_sub enc start length s: Returns the substring of s starting at character count start and consisting of length characters.

Returns the lexeme as UTF-8 encoded string

Returns a substring of the lexeme as UTF-8 encoded string.

Same as String.length(utf8_sub_lexeme args), i.e.

The two int arguments are the position and length of a sub string of the lexbuf that is returned as UTF8 string.

Returns String.length(utf8_sub_string args).

The value of the cookie.

Set whether you want debug messages to stderr or not

set whether you want debug messages or not

Checks whether the string is properly encoded.

Return the version number

Watches the given list of processes and the file descriptors read, write, and except, and waits until events for these resources have happened, and reports these.

Iterates over the jobs in the list of abandoned jobs, and removes zombie processes.

Whether the tags match weakly (see RFC 2616 for definition)

Watches the state of the argument engine, and arranges that one of the functions is called when a final state is reached.

with_in_obj_channel ch f: Computes f ch and closes ch.

with_out_obj_channel ch f: Computes f ch and closes ch.

All built-in workload manager factories

Generates a header for the mime_body.

Sets the mail-related header fields in the input message, and returns a message ready for delivery.

Generates an intermediate container for multipart attachments.

Writes the document to the output channel.

write_blocks tbl ops key f: Like read_blocks this function iterates over the blocks of all bindings for key.

This function writes the header to the passed out_obj_channel.

Writes the MIME message to the output channel.

write_<t> copies the characters corresponding to the integer values into the string at the given positions.

write_<t>_unsafe: Same, but no index check.

Writes the list of s_token to the out_obj_channel.

Common abbreviation for arrays of arbitrary length

Common abbreviation for boolean types.

Common abbreviation for opaque data of arbitrary length

Common abbreviation for optional types.

Common abbreviation for strings of arbitrary length

See x_bool

See x_optional