A |
| abort [Nethttpd_kernel.http_protocol] |
Stops the transmission of data.
|
| abort [Ftp_client.ftp_client_pi] |
Shuts any active connection immediately down, and changes the
state of the engine to `Aborted.
|
| abort [Uq_engines.engine] |
Forces that the engine aborts operation.
|
| abort_rw [Rpc_transport.rpc_multiplex_controller] |
Aborts the current reader and/or writer forever.
|
| accept [Uq_engines.server_socket_acceptor] |
Instantiates an engine that accepts connections on the listening
socket.
|
| accept_body [Nethttpd_reactor.http_reactive_request] |
Call this method to unlock the body channels.
|
| add [Ftp_client.ftp_client] |
Adds an FTP method to the queue of methods to execute.
|
| add [Http_client.pipeline] |
Adds the call to the end of the pipeline.
|
| add_abort_action [Unixqueue.event_system] |
|
| add_admin [Netplex_types.controller] |
add_admin setup: Allows to bind another RPC program to the admin
socket.
|
| add_auth_handler [Http_client.pipeline] |
adds a new-style authentication handler
|
| add_authentication_method [Http_client.pipeline] |
adds an old-style authentication method
|
| add_close_action [Unixqueue.event_system] |
|
| add_cmd [Ftp_client.ftp_client_pi] |
Add another command to the queue.
|
| add_event [Unixqueue.event_system] |
|
| add_handler [Unixqueue.event_system] |
|
| add_key [Http_client.key_ring] |
Adds a key to the ring
|
| add_resource [Unixqueue.event_system] |
|
| add_service [Netplex_types.controller] |
Adds a new service.
|
| add_with_callback [Http_client.pipeline] |
Adds the call to the end of the pipeline.
|
| addresses [Netplex_types.protocol] |
The addresses of the master sockets.
|
| adjust [Netplex_types.workload_manager] |
This function is called by the controller at certain events to
adjust the number of available containers.
|
| advance [Nethttpd_kernel.http_response] |
Tell this object that n bytes of the front token could be really
sent using Unix.write.
|
| alive [Rpc_transport.rpc_multiplex_controller] |
If the controller is alive, the socket is not yet completely down.
|
| alive [Uq_engines.multiplex_controller] |
If the controller is alive, the socket is not yet completely down.
|
| apop [Netpop.client] |
Specifies the user and password using APOP authentication.
|
| argument [Netcgi1_compat.Netcgi_types.cgi_activation] |
|
| argument [Netcgi.cgi] |
#argument name returns the value of the argument named name.
|
| argument [Netcgi_common.cgi] |
|
| argument_exists [Netcgi.cgi] |
#argument_exists returns false if the named parameter is
missing and true otherwise.
|
| argument_exists [Netcgi_common.cgi] |
|
| argument_value [Netcgi1_compat.Netcgi_types.cgi_activation] |
|
| argument_value [Netcgi.cgi] |
#argument_value returns the value of the argument as a
string.
|
| argument_value [Netcgi_common.cgi] |
|
| arguments [Netcgi1_compat.Netcgi_types.cgi_activation] |
Mutability of arguments has been dropped.
|
| arguments [Netcgi.cgi] |
The complete list of arguments.
|
| arguments [Netcgi_common.cgi] |
|
| as_auth_handler [Http_client.basic_auth_method] |
|
| assoc_multi_req_header [Http_client.http_call] |
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).
|
| assoc_multi_resp_header [Http_client.http_call] |
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).
|
| assoc_req_header [Http_client.http_call] |
Query a specific header entry, or raise Not_found
|
| assoc_resp_header [Http_client.http_call] |
Query a specific header entry of the response.
|
| at_exit [Netcgi.cgi] |
#at_exit f registers the function f to be executed when
#finalize is called (which is done automatically when the
request finishes).
|
| at_exit [Netcgi_common.cgi] |
|
| attach [Telnet_client.telnet_session] |
Attach to the event system.
|
| auth_domain [Http_client.auth_session] |
The list of domain URIs defines the protection space.
|
| auth_in_advance [Http_client.auth_session] |
Whether "authentication in advance" is enabled
|
| auth_realm [Http_client.auth_session] |
The realm
|
| auth_scheme [Http_client.auth_session] |
The authentication scheme, e.g.
|
| auth_user [Http_client.auth_session] |
The user identifier
|
| authenticate [Rpc_server.auth_method] |
This method is called when a remote call has arrived.
|
| authenticate [Http_client.auth_session] |
Returns a list of additional headers that will authenticate
the passed call for this session.
|
| avoid_proxy_for [Http_client.pipeline] |
sets a list of host names or domain suffixes for which no proxy
should be used.
|
B |
| bidirectional_phase [Nethttpd_kernel.http_response] |
The bidrectional phase starts after "100 Continue" has been sent to the
client, and stops when the response body begins.
|
| block_size [Netstream.in_obj_stream] |
The block size of the stream
|
| bool_param [Netplex_types.config_file] |
|
C |
| can_input [Uq_engines.async_in_channel] |
Whether input is possible, i.e.
|
| can_output [Uq_engines.async_out_channel] |
Whether output is possible, i.e.
|
| cancel_rd_polling [Rpc_transport.rpc_multiplex_controller] |
Cancels polling for the next input message.
|
| cancel_reading [Uq_engines.multiplex_controller] |
Cancels the read job.
|
| cancel_shutting_down [Rpc_transport.rpc_multiplex_controller] |
Cancels the shutdown procedure.
|
| cancel_shutting_down [Uq_engines.multiplex_controller] |
Cancels the shutdown procedure.
|
| cancel_writing [Uq_engines.multiplex_controller] |
Cancels the write job.
|
| capacity [Netplex_types.workload_manager] |
Computes the capacity, i.e.
|
| cgi_auth_type [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_auth_type [Netcgi.cgi_environment] |
|
| cgi_auth_type [Netcgi_common.cgi_environment] |
|
| cgi_gateway_interface [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_gateway_interface [Netcgi.cgi_environment] |
|
| cgi_gateway_interface [Netcgi_common.cgi_environment] |
|
| cgi_https [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_https [Netcgi.cgi_environment] |
A well-known extension is the HTTPS property.
|
| cgi_https [Netcgi_common.cgi_environment] |
|
| cgi_path_info [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_path_info [Netcgi.cgi_environment] |
|
| cgi_path_info [Netcgi_common.cgi_environment] |
|
| cgi_path_translated [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_path_translated [Netcgi.cgi_environment] |
|
| cgi_path_translated [Netcgi_common.cgi_environment] |
|
| cgi_properties [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_properties [Netcgi.cgi_environment] |
Return all properties as an associative list.
|
| cgi_properties [Netcgi_common.cgi_environment] |
Return the parameter properties.
|
| cgi_property [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_property [Netcgi.cgi_environment] |
Returns a (possibly non-standard) CGI environment property.
|
| cgi_property [Netcgi_common.cgi_environment] |
|
| cgi_query_string [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_query_string [Netcgi.cgi_environment] |
This is the row query string.
|
| cgi_query_string [Netcgi_common.cgi_environment] |
|
| cgi_remote_addr [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_remote_addr [Netcgi.cgi_environment] |
|
| cgi_remote_addr [Netcgi_common.cgi_environment] |
|
| cgi_remote_host [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_remote_host [Netcgi.cgi_environment] |
|
| cgi_remote_host [Netcgi_common.cgi_environment] |
|
| cgi_remote_ident [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_remote_ident [Netcgi.cgi_environment] |
|
| cgi_remote_ident [Netcgi_common.cgi_environment] |
|
| cgi_remote_user [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_remote_user [Netcgi.cgi_environment] |
|
| cgi_remote_user [Netcgi_common.cgi_environment] |
|
| cgi_request_method [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_request_method [Netcgi.cgi_environment] |
|
| cgi_request_method [Netcgi_common.cgi_environment] |
|
| cgi_request_uri [Netcgi1_compat.Netcgi_env.cgi_environment] |
I rest to be convinced we need this.
|
| cgi_script_name [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_script_name [Netcgi.cgi_environment] |
|
| cgi_script_name [Netcgi_common.cgi_environment] |
|
| cgi_server_name [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_server_name [Netcgi.cgi_environment] |
|
| cgi_server_name [Netcgi_common.cgi_environment] |
|
| cgi_server_port [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_server_port [Netcgi.cgi_environment] |
|
| cgi_server_port [Netcgi_common.cgi_environment] |
|
| cgi_server_protocol [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_server_protocol [Netcgi.cgi_environment] |
|
| cgi_server_protocol [Netcgi_common.cgi_environment] |
|
| cgi_server_software [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| cgi_server_software [Netcgi.cgi_environment] |
|
| cgi_server_software [Netcgi_common.cgi_environment] |
|
| change_user_to [Netplex_types.socket_service_config] |
Instructs the container to change the user of the process after
starting the service.
|
| charset [Netcgi1_compat.Netcgi_types.cgi_argument] |
|
| charset [Netcgi.cgi_argument] |
The charset parameter of the content type of the header, or
"" when there is no such parameter, or no header.
|
| charset [Netcgi_common.cgi_argument] |
|
| clear [Http_client.key_ring] |
Deletes all keys from this key ring
|
| clear [Unixqueue.event_system] |
|
| close [Nethttpd_reactor.http_reactor] |
Closes the file descriptor with a reliable method.
|
| close_connection [Nethttpd_kernel.http_response] |
Returns whether the connection should be closed after this response.
|
| close_in [Netchannels.augment_raw_in_channel] |
As in raw_in_channel
|
| close_in [Netchannels.rec_in_channel] |
Closes the channel for input.
|
| close_in [Uq_engines.async_in_channel] |
Closes the channel
|
| close_out [Netchannels.augment_raw_out_channel] |
As in raw_out_channel
|
| close_out [Netchannels.rec_out_channel] |
Flushes the buffer, if any, and closes the channel for output.
|
| close_out [Uq_engines.async_out_channel] |
Closes the channel
|
| cnt_crashed_connections [Http_client.pipeline] |
Counts connections with network or protocol errors
|
| cnt_failed_connections [Http_client.pipeline] |
Counts totally failed connections (no more reconnects allowed)
|
| cnt_new_connections [Http_client.pipeline] |
Counts new connections (or better: attempts to establish connections)
|
| cnt_server_eof_connections [Http_client.pipeline] |
Counts connections the server terminated with EOF
|
| cnt_successful_connections [Http_client.pipeline] |
Counts connections closed because pipelines become empty
|
| cnt_timed_out_connections [Http_client.pipeline] |
Counts connections given up because of timeouts
|
| commit_work [Netchannels.trans_out_obj_channel] |
Flushes the transaction buffer, and writes its contents to the
underlying resource.
|
| config [Nethttpd_kernel.http_protocol] |
Just returns the configuration
|
| config [Netcgi1_compat.Netcgi_env.cgi_environment] |
|
| config [Netcgi.cgi_environment] |
The configuration of the request.
|
| config [Netcgi_common.cgi_environment] |
|
| config_announce_server [Nethttpd_kernel.http_protocol_config] |
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
|
| config_cgi [Nethttpd_reactor.http_processor_config] |
The CGI configuration to use in the Netcgi environment
|
| config_error_response [Nethttpd_reactor.http_processor_config] |
Get HTML error text for the HTTP status code.
|
| config_error_response [Nethttpd_types.min_config] |
|
| config_input_flow_control [Nethttpd_engine.http_engine_config] |
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.
|
| config_limit_pipeline_length [Nethttpd_kernel.http_protocol_config] |
Limits the length of the pipeline (= unreplied requests).
|
| config_limit_pipeline_size [Nethttpd_kernel.http_protocol_config] |
Limits the size of the pipeline in bytes.
|
| config_log_error [Nethttpd_reactor.http_processor_config] |
The function logs an error message.
|
| config_log_error [Nethttpd_types.min_config] |
|
| config_max_header_length [Nethttpd_kernel.http_protocol_config] |
Maximum size of the header, including the request line.
|
| config_max_reqline_length [Nethttpd_kernel.http_protocol_config] |
Maximum size of the request line.
|
| config_max_trailer_length [Nethttpd_kernel.http_protocol_config] |
Maximum size of the trailer
|
| config_output_flow_control [Nethttpd_engine.http_engine_config] |
If true, the engine signals the user when there is already enough data
to output, and no more output should be generated.
|
| config_reactor_synch [Nethttpd_reactor.http_reactor_config] |
Specifies when to synchronize output, i.e.
|
| config_synch_input [Nethttpd_engine.http_engine_processing_config] |
The "input synchronizer": It is called as obj # config_synch_input f ch
to create a synchronous input channel from an asynchronous one, ch.
|
| config_synch_output [Nethttpd_engine.http_engine_processing_config] |
The "output synchronizer": It is called as obj # config_synch_output f ch
to create a synchronous output channel from an asynchronous one, ch.
|
| config_timeout [Nethttpd_reactor.http_processor_config] |
General timeout until new data arrives.
|
| config_timeout_next_request [Nethttpd_reactor.http_processor_config] |
Timeout in seconds to wait for the next request after the previous one
has been completely received.
|
| configure_slave_socket [Netplex_types.protocol] |
A user-supplied function to configure slave sockets (after accept).
|
| connect [Ftp_client.ftp_method] |
The host and port the FTP method wants to be connected to.
|
| connect [Uq_engines.client_socket_connector] |
Instantiates an engine that connects to the socket given by the
connect_address argument.
|
| connection_cache [Http_client.pipeline] |
The current connection cache.
|
| connections [Http_client.pipeline] |
Reports which connections exist: (host, port, queue_length)
|
| container_state [Netplex_types.socket_controller] |
|
| content_disposition [Netmime.mime_header_ro] |
Returns the Content-disposition field as parsed value.
|
| content_length [Netmime.mime_header_ro] |
Returns the Content-length field as integer
|
| content_transfer_encoding [Netmime.mime_header_ro] |
Returns the Content-transfer-encoding as string
|
| content_type [Netmime.mime_header_ro] |
Returns the Content-type as parsed value.
|
| content_type [Netcgi1_compat.Netcgi_types.cgi_argument] |
|
| content_type [Netcgi.cgi_argument] |
Returns the content type of the header and its parameters as a
couple (hdr, params).
|
| content_type [Netcgi_common.cgi_argument] |
|
| content_type_params [Netcgi1_compat.Netcgi_types.cgi_argument] |
Method content_type : unit -> string * (string *
Mimestring.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.
|
| controller_config [Netplex_types.netplex_config] |
|
| controller_config [Netplex_types.controller] |
|
| cookie [Netcgi.cgi_environment] |
#cookie cn returns the cookie with name cn.
|
| cookie [Netcgi_common.cgi_environment] |
|
| cookies [Netcgi1_compat.Netcgi_env.cgi_environment] |
Cookies are returned in decoded form.
|
| cookies [Netcgi.cgi_environment] |
Returns the list of valid cookies found in the request header.
|
| cookies [Netcgi_common.cgi_environment] |
|
| create_container [Netplex_types.socket_service] |
Internal method.
|
| create_datagram_socket [Uq_engines.datagram_socket_provider] |
Creates an engine that creates a wrapped_datagram_socket object
and that sets up any further resources the objects needs.
|
| create_logger [Netplex_types.logger_factory] |
|
| create_logger [Netplex_types.controller_config] |
Create a logger to be used for the whole Netplex system.
|
| create_mem_mutex [Netplex_types.parallelizer] |
let lock, unlock = par#create_mem_locker(): Creates a mutex that
is sufficient to protect process memory from uncoordinated access.
|
| create_processor [Netplex_types.processor_factory] |
|
| create_session [Http_client.auth_handler] |
Create a new authentication session.
|
| create_workload_manager [Netplex_types.workload_manager_factory] |
|
| current_sys_id [Netplex_types.parallelizer] |
Returns the system-dependent thread identifier of the caller
|
| cycle [Nethttpd_kernel.lingering_close] |
Reads data from the file descriptor until EOF or until a fixed timeout
is over.
|
| cycle [Nethttpd_kernel.http_protocol] |
Looks at the file descriptor.
|
D |
| data [Netsmtp.client] |
This method really send the mail.
|
| data [Netcgi_fcgi.cgi] |
This the the channel on which the filter data is available.
|
| data_length [Netcgi_fcgi.cgi] |
How many bytes of the data are available.
|
| data_mtime [Netcgi_fcgi.cgi] |
The data last modification time, expressed as an integer
number of seconds since the epoch (January 1, 1970 UTC).
|
| datagram_type [Uq_engines.wrapped_datagram_socket] |
|
| debug_log [Unixqueue.event_system] |
|
| def_empty_path_replacement [Http_client.generic_call] |
|
| def_has_req_body [Http_client.generic_call] |
|
| def_has_resp_body [Http_client.generic_call] |
|
| def_is_idempotent [Http_client.generic_call] |
|
| def_request_method [Http_client.generic_call] |
The following methods define the values for the corresponding
methods without the def_ prefix:
|
| def_term [Nethttpd_types.http_service] |
The definition term
|
| dele [Netpop.client] |
Marks the message number of the current mailbox for deletion.
|
| delete_argument [Netcgi1_compat.Netcgi_types.cgi_activation] |
|
| delete_field [Netmime.mime_header] |
These methods modify the fields of the header.
|
| descr [Ftp_data_endpoint.ftp_data_engine] |
The socket to use for data transfers.
|
| descr_state [Ftp_data_endpoint.ftp_data_engine] |
The socket state
|
| descriptor [Uq_engines.wrapped_datagram_socket] |
The underlying file descriptor.
|
| dest_status [Http_client.http_call] |
Returns the status line of the last response (but status lines
with code 100 are ignored).
|
| disable [Netplex_types.socket_controller] |
Disable a socket service temporarily
|
| disable_local_option [Telnet_client.telnet_session] |
|
| disable_remote_option [Telnet_client.telnet_session] |
|
| do_input [Nethttpd_kernel.http_protocol] |
Returns true iff the protocol engine is interested in new data from the
socket.
|
| do_output [Nethttpd_kernel.http_protocol] |
Returns true iff the protocol engine has data to output to the socket
|
| domain [Http_client.key] |
The domain URIs defining the protection space.
|
E |
| effective_request_uri [Http_client.http_call] |
The URI actually sent to the server in the request line of the
protocol.
|
| empty_path_replacement [Http_client.http_call] |
The string to substitute in the request line for the empty
path.
|
| enable [Netplex_types.socket_controller] |
Enables a disabled socket service again
|
| enable_local_option [Telnet_client.telnet_session] |
|
| enable_remote_option [Telnet_client.telnet_session] |
|
| engine [Nethttpd_engine.http_engine_processing_context] |
The engine doing HTTP
|
| enhanced_input [Netchannels.enhanced_raw_in_channel] |
Works similar to input, but distinguishes between normal data
and end-of-line separators.
|
| enhanced_input_line [Netchannels.enhanced_raw_in_channel] |
An improved implementation of input_line that uses the buffer
|
| environment [Nethttpd_engine.http_request_notification] |
The request environment.
|
| environment [Nethttpd_engine.http_request_header_notification] |
The request environment.
|
| environment [Nethttpd_reactor.http_reactive_request] |
The Netcgi environment representing the request header, the response header, and
the channels to receive the request body and to send the response body.
|
| environment [Netcgi1_compat.Netcgi_types.cgi_activation] |
|
| environment [Netcgi.cgi] |
The environment object.
|
| environment [Netcgi_common.cgi] |
|
| event_system [Rpc_transport.rpc_multiplex_controller] |
Returns the event system
|
| event_system [Netplex_types.container] |
The event system the container uses
|
| event_system [Netplex_types.controller] |
The event system used by the controller.
|
| event_system [Ftp_client.ftp_client_pi] |
The used event system
|
| event_system [Http_client.pipeline] |
Returns the event system
|
| event_system [Uq_engines.multiplex_controller] |
Returns the event system
|
| event_system [Uq_engines.engine] |
Returns the event system the engine is attached to
|
| execute [Ftp_client.ftp_method] |
This method is called when the ftp_client_pi is connected and
the queue of commands is empty.
|
| exists_resource [Unixqueue.event_system] |
|
| exn_log [Unixqueue.event_system] |
|
| expn [Netsmtp.client] |
Expand command : expn list will try to expand the Mailing list
list.
|
F |
| fd [Nethttpd_kernel.lingering_close] |
The file descriptor
|
| fd [Nethttpd_kernel.http_protocol] |
Just returns the socket
|
| fetch_subnegotiation [Telnet_client.telnet_session] |
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.
|
| field [Netmime.mime_header_ro] |
|
| fields [Netmime.mime_header_ro] |
|
| filename [Netplex_types.config_file] |
|
| filename [Netcgi1_compat.Netcgi_types.cgi_argument] |
|
| filename [Netcgi.cgi_argument] |
The filename parameter found in the header of file uploads.
|
| filename [Netcgi_common.cgi_argument] |
|
| finalize [Netmime.mime_body_ro] |
After the body has been finalized, it cannot be accessed any longer.
|
| finalize [Netcgi1_compat.Netcgi_types.cgi_activation] |
|
| finalize [Netcgi1_compat.Netcgi_types.cgi_argument] |
|
| finalize [Netcgi.cgi] |
This method calls #finalize for every CGI argument
(including the possible one of PUT) to ensure that all files
are deleted.
|
| finalize [Netcgi.cgi_argument] |
Arguments stored in temp files must be deleted when the
argument is no longer used.
|
| finalize [Netcgi_common.cgi_argument] |
|
| finalize [Netcgi_common.cgi] |
|
| finish [Nethttpd_reactor.http_reactive_request] |
This method should be called after the request has been fully processed.
|
| finish_request [Nethttpd_reactor.http_reactive_request] |
Reads the rest of the body (if any), and discards that data
|
| fixup_request [Http_client.generic_call] |
This method is called just before sending the request.
|
| flavors [Rpc_server.auth_method] |
Which credential flavors are handled by this method
|
| float_param [Netplex_types.config_file] |
|
| flush [Netchannels.augment_raw_out_channel] |
As in raw_out_channel
|
| flush [Netchannels.rec_out_channel] |
If there is a write buffer, it will be flushed.
|
| flush [Uq_engines.async_out_channel] |
Flushes the channel.
|
| front_token [Nethttpd_kernel.http_response] |
The first token of the queue, represented as data_chunk.
|
| ftp_state [Ftp_client.ftp_client_pi] |
Returns the current ftp_state
|
G |
| generate_response [Nethttpd_types.http_service_generator] |
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_host [Http_client.http_call] |
|
