Index of class methods

Stops the transmission of data.

Shuts any active connection immediately down, and changes the state of the engine to `Aborted.

Any engine running to get the cache value is aborted, and the contents of the cache are invalidated.

Forces that the engine aborts operation.

Aborts the current reader and/or writer forever.

Instantiates an engine that accepts connections on the listening endpoint.

Call this method to unlock the body channels.

On the first call, pass ~context:None.

Runs a lever function registered in the controller.

Runs the registered lever directly

Add a descriptor or modify an existing descriptor

Adds the call to the end of the pipeline.

add_admin setup: Allows to bind another RPC program to the admin socket.

adds a new-style authentication handler

The same as engine: The call c is added to the pipeline, and when it is processed, the returned engine transitions to the state `Done c.

Adds a key to the ring

Add data

Adds a message receiver.

Adds a plugin.

Adds a new service.

Add data

Add data

Add data

Adds the call to the end of the pipeline.

The name of the server (for name-based virtual servers).

The addresses of the master sockets.

This function is called by the controller at certain events to adjust the number of available containers.

Tell this object that n bytes of the front token could be really sent using Unix.write.

If the controller is alive, the socket is not yet completely down.

If the controller is alive, the socket is not yet completely down.

Specifies the user and password using APOP authentication.

#argument name returns the value of the argument named name.

#argument_exists returns false if the named parameter is missing and true otherwise.

#argument_value returns the value of the argument as a string.

Mutability of arguments has been dropped.

The complete list of arguments.

Returns the contents as bytes.

Returns the contents as memory.

Returns the contents as string (this is always a copy)

Return all header values for a given field name (header entries which allow several values separated by commas can also be transmitted by several header lines with the same name).

Return all response header values for a given field name (header entries which allow several values separated by commas can also be transmitted by several header lines with the same name).

Query a specific header entry, or raise Not_found

Query a specific header entry of the response.

#at_exit f registers the function f to be executed when #finalize is called (which is done automatically when the request finishes).

Attach to the event system.

auth mech user authz creds params: Performs a SASL authentication using the AUTH command (RFC 5034).

auth mech user authz creds params: Performs a SASL authentication using the AUTH command.

The list of domain URIs defines the protection space.

Return the corresponding protocol

The realm

The authentication scheme, e.g.

An optional ID which is only needed for multi-step authentication protocols (i.e.

Authenticaton status.

The user identifier (UTF-8)

authenticate srv conn_id details f: This method is called when a remote call has arrived.

Returns a list of additional headers that will authenticate the passed call for this session.

Whether the auth command ran successfully

sets a list of host names or domain suffixes for which no proxy should be used.

The bidrectional phase starts after "100 Continue" has been sent to the client, and stops when the response body begins.

blit_to_bytes mpos s spos len: Copies the substring of the managed string from mpos to mpos+len-1 to the substring of s from spos to spos+len-1

blit_to_string mpos mem mempos len: Copies the substring of the managed string from mpos to mpos+len-1 to the substring of mem from mempos to mempos+len-1

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

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

The block length of the hash function (for HMAC) in bytes

The block size of the stream

Accumulated size of the response body

In a multi-threaded program: Signal all waiting processes that the condition holds.

call_plugin p procname procarg: This method can be called from the container context to invoke the plugin p procedure procname.

Set a callback in the template.

Whether input is possible, i.e.

Whether output is possible, i.e.

Cancels any ongoing write.

Cancels polling for the next input message.

Cancels the read job.

Cancels the shutdown procedure.

Cancels the shutdown procedure.

There is a cancel bit in the pollset, and this method sets it to the argument value.

Cancels the write job.

Requests a list of capabilities (RFC 2449).

The result of the last capa command

Computes the capacity, i.e.

A well-known extension is the HTTPS property.

The distilled CGI properties

Return all properties as an associative list.

Return the parameter properties.

Returns a (possibly non-standard) CGI environment property.

This is the row query string.

We recommend you to use the method Netcgi.cgi.request_method which is more type-safe and informative.

The full request URI.

I rest to be convinced we need this.

Instructs the container to change the user of the process after starting the service.

The charset parameter of the content type of the header, or "" when there is no such parameter, or no header.

The name of the algorithm for encrypting the data stream, e.g.

A string describing the authentication and privacy mechanism that is in effect: "X509": X509 certificates are used, "OPENPGP": OpenPGP certificates are used, "ANON": anonymous credentials, "SRP": SRP credentials, "PSK": PSK credentials

Clear the cache

Deletes all keys from this key ring

Indicate that we are done with the file

Closes the file descriptor with a reliable method.

Closes the file descriptors

Closes the file descriptors

Forces that the FTP client is closed.

Closes all descriptors known to the cache

Returns whether the connection should be closed after this response.

Deletes the connection from the cache, and closes it

As in raw_in_channel

Closes the channel for input.

Closes the channel

As in raw_out_channel

Flushes the buffer, if any, and closes the channel for output.

Closes the channel

Counts connections with network or protocol errors

Counts totally failed connections (no more reconnects allowed)

Counts new connections (or better: attempts to establish connections)

Counts connections the server terminated with EOF

Counts connections closed because pipelines become empty

Counts connections given up because of timeouts

The code, `Success on success

Sends this command, and returns the status code and the status texts.

Flushes the transaction buffer, and writes its contents to the underlying resource.

The name of the compression algorithm (or "NULL"), on the TLS layer.

Set a conditional in the template.

Just returns the configuration

The configuration of the request.

Whether to set the Server header: `Ignore: The kernel does not touch the Server header., `Ocamlnet: Announce this web server as "Ocamlnet/<version>", `Ocamlnet_and s: Announce this web server as s and append the Ocamlnet string., `As s: Announce this web server as s

The CGI configuration to use in the Netcgi environment

Get HTML error text for the HTTP status code.

If true, the engine stops reading input tokens from the HTTP kernel when there is data in the input channel of the engine not yet read.

For internal services, this list configures which message kind is used for which protocol.

Limits the length of the pipeline (= unreplied requests).

Limits the size of the pipeline in bytes.

Logs the access after the request/response cycle is complete.

config_log_error info msg: Log the message msg.

Maximum size of the header, including the request line.

Maximum size of the request line.

Maximum size of the trailer

If true, the engine signals the user when there is already enough data to output, and no more output should be generated.

Specifies when to synchronize output, i.e.

Whether to suppress `Broken_pipe errors.

The "input synchronizer": It is called as obj # config_synch_input f ch to create a synchronous input channel from an asynchronous one, ch.

The "output synchronizer": It is called as obj # config_synch_output f ch to create a synchronous output channel from an asynchronous one, ch.

General timeout for network I/O (per I/O primitive).

Timeout in seconds to wait for the next request after the previous one has been completely received.

If set, the server enables TLS with the arugment config

Whether to include certificate properties in the cgi environment.

A user-supplied function to configure slave sockets (after accept).

Configures a timeout for both the control and the data connection.

configure_transport id transport: Configures that messages with transport layer ID id are exchanged on transport.

An optional limit of the number of connections this container can accept.

Instantiates an engine that connects to the endpoint given by the connect_address argument.

The current connection cache.

Reports which connections exist: (host, port, queue_length)

The number of containers for a certain socket service name

This method is called to get the event systems for containers.

Return the container ID

container_run esys: By default, it just runs esys#run().

Lists the containers

Lists the containers for a certain socket service name

Returns the content type of the header and its parameters as a couple (hdr, params).

Method content_type : unit -> string * (string * Netmime_string.s_param) list defined instead of content_type and content_type_params to be coherent with Netmime.mime_header_ro -- yet as easy to use.

continue is called when an already established circuit needs to be continued.

Make this config accessible here too, for convenience

#cookie cn returns the cookie with name cn.

Cookies are returned in decoded form.

Returns the list of valid cookies found in the request header.

Copies a file to a new name.

Start digestion

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

In a multi-threaded program: Creates a condition variable and returns the object.

Internal method.

Creates an engine that creates a wrapped_datagram_socket object and that sets up any further resources the objects needs.

create_from_string s pos len must_copy: Creates the mstring from the sub string of s starting at pos with length len

create_from_memory m pos len must_copy: Creates the mstring from the sub string of m starting at pos with length len

create_from_string s pos len must_copy: Creates the mstring from the sub string of s starting at pos with length len

Create a logger to be used for the whole Netplex system.

let lock, unlock = par#create_mem_locker(): Creates a mutex that is sufficient to protect process memory from uncoordinated access.

In a multi-threaded program: Creates a mutex and returns the object.

Same for proxy authentication (status 407)

Create a new authentication session.

In a multi-threaded program: Starts a new thread, and calls the passed function with the passed argument in the new thread (like Thread.create).

The key in the common "credentials" format that is used by generic mechanisms.

This method is invoked when the plugin has been added to this controller.

This method is called when a container finishes (after post_finish_hook).

ctrl_receive_call ctrl cid procname procarg emit: This method is called in the controller context ctrl when a procedure named procname is called.

The plugin has been unplugged from this controller

Returns the system-dependent thread identifier of the caller

Reads data from the file descriptor until EOF or until a fixed timeout is over.

Looks at the file descriptor.

This method really send the mail.

This the the channel on which the filter data is available.

How many bytes of the data are available.

The data last modification time, expressed as an integer number of seconds since the epoch (January 1, 1970 UTC).

let n_in, n_out = decrypt ~last inbuf outbuf: Decrypts the text in inbuf and writes the result to outbuf.

Decrypts this string as a whole

Decrypts this string as a whole

The following methods define the values for the corresponding methods without the def_ prefix:

The definition term

If set, the Host header omits this port number

This method may return a default user name

Marks the message number of the current mailbox for deletion.

If a credential was delegated it is returned here as (e,t).

These methods modify the fields of the header.

Output tokens are not supported (this is a deprecated feature of GSSAPI)

The socket to use for data transfers.

The socket state

The underlying file descriptor.

Returns the status line of the last response (but status lines with code 100 are ignored).

Destroys the session (e.g.

diagnostic message

Disable a socket service temporarily

Note that display_minor_status decodes all status value parts in one step and returns the result as string list.

Release any OS resources associated with the pollset.

Returns true iff the protocol engine is interested in new data from the socket.

Returns true iff the protocol engine has data to output to the socket

The domain URIs defining the protection space.

The URI actually sent to the server in the request line of the protocol.

Emits a token for this xid, prog_nr and vers_nr.

The string to substitute in the request line for the empty path.

Enables a disabled socket service again

let n_in, n_out = encrypt ~last inbuf outbuf: Encrypts the text in inbuf and writes the result to outbuf.

Encrypts this string as a whole

Encrypts this string as a whole

Returns the decoded credentials of this endpoint

Returns the credentials in the raw form.

The type of credentials

The engine doing HTTP

Works similar to input, but distinguishes between normal data and end-of-line separators.

An improved implementation of input_line that uses the buffer

The request environment.

The request environment.

The Netcgi environment representing the request header, the response header, and the channels to receive the request body and to send the response body.

The environment object.

The name normalized for equality comparisons.

The eq_name converted to string

The error message explaining the detail that went wrong

Returns the event system

The event system the container uses

The event system used by the controller.

The used event system

Returns the event system

Returns the event system

Returns the event system the engine is attached to

Runs the method synchronously.

Run another command as engine.

Runs the method asynchronously as engine.

Set whether the timeout value is to be applied to the input side of the connection.

Expand command : expn list will try to expand the Mailing list list.

Extensions (version 3 certificates) as triples (oid, data, critical).

The file descriptor

Just returns the socket

This method should be called as follows: If you find a Telnet_sb at the beginning of the input queue, remove this command Queue.take, and invoke fetch_subnegotiation.

If the transport mechanism is on top of a file descriptor, this is returned here.

Whether the file name is valid and refers to an existing file, or to a symlink pointing to an existing file.

Whether the file name is valid and a directory, or a symlink to a directory.

The filename

The filename parameter found in the header of file uploads.

After the body has been finalized, it cannot be accessed any longer.

This method calls #finalize for every CGI argument (including the possible one of PUT) to ensure that all files are deleted.

Arguments stored in temp files must be deleted when the argument is no longer used.

Checks whether a descriptor is member of the set, and returns its event mask.

Returns an inactive connection to the passed peer, or raise Not_found.

Returns all active connections owned by the object

Finish digestion, and return the digest

This method should be called after the request has been fully processed.

Reads the rest of the body (if any), and discards that data

This method is called just before sending the request.

Actual flags

Actual flags

Which credential flavors are handled by this method

As in raw_out_channel

If there is a write buffer, it will be flushed.

Flushes the channel.

Should be called when the controller is finished, in order to free resources again.

The first token of the queue, represented as data_chunk.

The FTP client backing this filesystem

Returns the current ftp_state

If set, idle containers run a Gc.full_major cycle.

Third stage of HTTP processing: This method is called when the HTTP request has been completely received, and the response is going to be generated.

Get a cached session (data string)

Returns the state of the file descriptor, or raises Not_found

Requests the value.

The host name of the content server, extracted from the URI.

Returns the cached value if available

Get the configuration options.

The path (incl.

The port number of the content server, extracted from the URI.

Get what to do if the server needs to be reconnected, i.e.

By default, the redirect mode is Redirect_if_idem.

What has been sent as body in the (last) request.

Deprecated.

Get the name of the request method.

Deprecated.

Deprecated.

the full URI of this message: http://server:port/path.

The address of the peer's socket.

The address of this socket

This method is called when an uncaught exception would otherwise terminate the container.

Whether greedy accepts are permitted

Returns the group the engine is member of

Properties of the GSSAPI session (if existing)

Returns GSSAPI properties, if available

Returns GSSAPI properties, if available

GSSAPI props if GSSAPI security is negotiated

If GSSAPI is active, return the properties

Whether the method allows to send a request body

Whether the method allows to reply with a body.

Called by the controller when the service is added

Sends an EHLO command to the server.

The response from the last HELO or EHLO

Performs the Help command.

Returns the home directory of the passed user, or the home directory of the current user for the empty string.

Set hooks

Look up the passed host name up.

Whether registered at IANA, and if so, which ID we use here

The name as registered by IANA (if registered)

In a multi-threaded program: Returns the thread ID.

The ID of the session (non-printable string)

an ID of the resource that is valid in the whole Netplex system

Whether connections must be identified by name, and not by IP address.

Same for proxies.

Extracts (mech_name,realm,sess_id,trans_id) if possible.

Inactivates the connection immediately, and releases any resources the controller is responsible for (e.g.

Inactivates the connection immediately, and releases any resources the controller is responsible for (e.g.

After this number of seconds a free thread can be terminated

Outputs the process or thread ID

Initializes the main process for usage with this parallelizer.

On the first call, pass ~context:None.

The name of the initiator.

The name of the initiator in exported format

As in raw_in_channel

Reads octets from the channel and puts them into the string.

input s k n: Reads channel data into the substring of s beginning at index k with length n.

The size of the input body.

so far known, or 0L

Reads exactly one octet from the channel and returns its code, or raises End_of_file

Not the user business.

This is the input_ch channel taken as asynchonous channel.

The input channel for reading the body of the request

Reads exactly one character from the channel, or raises End_of_file

Returns the "Content-length" request header field.

Type now is unit -> string * (string * Netmime_string.s_param) list to be coherent with Netmime.mime_header_ro.

Returns the parsed "Content-type" request header field.

Returns the "Content-type" request header field as a plain string or "" if it is not set.

Skips over the remaining data of the current record and the record boundary to the next record.

The request header.

The whole HTTP header.

For special header structures, just override this method.

#input_header_field ?default f returns the value of a field f of the HTTP request header.

Returns the input header as (name,value) pairs.

Reads the next line from the channel.

The queue of commands received from the remote side.

Not the user business.

Suggests the calculation of a timeout value for input: `Normal: The normal timeout value applies, `Next_message: The timeout value applies while waiting for the next message, `None: The connection is output-driven, no input timeout value

The method is called when a new session must be authenticated.

The internal sockets for internal services: pairs of (protocol,server)

Remove all auth sessions

The session is notified that authentication failed.

Invalidates the cache - if a value exists in the cache, it is removed.

Removes all auth sessions for this connection

The handler is notified that authentication failed for this key

Whether host_by_name may return IPv6 addresses

Whether the queue is empty

Whether the method is to be considered as idempotent ( = repeated invocations have the same result and no side effect).

A test for GSS_C_NO_CREDENTIAL

A test for GSS_C_NO_NAME

Deprecated.

true if request/response cycle(s) have been finished, i.e.

The DN of the issuer

The unique ID of the issuer

Supported iv lengths as pairs min,max.

Returns the called job

Returns the called job

Returns the job instance

Returns the job instance

In a multi-threaded program: Suspends the calling thread until this thread terminates.

Supported key lengths as pairs min,max.

List of all known keys

The name of the key exchange algorithm, e.g.

The last state of the last operation, or Not_found

Returns the header of the HTTP response of the last operation.

Return the response status of the last operation, as triple (symbolic_code,numeric_code,text).

The stderr output of the last operation

The length of the managed string

Whether the socket is still lingering

Returns the scan listing for an optional message number or for all messages in the current mailbox.

Whether to chmod Unix Domain sockets

Whether to chown (user,group) Unix Domain sockets

The local receiver.

The local sender.

In a multi-threaded program: Suspends the calling thread until the mutex is locked.

Sends a log message to the controller.

Same as log_subch when subchannel is set to the empty string.

#log_error msg appends msg to the webserver log.

You may want to override this with your custom logging method.

Triples (component, subchannel, max_level, file, format) .

Remember this version of cgi_properties as the one sent to the config_log_access function

Sends a log message to the controller.

Receive a log message of level from component.

The logger

lookup service_name protocol_name tries to find a Unix domain socket for the service and returns it.

lookup_container_sockets service_name protocol_name: returns the Unix Domain paths of all container sockets for this service and protocol.

The backlog (argument of Unix.listen)

Whether to reuse ports immediately

Returns the MAC for AEAD ciphers.

Get the MAC of the processed data

Get the MAC of the processed data

The name of the data integrity algorithm (actually only the digest algorithm for HMAC), e.g.

Performs a MAIL FROM command.

The member mailboxes

The matchedDN field sent with some codes

If more job capacity is available than this number, threads are terminated.

How many jobs every thread can execute concurrently until it is considered as fully loaded.

Return the maximum global log level

Returns the current maximum length (initially Int64.max_int)

The manager does not start more threads than this number

Actual mechanism

Actual mechanism

Whether start_mem_reading and start_mem_writing are possible

The manager starts as many threads as required to ensure that this number of jobs can be executed.

Creates a new directory.

The enabled facts for `MLST and `MLSD

All available facts for `MLST and `MLSD

The mode of the cipher

#multiple_argument name returns all the values of the argument named name.

Whether it is possible to accept multiple connections

The current fields of the header.

Returns the values of all fields with the passed name of the request header.

Returns the values of all fields with the passed name of the repsonse header.

The current number of connections

The sum of all connections so far

The name of the authentication method

The name of this method, used for errors etc.

The name conventionally follows the <uppercasestring>-<size> format, e.g.

The name of the cipher

This is the raw version of the DN: a sequence of relative DNs, and a relative DN is a set of (type,value) pairs.

The name of the group

The name of the mailbox.

The name of this receiver

The protocol name is an arbitrary string identifying groups of sockets serving the same protocol for a socket_service.

The proposed name for the socket_service

The name of the socket_service is used to identify the service in the whole netplex process cluster.

The name of the type of the service provider

The name of the argument.

Whether `EPSV or `EPRT are required instead of `PASV and `PORT, respectively.

Returns true when a lingering close operation is needed to reliably shut down the socket.

Request a new session.

Called with client prog proc xid.

Tries to read the next request.

A substitute credential for GSS_C_NO_CREDENTIAL

A substitute name for GSS_C_NO_NAME

Same as set_proxy_enabled false

Whether the effect of .. can be obtained by stripping off the last path component, i.e.

non_blocking_connect: Whether the remote service is connected in the background.

Pings the server to keep the session alive.

NOOP : does nothing, keeps the connection alive.

Returns the number of connections which are open at the same time and currently being used by this object (i.e.

Returns the number of messages which are still in the pipeline.

The OID (if registered)

Get some runtime configuration aspects from this controller.

Opens the value for reading.

Open the contents of the value as an input channel.

See #set_value.

Opens the value for writing.

The output channel to which the generated content is intended to be written.

The "raw" output channel.

As in raw_out_channel

Takes octets from the string and writes them into the channel.

output cgi outputs the template to the CGI session cgi.

output s k n: Writes the substring of s beginning at index k with length n into the channel.

The size of the output body.

Writes exactly the contents of the buffer

Writes exactly one byte passed as integer code

Writes exactly the passed string

This is the output_ch channel taken as asynchronous channel.

Writes the contents of an in_obj_channel until the end of the input channel is reached.

Writes exactly one character

Finishes the current record.

The response header

The whole HTTP response header

For special header structures, override this method and maybe #send_output_header.

Returns the value of a field of the response header.

Returns the output header as (name,value) pairs.

The queue of commands to send to the remote side.

Reflects the state of the output generation: `Start: Nothing is generated yet, `Sending: Output is already being sent, `End: The response (for a single request) has been fully sent

Not the user business.

Writes exactly the passed string

List of pairs (protocol_name, path) of all container sockets of this container

The padding scheme of the cipher

Returns the parallelizer that created this thread.

the value so far available, independently of the code

Authenticates a user with the plain-text password pass.

The password in cleartext (UTF-8)

Returns the cleartext password for a user name, or raises Not_found if the user is unknown

Paths of filesystems may be encoded

Paths of filesystems may be encoded

The encoding must be ASCII-compatible (Netconversion.is_ascii_compatible).

Code points that must not occur in path components between slashes.

If available, this function is called for every accepted connection.

Peeks the first token, but leaves it in the queue.

Returns the decoded peer credentials

Returns the peer credentials in the raw form.

The type of credentials

If the transport mechanism provides a way to authenticate the peer, it can return the name here.

The curerent protocol interpreter.

The HTTP pipeline backing this file system

Returns the number of unanswered requests = Number of received `Req_end tokens minus number of responses in state `Processed.

As in raw_in_channel

Returns the current channel position.

Returns the number of characters read from the channel

As in raw_out_channel

Returns the current channel position.

Returns the number of characters output into the channel

A user-supplied function that is called after the service has been added to the controller

A user-supplied function that is called after the container is terminated.

A user-supplied function that is called after the service has been removed from the controller

A user-supplied function that is called after the container is created and started, but before the first service request arrives.

A user-supplied function that is called just before the container is terminated.

A user-supplied function that is called before the container is created and started.

Whether as_memory or as_bytes is cheaper

Outputs the definition term to a formatter

let pe = prioritized f p: Queues up f on priority level p.

A user-supplied function that is called when a new socket connection is established.

Second stage of HTTP processing: This method is called when the body is expected to be arriving.

First stage of HTTP processing: This method is called when the HTTP header has been received.

process_internal ~when_done cont client protocol: This function is called instead of process when a connection to an internal service is made.

A user-supplied object to process incoming connections

The RPC program structure on which the messaging bases.

propagate name value version: push the new value of the variable called name to other processes.

The protocol encapsulation

The name of the TLS protocol version, e.g.

The HTTP version of the response.

The server protocol in a decoded form.

This list describes the sockets to create in detail

A string name identifying the provider

Returns the proxy mode

proxy_type url returns Some pt if a proxy would be used for this url, and None if a direct connection would be made.

Same for an already created call object

Whether to use the CONNECT method if the connection is made via a web proxy.

The parallelization type actually used for this container

The actually effective parallelization type

The subject's public key

The algorithm of the public key (OID, and algorithm-specific parameters)

Puts a value immediately into the cache.

Requests the server to end this session.

Requests the server to end this session.

Performs a RCPT TO command.

read flags filename: Opens the file filename for reading, and returns the input stream.

Additional flag: `Header h: Set these headers in the submitted GET request

Returns the file names contained in the directory, without path.

Whether the EOF marker has been read

Whether the EOF marker has been read