# Index of classes

A
augment_raw_in_channel [Netchannels] | This class implements the methods from `compl_in_channel` by calling the methods of `raw_in_channel`.
augment_raw_out_channel [Netchannels] | This class implements the methods from `compl_out_channel` by calling the methods of `raw_out_channel`.
B
basic_auth_handler [Http_client] | Basic authentication.
basic_auth_method [Http_client] | Deprecated.
basic_mime_header [Netmime] | An implementation of `mime_header`.
blocking_socket_config [Rpc_client] | blocking `connect` configuration as class
buffered_raw_in_channel [Netchannels] | This class adds a buffer to the underlying `raw_in_channel`.
buffered_raw_out_channel [Netchannels] | This class adds a buffer to the underlying `raw_out_channel`.
buffered_trans_channel [Netchannels] | A transactional output channel with a transaction buffer implemented in memory
buffering_engine_processing_config [Nethttpd_engine] | Implements the synchronisation by buffering
C
call_engine [Shell_uq] | This engine corresponds to `Shell.call`.
cgi [Netcgi_common] | `cgi env op meth args` constructs `Netcgi.cgi` objects.
cgi_environment [Netcgi_common] | `new cgi_environment ~config ~properties ~input_header out_obj` generates a `Netcgi.cgi_environment` object, from the arguments.
client [Netsmtp] |
client [Netpop] | The class `client` implements the POP3 protocol.
connect_method [Ftp_client] | This method connects to the `host` which must be an IP address
conversion_pipe [Netconversion] | This pipeline class (see `Netchannels` for more information) can be used to recode a netchannel while reading or writing.
copier [Uq_engines] | This engine copies data between file descriptors as specified by the `copy_task` argument.
D
data_converter [Ftp_data_endpoint] | Creates a data conversion pipe converting `fromrepr` to `torepr`.
decoding_pipe [Netencoding.QuotedPrintable] | This pipe decodes the data written into the pipe.
decoding_pipe [Netencoding.Base64] | This pipe decodes the data written into the pipe.
default_socket_config [Rpc_server] |
default_socket_config [Rpc_client] | Default configuration as class
delete [Http_client] | Argument: URI
delete_call [Http_client] |
delete_method [Ftp_client] | Deletes the named file
digest_auth_handler [Http_client] | Digest authentication.
digest_auth_method [Http_client] | Deprecated.
direct_socket_acceptor [Uq_engines] | An implementation of `server_socket_acceptor` for sockets
E
empty_environment [Nethttpd_types] | This class implements an environment with defined internal containers.
empty_processor_hooks [Netplex_kit] | This is an empty set of processor hooks, i.e.
encoding_pipe [Netencoding.QuotedPrintable] | This pipe encodes the data written into the pipe.
encoding_pipe [Netencoding.Base64] | This pipe encodes the data written into the pipe.
engine_mixin [Uq_engines] | A useful class fragment that implements `state` and `request_notification`.
epsilon_engine [Uq_engines] | This engine transitions from its initial state ``Working 0` in one step to the passed constant state.
F
file_mime_body [Netmime] | An implementation of `mime_body` where the value is stored in an external file.
ftp_client [Ftp_client] | The ftp client is a user session that may even span several connections.
ftp_client_pi [Ftp_client] | The client protocol interpreter...
ftp_data_receiver [Ftp_data_endpoint] | This engine receives data on a FTP data connection, and forwards them to a local receiver.
ftp_data_sender [Ftp_data_endpoint] | This engine sends data over a FTP data connection coming from a local sender.
G
generic_call [Http_client] | This class is an implementation of `http_call`.
get [Http_client] | Argument: URI
get_call [Http_client] |
get_method [Ftp_client] | This FTP method walks to the right directory and gets `file` from the server.
group [Netaddress] | A `group` has a name, and consists of a number of mailboxes.
gtk_event_system [Uq_gtk] | This class is an alternate implementation of the Unixqueue event systems for the Glib event loop.
H
head [Http_client] | Argument: URI
head_call [Http_client] |
http_engine [Nethttpd_engine] | This engine processes the requests arriving on the file descriptor using the Unix event system.
http_environment [Nethttpd_reactor] | For private use only
http_protocol [Nethttpd_kernel] | The core event loop of the HTTP daemon
http_reactor [Nethttpd_reactor] | The `http_reactor` allows one to pull the next request from a connected client, and to deliver the response to the protocol engine.
http_response_impl [Nethttpd_kernel] | Exported for debugging and testing only
I
in_obj_channel_delegation [Netchannels] |
input_async_descr [Uq_engines] | The corresponding class for asynchronous input channels.
input_async_mplex [Uq_engines] | Creates an asynchronous input channel reading from the multiplex controller.
input_channel [Netchannels] | Creates an input channel from an `in_channel`, which must be open.
input_command [Netchannels] | Runs the command with `/bin/sh`, and reads the data the command prints to stdout.
input_descr [Netchannels] | Creates a `raw_in_channel` for the passed file descriptor, which must be open for reading.
input_filter [Netchannels] | An `input_filter` filters the data read from it through the `io_obj_channel` (usually a `pipe` after the data have been retrieved from the passed `in_obj_channel`.
input_stream [Netstream] | Make an `in_obj_stream` on top of an `in_obj_channel`.
input_string [Netchannels] | Creates an input channel from a (constant) string.
invoke_method [Ftp_client] | This FTP method simply invokes `command`, and calls for all kinds of successful replies the function `process_result`, passing the ftp_state and the code and the reply text.
K
key_ring [Http_client] | The `key_ring` is a cache for keys.
L
lift_raw_out_channel [Netchannels] | This class implements the methods from `compl_out_channel` by calling the methods of `raw_out_channel`.
lift_rec_in_channel [Netchannels] | This class implements `pos_in` and the methods from `compl_in_channel` by calling the methods of `rec_in_channel`.
lift_rec_out_channel [Netchannels] | This class implements `pos_out` and the methods from `compl_out_channel` by calling the methods of `rec_out_channel`.
lingering_close [Nethttpd_kernel] | Closes a file descriptor using the "lingering close" algorithm.
list_method [Ftp_client] | Lists the contents of the directory `dir` using the LIST command.
login_method [Ftp_client] | This FTP method logs the `user` in.
M
mailbox [Netaddress] | A `mailbox` has a name, optionally a route (not used nowadays), and a formal address specification.
map_engine [Uq_engines] | The `map_engine` observes the argument engine, and when the state changes to ``Done`, ``Error`, or ``Aborted`, the corresponding mapping function is called, and the resulting state becomes the state of the mapped engine.
mdtm_method [Ftp_client] | Determines the date and time of the last modification of `file`.
memory_mime_body [Netmime] | An implementation of `mime_body` where the value is stored in-memory.
mime_arg [Netcgi_common] | See `Netcgi.Argument.mime`.
mime_argument [Netcgi1_compat.Netcgi] |
mime_argument [Netcgi] | Old deprecated MIME argument class.
mkdir_method [Ftp_client] | Creates the named directory
mp [Netplex_mp] | Uses `Unix.fork` to create new threads
mt [Netplex_mt] | Uses `Thread.create` to create new threads
N
nlst_method [Ftp_client] | Lists the contents of the directory `dir` using the NLST command The `representation` must not be ``Image`.
O
options [Http_client] | Argument: URI or "*"
options_call [Http_client] |
out_obj_channel_delegation [Netchannels] |
output_async_descr [Uq_engines] | This engine implements an `async_out_channel` for the output descriptor `dst`.
output_async_mplex [Uq_engines] | Creates an asynchronous output channel writing to the multiplex controller (see also `output_async_descr` for the corresponding class writing to a single descriptor).
output_buffer [Netchannels] | This output channel writes the data into the passed buffer.
output_channel [Netchannels] | Creates an output channel writing into an `out_channel`.
output_command [Netchannels] | Runs the command with `/bin/sh`, and data written to the channel is piped to stdin of the command.
output_descr [Netchannels] | Creates a `raw_out_channel` for the passed file descriptor, which must be open for writing.
output_filter [Netchannels] | An `output_filter` filters the data written to it through the `io_obj_channel` (usually a `pipe`), and writes the filtered data to the passed `out_obj_channel`.
output_netbuffer [Netchannels] | This output channel writes the data into the passed netbuffer.
output_null [Netchannels] | This output channel discards all written data.
P
pipe [Netchannels] | A `pipe` has two internal buffers (realized by Netbuffer).
pipeline [Http_client] | A pipeline is a queue of HTTP calls to perform
poll_engine [Uq_engines] | This engine waits until one of the passed operations can be carried out, or until one of the operations times out.
poll_process_engine [Uq_engines] | This engine waits until the process with the ID `pid` terminates.
post [Http_client] | Arguments: URI, parameter list to be transferred as application/x-www-form-urlencoded body
post_call [Http_client] |
post_raw [Http_client] | Arguments: URI, body
processor_base [Netplex_kit] | A virtual (incomplete) base class for processors.
proxy_client [Uq_socks5] | The object created by `new proxy_client addr` can be passed as `proxy` to the `Uq_engines.connector`, `Uq_engines.listener`, and `Uq_engines.datagram_provider` functions to use the SOCKS proxy for connections, servers, and datagram socket, respectively.
put [Http_client] | Arguments: URI, body
put_call [Http_client] |
R
raw_in_channel_delegation [Netchannels] |
raw_out_channel_delegation [Netchannels] |
read_in_record_channel [Ftp_data_endpoint] | Provides an `in_record_channel` that takes newline characters as EOR representation.
rec_in_channel_delegation [Netchannels] |
rec_out_channel_delegation [Netchannels] |
receiver [Uq_engines] | This engine copies all data from the `src` file descriptor to the `dst` output channel.
recoding_pipe [Netconversion] | Recodes a channel like `conversion_pipe`.
redirected_environment [Nethttpd_types] | This class overlays the input-side containers of an existing environment.
rename_method [Ftp_client] | Renames the `file_from` into `file_to`.
rmdir_method [Ftp_client] | Deletes the named directory
S
sender [Uq_engines] | This engine copies all data from the `src` input channel to the `dst` file descriptor.
seq_engine [Uq_engines] | This engine runs two engines in sequential order.
set_mode_method [Ftp_client] | Requests a certain mode for future file transfers
set_structure_method [Ftp_client] | Requests a certain structure for future file transfers
simple_arg [Netcgi_common] | See `Netcgi.Argument.simple`.
simple_argument [Netcgi1_compat.Netcgi] |
simple_argument [Netcgi] | Old deprecated simple argument class.
socket_descr [Netchannels] | Creates a `raw_io_channel` for the passed socket descriptor, which must be open for reading and writing, and not yet shut down in either direction.
ssl_client_socket_config [Rpc_ssl] | SSL configuration class for clients
ssl_server_socket_config [Rpc_ssl] | SSL configuration class for servers
std_activation [Netcgi1_compat.Netcgi] |
stream_rpc_multiplex_controller [Rpc_transport] | The class is exported for the SSL transporter
sub_stream [Netstream] | A sub stream is the part of the whole stream from the current position to an arbitrary other position that is determined by `len` and `delimiter`.
sync_engine [Uq_engines] | This engine runs two engines in parallel, and waits until both are ``Done` (synchronization).
system_handler_engine [Shell_uq] | This engine implements a `Shell_sys.system_handler`, and can be used to watch an already started `job_instance` as created by `Shell_sys.run_job` until the job is done.
T
tcl_event_system [Uq_tcl] | This class is an alternate implementation of the Unixqueue event systems for the TCL event loop.
telnet_session [Telnet_client] | A telnet session
tempfile_trans_channel [Netchannels] | A transactional output channel with a transaction buffer implemented as temporary file
trace [Http_client] | Arguments: URI, maximum number of hops
trace_call [Http_client] |
U
unix_event_system [Unixqueue] | The standalone implementation of an event system
W
walk_method [Ftp_client] | This FTP method walks to the target directory:
watchdog [Uq_engines] | A watchdog engine checks whether the argument engine makes progress, and if there is no progress for the passed number of seconds, the engine is aborted, and the watchdog state changes to ``Error Watchdog_timeout`.
write_out_record_channel [Ftp_data_endpoint] | Provides an `out_record_channel` that represents EOR as newline character.