Index of values

Another name for qseq_engine.

Same as assign, but infix notation.

Same as assign, but infix notation.

Another name for fmap_engine.

Exit the program immediately without running the atexit handlers.

To be used in conjunction with Rpc_client.Keep_call: The call with this session identifier is no longer expected, and removed from the internal data structures.

Deprecated name for cancel_job

Return an absolute path for this file.

Configures host-based access control

Returns a pollset using a "fast" poll mechanism, if available.

Calls G.accept_sec_context, and returns (out_context,out_token,flags,props_opt).

On the client: Enter another handshake round with new configuration data.

Which transport IDs are acceptable for authenticated requests on unencrypted connections.

Which transport IDs are acceptable for authenticated requests on HTTPS-secured connections.

Access the named mutex.

access b pos f: Gets access to the internal string backing the byte at position pos.

Return the actual events of the source.

Adds data

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.

add tbl x y adds a binding of x to y in table tbl.

Pushes a new value onto the heap.

Table.add tbl key value adds the (key, value) pair in the table tbl.

The addition algorithm for 1's-complement numbers.

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

add_char_2 nb c1 c2: Adds two chars at the end of the buffer

add_char_4 nb c1 c2 c3 c4: Adds four chars 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.

Adds the event source to the aggregator

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

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

add_helper_service ctrl name hooks: Adds a helper service name to the controller ctrl.

Pushes a new value onto the heap.

add_init_array m n f: Pushes a new value with n elements onto the heap.

add_inplace b f: Calls f m pos len where m is the last page of the buffer, and pos is the first free byte on the page, and len is the number of free bytes on the page.

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.

To enable compute processes for any Netplex program, call this function with the controller object as argument.

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_some mut x: Returns Some x where the O'Caml value representing Some is allocated in the heap using mut.

Adds a string to the end of the buffer

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

Adds a string to the end of the buffer

let s = add_string mut len: Adds an uninitialized string of length len to the heap using mut, and returns the string

Adds a sub memory buffer to the end of the buffer

Same as add_sub_string, but gets data from a memory buffer

Adds a sub memory buffer to the end of the buffer

Adds a sub string to the end of the buffer

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.

Adds a sub string to the end of the buffer

Alias for add_sub_string

add_uniform_array m n x: Pushes a new value with n elements onto the heap.

Similar to add_resource, but the resource is weak.

server_admin field.

Determines the admin socket of the controller, and returns an RPC client connector suitable for connecting with the admin interface of the controller.

advance b n: Marks further n bytes in the last page of the buffer as used.

These two functions work together, so that the effect of add_inplace can be obtained in two steps.

The iana names of all encoders and decoders, resp.

alloc_aligned_memory alignment size: Allocates a buffer of size whose start address is a multiple of alignment.

Allocate memory in this pool.

Allocates memory in units of pages.

Allocates a wait_entry

alloc_wait_entry_e mut set filename: Allocates a new wait entry with notification via named pipe.

Whether to announce the availability of channel binding by adding "-PLUS" to the mechanism name, and by offering channel bindings in the initial token.

Whether servers announce the availability of channel binding by adding "-PLUS" to the mechanism name.

Interprets a file name as connector for a local RPC service.

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.

request_rec args field.

Same as as_value but returns the value as Obj.t

Casts the process handle to an event handle.

as_sem mem pos: Interprets the memory at position pos to pos + sem_size() - 1 as anonymous semaphore.

as_sem mem pos: Interprets the memory at position pos to pos + sem_size() - 1 as anonymous semaphore.

as_value mem offset: Returns a pointer to mem+offset.

request_rec assbackwards field; true if HTTP/0.9, "simple" request.

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

assign sr x: Sets the contents of sr to a deep copy of x.

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

Pseudo descriptor value to be used as first argument of *at functions

Whether the underlying transport channel has seen the end of input.

Whether the underlying transport channel has seen the end of input.

Parses an attribute

The above types in the format (oid, full_name, short_names)

The above types in the format (oid, full_name, short_names)

Parses a sequence of attributes

If applied to helo_response, returns the list of AUTH mechanisms

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.

Authenticates the session:

Authenticates the session:

The name the client authorizes as (or Not_found)

The authorization name

Whether the mechanism is available, in particular whether the required crypto support is linked in

Whether the mechanism is available, in particular whether the required crypto support is linked in

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.

b_set_db_callbacks session store remove retrieve: sets the three callbacks for server-side session caching

Sets the function for reading data.

Sets the function for waiting for new data to arrive (only used for DTLS).

Sets the function for writing data.

Sets the function for verifying the peer's certificate.

Allows to handle unknown status codes that are untranslatable by http_status_of_int: for a code 100 to 199 the value 100 is returned, for a code 200 to 299 the value 200 is returned, for a code 300 to 399 the value 300 is returned, for a code 400 to 499 the value 400 is returned, for all other codes 500 is returned E.g.

Same as function

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.

Bits of text_attr

Binds the program as specified by the binding list.

Binds this program additionally

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_memory_to_string src srcoff dst dstoff len copies len characters from buffer src, starting at character number srcoff, to string dst, starting at character number dstoff

Unsafe version

blits the mstrings one after the other to the memory, so that they appear there concatenated

blit_poll_array a1 p1 a2 p2 len: Copies the len cells at index p1 from a1 to a2 at index p2.

blit_string_to_memory src srcoff dst dstoff len copies len characters from string src, starting at character number srcoff, to buffer dst, starting at character number dstoff

Unsafe version

Blits contents to another memory buffer

blit_to_memory nb srcpos dest destpos len: Copies the len bytes at position srcpos from nb to the membuffer dest at position destpos.

Blits contents to a memory buffer

Blits contents to a string

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

Blits contents to a string

The buffers used with encrypt/decrypt must have a length that is a multiple of this number.

the block length (in bytes)

let p = blocking_gread fd_style fd s pos len: Like gread up to len bytes are read from fd and stored in s.

Same as blocking_gread `Read_write

Configuration with non_blocking_connect = false

Access a variable with simple type.

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

broadcast c restarts all processes waiting on the condition variable c.

Look up the buffer for this descriptor

Deprecated name for buffered_transactional_outtype

The output_type implementing transactions with a RAM-based buffer

Performs the final handshake (exchanges close requests).

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

Same as function

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.

returns the address

same for an already opened box

same for an already opened box

same for an already opened box

Cancels a camlbox_wait operation called by a different thread

Returns the maximum number of messages n

camlbox_delete box k: Deletes the message number k from box.

Opens a new file descriptor to this address

camlbox_get box k: Returns message number k from box.

camlbox_get box k: Returns a deep copy of message number k from box.

Returns the number of messages at the moment

Returns the max size of a message in bytes

returns the address

same for a box already opened for sending

Sends a message to a camlbox.

Prepares for sending.

Gets a sender for a file descriptor from camlbox_fd.

same for a box already opened for sending

same for a box already opened for sending

Waits until new messages arrive, and return the message numbers.

Sends an "empty message" - this only means that if the receiving thread is waiting for new messages it is interrupted and camlbox_wait will return the empty list.

Cancels all active timers

Stops the input thread.

Tries to get rid of a running job.

Stops the output thread.

Cancels the timer: The callback function is not called any longer

For a given cipher in ECB mode, a new cipher in CBC mode is returned.

All the above listed OIDs with their string names (useful for displaying extension types)

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

Whether the client suggests or demands channel binding

Whether the client suggests or demands channel binding

channel_logger ch lev: Prints all messages with a level of lev and higher to the channel ch.

Outputs messages to the channel

Outputs messages to the channel

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

check_critical_exts list exts: When an extension is flagged as critical, it must be processed by the communication endpoint.

If the last component of the glob expression matches only directories because it ends with a literal / character, the value Some expr' is returned where expr' matches the same path without the trailing /.

If the glob expression matches the root directory (i.e.

If the major_status indicates an error, an error string is formed, optionally including the function name fn and the detailed information derived from minor_status.

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

A compare function for ustring_compare: Case-insensitive comparison: This function compares by the lowercase code point if it exists, and the untransformed code point otherwise.

List of supported ciphers

List of supported ciphers.

Deletes all contents of the buffer

Deletes all contents from the buffer.

Empty a hash table.

Deletes all contents of the buffer

Removes all elements from the queue

Table.clear tbl removes all key/value pairs from the table tbl.

Terminate the whole group.

Working versions of the functions with the same name in Unix

Clears the screen and the buffer, and sets the cursor to (0,0).

Writes a space character from the current cursor position to the end of the line

Writes a space character from the current cursor position to the end of the screen

Additional parameters understood by create_client_session

Creates an authentication method from a GSS-API interface.

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

The authorization name

The authorization name

client_channel st timeout: returns a bidirectional channel for st that times out after timeout seconds of waiting.

Whether the client suggests or demands channel binding

Returns the channel binding

Whether the client suggests or demands channel binding

Configure GS2-style channel binding

Sets whether to request channel binding.

Configure GS2-style channel binding

Returns the RPC client connector for this Netplex address

If set, the client will use a certain credential (and not acquire one).

After successful authentication, this function may return the URIs defining the authentication space.

Whether client_emit_message can now be called

Emits the next message to be sent to the server

Emits the next message to be sent to the server.

Emit a new response.

let (creds,new_headers) = client_emit_response cs method uri header:

Returns the client endpoint contained in the connect_status

Whether an error occurred, and the protocol cannot advance anymore

Whether the client is authenticated and the server verified

Whether the client sends the first message: `Required: always, `Optional: the client may choose to do so if the protocol permits this, `No: the server sends the first message

Whether the client sends the first message: `Required: always, `Optional: the client may choose to do so if the protocol permits this, `No: the server sends the first message

Flags for init_sec_context.

For clients: get the GSSAPI name of the target to contact as (name_string,name_type) pair.

Return the GSSAPI properties of the client, after the authentication is successful (and raises Not_found up to then).

Returns the GSSAPI props if available, or raise Not_found

Exports a client session as string, and imports the string again.

For clients: maps user names to a pair (name_string,name_type) that can be used in the GSSAPI for acquiring a name.

Checks whether this mechanism can accept the initial authentication challenge (i.e.

The password

Process the challenge from the server.

client_process_challenge cs method uri header challenge:

Get a mechanism-specific property of the session.

Returns a property of the client (or Not_found): "snonce", "cnonce", "salt", "i" (iteration_count), "protocol_key"

Get a mechanism-specific property of the session.

The 128-bit protocol key for encrypting messages.

Whether client_recv_message can now be called

Receives the next message from the server

Restart the session for another authentication round.

Restart the session for another authentication round.

Unserializes the session

Unserializes the session

Optionally return a string that can be used to identify the client session.

Optionally return a string that can be used to identify the client session.

Serializes the session as string

Serializes the session as string

The user name

The user name

The user name

Return the ID of a clock that counts the CPU seconds of the given process.

Get the resolution of this clock

Get the time of this clock

Set the time of this clock

Sets ulb_eof of the unicode_lexbuf.

Closes all descriptors known to the cache

Adds the EOF condition to the buffer.

Closes the handle in the w32_process value, if it is still open

Closes a socket as opened with create_server_socket

Closes the object.

Closes the log stream

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 interpreter from a function that creates the real command (as pipeline) to execute

Compares two strings like String.compare.

A compare function for ustring_compare: Normal string comparison: This function compares by code point

Return the GC color

Creates a command descriptor, to be used in call.

Creates a command from the passed arguments:

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 associated to the cookie or "" if it does not exists.

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.

Returns the comment URL 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.

ManagedClient can be used with Set.Make and Map.Make

Lexicographic ordering of OIDs

Preprocess the localization data for faster parsing and printing

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

concatenates the mstrings and return them as single string.

Returns the filename of the configuration file, or the default if it has not been set on the command-line

Returns the filename of the configuration file, or None if it has not been set on the command-line

Returns the tree of the configuration file, or None if it has not been set by create or modify.

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

Configurations: insecure: whether basic authentication over non-TLS connections is enabled You can only configure before the first user.

Configure GS2-style channel binding

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)., 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)., The at_exit handler sends a SIGTERM to all dependent processes, too. In previous versions of Ocamlnet it was also possible to configure catch_sigchld to set whether a SIGCHLD handler is installed.

Same as configure, but it only affects the next call

This function will be called before the pipeline is used.

connect addr tmo: Runs connect_e for this addr, and returns the result.

Tests whether the socket is connected with the peer after calling Unix.connect.

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.

This method connects to the host

request_rec connection field.

Converts the socket address into a connector

Converts the socket address into a connector

Converts the Netsockaddr.socksymbol into a connector

Converts the Netsockaddr.socksymbol into a connector

Reads a workload_manager section like

Consumes the event, and switches the event fd to off again.

container prefix: The prefix shall identify the container uniquely.

request_rec content_type field.

Returns the contents as string

Returns the contents of the buffer as fresh string.

Returns the full contents

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

convert_path oldfs newfs oldpath: The encoding of oldpath (which is assumed to reside in oldfs) is converted to the encoding of newfs and returned.

copy orig_fs orig_name dest_fs dest_name: Copies the file orig_name from orig_fs to the file dest_name in dest_fs.

Creates a deep copy of the input value, and stores the duplicate in normal process memory.

Returns a duplicate of the command description

Copies the cursor.

let e = copy_e d_in d_out: Copies data from d_in to d_out, and transitions to `Done n when all data is copied (where n are the number of copied bytes).

Copies an environment

copy_into orig_fs orig_name dest_fs dest_name: Like copy, but this version also supports recursive copies.

Create a copy

Create a copy

copy_value flags v: Creates a deep copy of v and returns it.

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

Returns the CP_set_env option for this array of environment variables (in the Unix.environment format)

Deprecated creation of an RPC server.

Connects to the Portmapper/RPCBIND 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

Creates a fresh context

create c key: create a new cipher context for key.

create blocksize: creates new buffer with this blocksize, which must be a whole multiple of the page size of the OS

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

Creates a netbuffer which allocates initially this number of bytes.

Creates a new mailbox with the passed name, or opens an existing mailbox.

Create the semaphore with this initial value.

Creates the command-line configuration object.

Hashtbl.create pool h creates a new, empty hash table in pool with a header h.

create pool_id n2 a h: Creates a matrix by deeply copying a normal array a and using the copy of h as header.

create pool bsize h: Creates a buffer in pool with a block size of bsize.

create pool h: Creates an empty queue in the pool, with header h

create m t: Creates a mutex of type t, and pushes it to the heap, using the mutator m.

create m value: Creates a semaphore with initial value, and pushes it to the heap, using the mutator m.

create pool_id a h: Creates a shared array by deeply copying a normal array a and using the copy of h as header

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

Creates a server according to the mode2 argument.

New style clients: Opens a connection to the server specified by mode2.

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.

create_camlbox prefix n size: Creates a new camlbox with a unique name derived from prefix.

create_camlbox addr n size: Creates a new camlbox for up to n messages of size bytes.

mech_type is the GSSAPI mechanism to use.

The new client session authenticate as user and authorizes as authz (empty string if not applicable).

create_client_session p username password: Creates a new client session for profile p so that the client authenticates as user username, and proves its identity with the given password.

The new client session authenticate as user.

create_client_session p username authzname password: Like create_client_session, but also sets the authorization name (only processed for the SASL profile).

create m: Creates a condition variable, and pushes it to the heap, using the mutator m.

The configuration includes:

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

create_container prefix: Like container, but the container is always created.

The container for normal services

Create a controller with the default event system

Create a controller for the passed event system

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

Creates a new endpoint for this configuration.

Creates an empty environment

Create an event object

Creates a new event file descriptor.

create_event_aggregator is_interruptible: Creates a new aggregator, and allocates the required OS resources.

create_file_endpoint ~role ~rd ~wr ~peer_name tls_config: Creates a new TLS endpoint (encapsulated as module, together with the provider) for the case that the data flows over file descriptors.

create_heap pool_id size root: Creates a new heap with size bytes in the pool identified by pool_id.

Provides a buffered version of the in_device.

Connects to a Portmapper/RPCBIND listening on an Internet port.

Create an universal address from an internet addr and a port

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

Creates the input thread for this file descriptor.

Connects to the local Portmapper/RPCBIND daemon.

Create a managed client for this config connecting to this connector.

Creates the memory pool as shared memory object of the passed size (rounded up to the next multiple of pages) and returns the resource ID.

Create a MIC token:

Creates a new mime_scanner scanning the passed string.

Creates a new monitor.

create_mset config services: The mset is created with config, and the services array describes which ports are available, and how often each port may be contacted (i.e.

Create a config record.

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

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

Provides a buffered version of the out_device.

Creates the output thread for this file descriptor.

Create a poll array with the given size.

Create a new pool.

create_preallocated_shm prefix size: Creates a new preallocated shm object with a unique name based on prefix, and a length of size bytes.

Same as create_preallocated_shm with the extension that a semaphore container is also allocated and returned

create_process cmd cmdline options: Spawns a new process that runs concurrently with the calling process.

create_protocol name addresses: Creates a protocol object from the passed arguments

Creates a new cache object.

Create a config record.

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

Creates a random string suited as salt

mech_types is the list of GSSAPI mechanism that are acceptable.

Create a new server session.

create_server_session p auth: Creates a new server session with profile p and authenticator function auth.

Same as create_server_session, but the authentication callback gets two arguments:

create_server_socket service_name proto addr: Creates a server socket as specified in proto for the address addr and returns it.

Create a new server session.

The new client session authenticate as user and authorizes as authz (empty string if not applicable).

Create the socket service (usually only internally used)

create_socket_service_config name protos ctrl_conf: Creates a socket_service_config object from the passed arguments

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

create_timer f tmo: Creates a timer with timeout value tmo: In tmo seconds f is called, and if this function returns true, the timer remains active, and another round of timing is arranged.

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

An alternate name for standard_event_system, provided for backward compatibility.

Create the variable with the passed name with an empty string (or the exception Sharedvar_null) as initial value.

Creates a wait_set in the heap designated by the mutator

Wraps a message so that it is encrypted and signed (confidential).

The configuration includes:

Create X.509 credentials from individual objects: system_trust: if set, the system certificates are trusted, trust specifies the CAs of peers to trust (default: empty), revoke specifies CRLs for revocation of peer certificates (default: empty), keys are our own certificates, as triples (cert_path, private_key, password) (default: empty) A client should set trust to the list of CAs it can accept on the server side.

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

For a given cipher in ECB mode, a new cipher in CTR mode is returned.

Increment the named semaphore from controller context, substituting an increment from a container (e.g.

Returns the current provider for cryptographic digests.

The current debug logger.

Returns the environment of the current process as abstract environment value

The current timestamp formatter

The variable containing the current logger function.

Returns the pluggable resolver.

Returns the current provider for symmetric cryptography.

Returns the system-dependent thread identifier of the caller (which must be in container or controller context)

Return the current TLS provider.

Same as current_tls but it returns None if TLS is unavailable

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 ((D)TLS not yet supported)

Sets whether to debug the C wrapper part.

Returns a multi-line debug string

Returns a string describing the allocations etc.

These variables control debugging of Rpc_server.

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.

Decodes a BER-encoded ASN.1 value.

Decodes the BER-encoded contents of a data field.

let (hdr_len, tc, pc, tag, len_opt) = decode_ber_header s: Decodes only the header: hdr_len will be the length of the header in bytes, tc is the tag class, pc whether primitive or constructed, tag is the numeric tag value, len_opt is the length field, or None if the header selects indefinite length If skip_length_check is set, the function does not check whether the string is long enough to hold the whole data part.

Like decode_ber, but returns only the length.

Encode names as described in section 3.2 of RFC 2078

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"

Decrement the named semaphore by 1, and return the new value.

decrypt cctx inbuf outbuf: Decrypts the data in inbuf and writes the result into outbuf.

Decrypts the ciphertext and verifies the attached signature.

Same, but with data representation as mstring list

let ch2 = decrypt_in ctx ch1: Reading from ch2 decrypts the data from ch1.

let ch2 = decrypt_out ctx ch1: Writing to ch2 decrypts the data and writes the plaintext to ch1.

let (fp,jp) = def_process proc: Defines a process (which must happen in the master process), so that:

let fork_point, join_point = def_process f: Defines process types, i.e.

The default block size, normally 64 K (or better, 16 times the page size)

The default configuration is: tmp_directory: Netsys_tmp.tmp_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)., max_arguments = 10000 (for security reasons), 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.

The default config: config_input_flow_control=false, config_output_flow_control=true

Default configuration: Extends Nethttpd_kernel.default_http_protocol_config with config_timeout_next_request = 15.0, config_timeout = 300.0, config_cgi = Netcgi.default_config, config_error_response = Nethttpd_util.std_error_response, config_log_error: Uses Nethttpd_util.std_error_log_string to write a log message via Netlog., config_log_access: is a no-op, config_tls_cert_props: is true, config_tls_remote_user: is true

Default config: config_max_reqline_length = 32768, config_max_header_length = 65536, config_max_trailer_length = 32768, config_limit_pipeline_length = 5, config_limit_pipeline_size = 65536, config_announce_server = `Ocamlnet, config_suppress_broken_pipe = false, config_tls = None

Default configuration: Extends Nethttpd_reactor.default_http_processor_config with config_reactor_synch = `Write

Returns the default options

The default pool with the default block size.

The default resolver uses Unix.gethostbyname to look up names.

The default services

Default configuration with non_blocking_connect = true

Adds missing components and returns the modified URL.

Returns the default value

Removes the source from the aggregator

Same as function

If you already have a credential, you can set this value to the exception Credential c (from the GSSAPI provider).

Deletes the number of characters from unicode_lexbuf.

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

Deletes the context, ignoring any error

delete_hd b n: Deletes n bytes from the beginning of the buffer

delete_hd b n: Deletes n bytes from the beginning of the buffer.

Deletes the named file

delete_var name: Deletes the variable name.

Convert OID's to/from DER.

Convert OID's to/from DER.

Returns the raw array in shared memory for unprotected access

Returns the raw array in shared memory for unprotected access

deref_c sr: Returns a copy of the contents of sr.

deref_p sr f: Runs f with the contents of sr, and returns the result of f.

Dereferences the variable and returns the contents, comparable to !.

Derives a special key from a base key, as described in RFC 3961.

derive_keys protocol_key usage: Returns the specific keys for this protocol_key and this usage numbers.

derive_cache parent config: Returns a new cache that shares the error counters with parent.

Returns the descriptor

Returns the descriptor

Get the descriptor of a heap

Returns the descriptor

Returns the descriptor

Returns the descriptor

Returns the descriptor

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

The argument is the URL-encoded parameter string.

Destroy this semaphore.

Destroys the buffer

Destroys the mutex

Destroys the semaphore

Destroys the heap and gives the memory back to the pool

Releases the OS resources.

Frees all OS resources

Destroys all resources that may be left

Destroys these objects

Internal function.

Returns whether `Memory buffers are supported

Digest a sequence of mstrings

Digest a string

List of supported digests

returns digests

Returns the dimenstions

Returns the directory_string as UTF-8

Disables the dynamic loader

Disable all modules (the default)

Disables all log messages for this client (internally used)

Disables logging for this server

Enable or disable the passed module M (e.g.

Discard client request body.

The domain of the cookie, if set.

The domain of the cookie, if set.

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

Attempts a downcast, or raises Not_found

Attempts a downcast, or raises Not_found

Drop the semaphores in this container, and delete the container.

A dummy mutex is non-functional, but can be used to put something into mutex-typed variables

A dummy semaphore is non-functional, but can be used to put something into semaphore-typed variables

A dummy condition is non-functional, but can be used to put something into condition-typed variables

A dummy wait_set is non-functional, but can be used to put something into wait_set-typed variables

returns the list of known mappings.

Dumps the access counter of this variable to Netlog.

Configures the dynamic service.

Reads a workload_manager section like

Emit a server challenge.

Emit a new response.

Returns the MSVCRT.DLL notion of the process identifier (pid).

Enables Netlog-style debugging of this module

Whether debug messages of general kind are enabled.

Whether debug messages are enabled.

Enables Netlog-style debugging

Enables the dynamic loader.

Enables Netlog-style debugging of this module

Enables Netlog-style debugging of this module

Enables Netlog-style debugging of the Ocaml wrapper

Enables Netlog-style debugging

Enables Netlog-style debugging

Enable debugging of this module

Enables Netlog-style debugging

Enables debug logging of containers

Enable debugging

Enables Netlog-style debugging of this module

Enables Netlog-style debugging of this module

Enables Netlog-style debugging of this module

Enables Netlog-style debugging of this module By default, the exchanged Telnet commands are logged.

Enables Netlog-style debugging of this module By default, the exchanged Telnet commands are logged.

Enables Netlog-style debugging of this module

Enables Netlog-style debugging of this module By default, the exchanged Telnet commands are logged.

Enables Netlog-style debugging of this module

Enables Netlog-style debugging

Enable Netlog debugging

Enable Netlog debugging

Enable all modules

Trace allocation and deallocation

Whether debug messages are enabled that trace connection events.

Whether to allow delegation of the credentials to the server.

By setting to true, each track_fd and release_fd is logged.

Whether the procedure trace is enabled.

Whether the procedure trace is enabled as debug messages.

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

Returns the encoding of the name of the encoding.

encrypt cctx inbuf outbuf: Encrypts the data in inbuf and writes the result into outbuf.

Encrypts the plaintext message and adds a signature to the ciphertext.

Same, but with data representation as mstring list

let ch2 = encrypt_in ctx ch1: Reading from ch2 encrypts the data from ch1.

let ch2 = encrypt_out ctx ch1: Writing to ch2 encrypts the data and writes the ciphertext to ch1.

Wraps an endpoint

Coercion

Enforces that all pending procedure calls get the Service_unavailable exception, and that the client is shut down.

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

Represents EOF as None.

Same as epsilon_engine

The execution of the function is pushed onto the event queue (minimal delay)

Same as function

Whether two OIDs are equal

Checks for equality.

request_rec err_headers_out field.

Returns the message for humans (display, log files etc.) when called with an error or warning symbol.

Returns the message for humans (display, log files etc.) when called with an error or warning symbol.

error_page env status fields msg detail: Logs an error message and outputs an error page via env.

Returns the underlying file descriptor.

Returns the proxy descriptor for the event.

Return the event system

Return the event system

Returns the unixqueue to which the client is attached

Wait until the event is set to signaled state.

Starts this command.

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.

Resolve generative sub expressions by expanding them.

extract scrypto (name,mode): returns the cipher called name in mode as scipher, or raises Not_found

Extracts all ciphers

Extracts the controller config

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

Same as Unix.access but the file is taken relative to the directory given by first argument

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

Advises to load pages into the page table from the file, or to remove such pages.

A pseudo manager that does not save anything to a text file

Allocate space for the file and the specified file region

Set the current directory to the directory referenced by the file descriptor

Wraps a file descriptor as event_source, and monitors the events in poll_req_events.

Return a string for generating debug messages.

Returns the table of descriptors as list of lines.

Syncs only data to disk.

Make a directory handle from a file descriptor.

Get the list of feature tokens (see also Netftp_client.ftp_state.ftp_features)

Table.fields tbl returns a list of (key, value) pairs consisting of all entries of the table tbl.

Make a file descriptor from an integer

Writes messages to this file

Reads a logging section like

Writes messages to this file

Same as function

Configures a file service

Translates an URI path to a file name.

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

request_rec filename field.

Fills this string with random bytes

Fills the string with random bytes.

filter_out_buffer ~max p d: The data written to this device is redirected via pipe p and finally written to d.

find name: get the digest name.

find (name,mode): get the cipher name in the passed mode.

Returns the digest of this name, or raises Not_found

find (name,mode): Looks up a cipher by name and mode, or raises Not_found

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.

Version of find_all with copied result

Version of find_all with pinned result

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

Like find but returns a copy of the binding in normal RAM

find_double_line_start s pos len: Searches two adjacent line ends (each may be a CR/LF combination or a single LF), and returns the position after the second line end.

find_extension is designed to be applied to the result of the extensions method of Netx509.x509_certificate:

find_line_end s pos len: Searches the next line end (CR/LF or only LF), and returns the position.

find_line_start s pos len: Searches the next start, and returns its position.

find_p tbl x f looks up the current binding of x in tbl, and calls f with this binding as argument.

find_ro tbl x returns the current binding of x in tbl, or raises Not_found if no such binding exists.

request_rec finfo field.

Returns the digest

This creates a job_engine internally and runs until it is finished, i.e.

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.

let e = flush_e d: If d has an internal buffer, all data is written out to d.

Same as function

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.

fold f accu q

fold_header f acc0 s pos len: Parses a MIME header in the string s from pos to exactly pos+len.

fold_lines f acc0 s pos len: Splits the substring of s from pos to pos+len into lines, and folds over these lines like List.fold_left.

fold_lines_p f acc0 s pos len: Splits the substring of s from pos to pos+len into lines, and folds over these lines like List.fold_left.

Returns whether the daemon runs in the foreground

Frees OS resources.

Format a date/time record as a string

format_camlbox addr fd n size: The file fd is mapped into memory, and formatted as camlbox.

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

format_timestamp fmt digits (seconds,nanos): Formats the timestamp (seconds,nanos) and returns the string.

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.

Note fp4_of_float: The same problems as in fp4_of_fp8 may arise

Frees this allocated block

Frees a wait_entry

Frees a wait_entry_e.

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.

Sync data and metadata to disk

Same as function

Like split_delim, but returns the delimiters in the result

Like split_delim, but returns the delimiters in the result

The standard debug logger simply prepends the module name to the message (separated by ": "), and calls the current logger to print it

This resolver uses Unix.getaddrinfo.

Lock the heap and do a GC pass

Shuts down the system object referenced by the descriptor so far possible, and closes the descriptor.

Other comparisons

Other comparisons

Parses the general_name structure

Parse a sequence of general names

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.

Get the value of the named semaphore.

Example: module MyPool = DbiPool(Dbi_postgres)

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

Table.get tbl key returns the corresponding entry in the table.

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.

Get the active code page.

To be used in servers: The client can address one of several virtual servers with the SNI extension, and this function returns which was requested.

Returns the Age header as number

Table.get_all tbl key same as Table.get tbl key except it returns all values corresponding to the key.

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.

Get the password sent in basic authentication.

Get the bitstring as bool array

Get the data.

Get the number of bits

get_c sa k1 k2: Gets a copy of the (k1,k2)-th element of the matrix sæ

get_c sa k: Gets a copy of the k-th element of the shared array sæ

Returns the Cache-control header as list of tokens.

Get the type of the certificate

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

Get the name of the cipher

The type of the cipher suite: "X509": X509 certificates are used, "OPENPGP": OpenPGP certificates are used, "ANON": anonymous credentials, "SRP": SRP credentials, "PSK": PSK credentials

Get client request data.

get_client_block_buf r buf ofs len read a chunk of data and puts it in buf.[ofs .. ofs+len-1].

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.

Get the name of the record-level compression method

Get the current config (possibly modified because of a rehandshake)

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

Get r/o console info.

Get the input stream of the console.

Get the output stream of the console.

Returns the Content-disposition field as parsed value.

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-length field as integer

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-transfer-encoding as string

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

Returns the Content-type as parsed value.

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

Get the cookies in the Nethttp.Cookie.t representation (the suffix "_ct" reminds of Cookie.t).

Returns custom ops for a sample value (or Invalid_argument)

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

Returns the list of active descriptors

let ec = get_ec e_keys n: Returns the required value for the "extra count" field of RFC 4121 if the plaintext message has size n.

Same for encapsulated values

get_enc_value name: Gets the value of the variable name.

Get the credentials that was actually used in the handshake, in raw format.

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.

Returns a duplicate of the underlying file descriptor.

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

Get the file descriptor wrapped by this event source

Get the file descriptor style.

Gets the file with this ID (or raises No_resource).

Returns the file name of the executable

Returns the From header as string.

Calls GetFullPathName

Get the GSSAPI properties if available

Get the GSSAPI properties of the last call (so far available)

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

Look up the host, and return the host entry or raise the exception Host_not_found.

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

Get an integer as int if representable, or raise Out_of_range

Get an integer as int32 if representable, or raise Out_of_range

Get an integer as int64 if representable, or raise Out_of_range

Get an integer in base 256 notation, big endian.

Get an integer as bytes

Get the name of the key exchange method

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

Get a debug string describing the last invoked procedure

get_lazily name f: Uses the variable name to ensure that f is only invoked when get_lazily is called for the first time, and that the value stored in the variable is returned the next times.

Return the length of the token in bytes

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

Retrieves the current offset for the local time zone, taking daylight savings into account.

Returns the Location header as string.

Calls GetLongPathName

Get the name of the message authentication code

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

Returns the Max-forwards header as number.

This FTP method walks to the right directory and gets file from the server.

Returns a message integrity code

Same, but with data representation as mstring list

Returns whether the nonblock flag is set

get_p sa k1 k2 f: Gets the (k1,k2)-th element of the matrix sa and call f with this element, and returns the result of f.

get_p sa k f: Gets the k-th element of the shared array sa and call f with this element, and returns the result of f.

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

Get the credentials of the peer, in raw format.

Get the chain that was actually used in the handshake.

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.

get_poll_cell a k: Returns the poll cell k.

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

Returns the process result if the process is finished, and None otherwise

Return whether Tcp or Udp

Get the protocol flavour

Get the name of the tunnel protocol

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

Get the byte representation of the real

Returns the Referer header as string.

Same, for addicts of correct orthography

Retrieves the resource by ID.

Returns the Retry-after header.

get_ro sa k1 k2: Gets the (k1,k2)-th element of the matrix sa.

get_ro sa k: Gets the k-th element of the shared array sa.

gets the semaphore with this ID (or raises No_resource).

Get the semaphore container

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

Get the (non-printable) marshalled session data, for later resumption with resume_client