Ocamlnet 3 Reference Manual : Index of class types

# Index of class types

A
async_in_channel [Uq_engines] | An asynchrounous input channel provides methods to input data from a stream descriptor.
async_in_channel_engine [Uq_engines] | Combination of engine + async_in_channel
async_out_channel [Uq_engines] | An asynchrounous output channel provides methods to output data to a stream descriptor.
async_out_channel_engine [Uq_engines] | Combination of engine + async_out_channel
auth_details [Rpc_server] |
auth_handler [Http_client] | An authentication handler has the capability of adding the necessary headers to messages.
auth_method [Rpc_server] |
auth_method [Rpc_client] | An `auth_method` object represents a method of authentication.
auth_protocol [Rpc_client] | An authentication protocol is used for creating an authentication session.
auth_session [Rpc_client] | An `auth_session` object is normally created for every client instance.
auth_session [Http_client] | An `auth_session` represents an authenticated session
C
cache_t [Uq_engines] | A cache contains a mutable value that is obtained by running an engine.
cgi [Netcgi_fcgi] | The usual `Netcgi.cgi` class with FCGI specific methods.
cgi [Netcgi] | Object symbolizing a CGI-like request/response cycle.
cgi [Netcgi_apache] | The usual `cgi` class with an additional method to access Apache specificities.
cgi_activation [Netcgi1_compat.Netcgi_types] | Portage: In addition to defining a type, the following `cgi_activation` also defines a conversion function that allows to connect old scripts to the new infrastructure.
cgi_activation [Netcgi] | Alternate, more descriptive name for `cgi`
cgi_argument [Netcgi1_compat.Netcgi_types] | Portage: In addition to defining a type, the following `cgi_argument` also defines a conversion function that allows to connect old scripts to the new infrastructure.
cgi_argument [Netcgi] | Represent a key-value pair of data passed to the script (including file uploads).
cgi_argument [Netcgi_common] | See `Netcgi.cgi_argument`.
cgi_environment [Netcgi1_compat.Netcgi_env] |
cgi_environment [Netcgi] | The environment of a request consists of the information available besides the data sent by the user (as key-value pairs).
client_endpoint_connector [Uq_engines] | This class type provides engines to connect to a service.
client_key_ring [Netmech_scram_gssapi] | A `client_key_ring` identifies the user on the client side
client_socket_connector [Uq_engines] | For backward compatibility.
compl_in_channel [Netchannels] | Further methods usually supported by ocamlnet channel implementations.
compl_out_channel [Netchannels] | Further methods usually supported by ocamlnet channel implementations.
compute_resource [Netmcore] |
condition [Netsys_oothr] |
config_file [Netplex_types] |
connection_cache [Http_client_conncache] |
container [Netplex_types] | Containers encapsulate the control flow of the service components.
controller [Netplex_types] | The controller is the object in the Netplex master process/thread that manages the containers, logging, and service definitions
controller_config [Netplex_types] |
ctrl_message_receiver [Netplex_types] |
D
datagram_multiplex_controller [Uq_engines] | Additional methods for unconnected datagram handling
datagram_socket_provider [Uq_engines] | This is a factory for `wrapped_datagram_socket` objects.
dynamic_workload_config [Netplex_workload] |
E
engine [Uq_engines] | This class type defines the interface an engine must support.
engine [Uq_resolver] |
enhanced_raw_in_channel [Netchannels] | Defines private methods reading text line by line
error_response_params [Nethttpd_types] |
event_system [Unixqueue] | The `event_system` manages events, handlers, resources, groups, etc.
extended_async_environment [Nethttpd_engine] |
extended_environment [Nethttpd_types] | Same as `v_extended_environment`, but no virtual methods
F
ftp_client_pi [Ftp_client] | The client protocol interpreter...
ftp_data_engine [Ftp_data_endpoint] | The common type of FTP data engines
ftp_stream_fs [Ftp_fs] |
full_info [Nethttpd_types] |
G
generic_config [Netplex_log] |
glob_fsys [Netglob] | Filesystem primitives.
gss_api [Netgssapi] |
H
http_call [Http_client] | The container for HTTP calls
http_engine_config [Nethttpd_engine] |
http_engine_processing_config [Nethttpd_engine] |
http_engine_processing_context [Nethttpd_engine] |
http_header [Nethttp] |
http_header_ro [Nethttp] | The HTTP header is represented as MIME header
http_processor_config [Nethttpd_reactor] |
http_protocol_config [Nethttpd_kernel] | Configuration values for the HTTP kernel
http_reactive_request [Nethttpd_reactor] |
http_reactor_config [Nethttpd_reactor] |
http_request_header_notification [Nethttpd_engine] |
http_request_notification [Nethttpd_engine] |
http_response [Nethttpd_kernel] | Encapsultation of the HTTP response for a single request
http_service [Nethttpd_types] |
http_service_generator [Nethttpd_types] |
http_service_receiver [Nethttpd_types] |
http_stream_fs [Http_fs] |
http_trailer [Nethttp] |
http_trailer_ro [Nethttp] | The HTTP trailer is represented as MIME header
I
in_obj_channel [Netchannels] | The application-level input channel supports raw and complemented methods
in_obj_stream [Netstream] | An `in_obj_stream` extends `in_obj_channel` by look-ahead methods
in_record_channel [Ftp_data_endpoint] | An `in_record_channel` can be used to read files with record structure.
internal_environment [Nethttpd_reactor] | For private use only
io_obj_channel [Netchannels] | A channel supporting both input and output.
J
job_handler_engine_type [Shell_uq] | This type of engine also returns the `job` and the `job_instance`.
job_handler_engine_type [Shell_sys] | This type of engine also returns the `job` and the `job_instance`.
K
key [Http_client] | A `key` is a user/password combination for a certain realm
key_handler [Http_client] |
L
local_file [Netfs] |
logger [Netplex_types] | A logger receives log messages
logger_factory [Netplex_types] |
M
mime_body [Netmime] | A MIME body with both read and write method.
mime_body_ro [Netmime] | This is the read-only version of a MIME body.
mime_header [Netmime] | A MIME header with both read and write method.
mime_header_ro [Netmime] | This is the read-only version of a MIME header.
min_config [Nethttpd_types] | Minimal configuration needed for `output_std_response`
mstring [Xdr_mstring] | The object holding the string value
mstring_factory [Xdr_mstring] | The object creating new `mstring` objects
mtprovider [Netsys_oothr] |
multi_file_config [Netplex_log] |
multiplex_controller [Uq_engines] | A `multiplex_controller` is a quite low-level device to abstract bidirectional socket connections.
mutex [Netsys_oothr] |
N
netplex_config [Netplex_types] |
O
out_obj_channel [Netchannels] | The application-level output channel supports raw and complemented methods
out_record_channel [Ftp_data_endpoint] | An `out_record_channel` can be used to output files with record structure.
P
par_thread [Netplex_types] |
parallelizer [Netplex_types] |
plugin [Netplex_types] | Plugins are extensions of the Netplex system that run in the controller and can be invoked from containers
pmanage [Netsys_pmanage] |
pollset [Netsys_pollset] |
post_fork_handler [Netsys_posix] | A `post_fork_handler` is a named function `unit -> unit`
prioritizer_t [Uq_engines] | A prioritizer allows to prioritize the execution of engines: At any time, only engines of a certain priority `p` can be executed.
processor [Netplex_types] | The processor is the object that is notified when a new TCP connection is accepted.
processor_factory [Netplex_types] |
processor_hooks [Netplex_types] | Processor hooks can be used to modify the behavior of a processor.
protocol [Netplex_types] |
R
raw_in_channel [Netchannels] | Basic Unix-level class type for input channels as used by ocamlnet.
raw_io_channel [Netchannels] | A channel supporting both input and output.
raw_out_channel [Netchannels] | Basic Unix-level class type for output channels as used by ocamlnet.
rec_in_channel [Netchannels] | Recommended input class type for library interoperability.
rec_out_channel [Netchannels] | Recommended output class type for library interoperability.
request_info [Nethttpd_types] |
resolver [Uq_resolver] |
rpc_multiplex_controller [Rpc_transport] |
rw_cgi_argument [Netcgi] | Old deprecated writable argument type.
rw_cgi_argument [Netcgi_common] | See `Netcgi.rw_cgi_argument`.
S
sb_event_system [Unixqueue_select] |
serializer_t [Uq_engines] | A serializer queues up engines, and starts the next engine when the previous one finishes.
server_endpoint_acceptor [Uq_engines] | This class type is for service providers that listen for connections.
server_endpoint_listener [Uq_engines] | This class type represents factories for service providers
server_key_verifier [Netmech_scram_gssapi] | A `server_key_verifier` verifies on the server side that the users exist and have the right authentication credentials
server_socket_acceptor [Uq_engines] | For backward compatibility.
server_socket_listener [Uq_engines] | For backward compatibility.
shell_stream_fs [Shell_fs] |
simple_message [Netcgi1_compat.Netcgi_types] |
socket_config [Rpc_server] |
socket_config [Rpc_client] | Configuration for ``Socket` (see below).
socket_controller [Netplex_types] |
socket_service [Netplex_types] |
socket_service_config [Netplex_types] |
ssl_multiplex_controller [Uq_ssl] | The `ssl_multiplex_controller` is an extended multiplex controller which can also control SSL handshakes.
stream_fs [Netfs] |
syslog_config [Netplex_log] |
T
thread [Netsys_oothr] |
trans_out_obj_channel [Netchannels] | A transactional output channel has a buffer for uncommitted data.
transport_channel_type [Http_client] |
transport_channel_type [Https_client] | Same as `Http_client.transport_channel_type`
U
user_info [Netglob] | Access to the user database
V
v_extended_environment [Nethttpd_types] | An extension of `cgi_environment` for use with the daemon.
v_processor [Netplex_kit] | Same as `processor`, but the methods `process` and `supported_ptypes` are flagged as `virtual`
W
workload_manager [Netplex_types] | See `Netplex_workload` for definitions of workload managers
workload_manager_factory [Netplex_types] |
wrapped_datagram_socket [Uq_engines] | A `wrapped_datagram_socket` allows datagrams to be sent via proxies.