Index of class methods


A
abort [Nethttpd_kernel.http_protocol]
Stops the transmission of data.
accept_body [Nethttpd_reactor.http_reactive_request]
Call this method to unlock the body channels.
advance [Nethttpd_kernel.http_response]
Tell this object that n bytes of the front token could be really sent using Unix.write.
apop [Netpop.client]
Specifies the user and password using APOP authentication.
argument [Netcgi_types.cgi_activation]
Returns a certain current argument, or raises Not_found
argument_value [Netcgi_types.cgi_activation]
Returns the value of the current argument as string.
arguments [Netcgi_types.cgi_activation]
The complete list of current arguments

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

C
cgi_auth_type [Netcgi_env.cgi_environment]
cgi_gateway_interface [Netcgi_env.cgi_environment]
cgi_https [Netcgi_env.cgi_environment]
A well-known extension is the HTTPS property.
cgi_path_info [Netcgi_env.cgi_environment]
cgi_path_translated [Netcgi_env.cgi_environment]
cgi_properties [Netcgi_env.cgi_environment]
All properties
cgi_property [Netcgi_env.cgi_environment]
Returns a (possibly non-standard) environment property.
cgi_query_string [Netcgi_env.cgi_environment]
cgi_remote_addr [Netcgi_env.cgi_environment]
cgi_remote_host [Netcgi_env.cgi_environment]
cgi_remote_ident [Netcgi_env.cgi_environment]
cgi_remote_user [Netcgi_env.cgi_environment]
cgi_request_method [Netcgi_env.cgi_environment]
cgi_request_uri [Netcgi_env.cgi_environment]
This is the URI path as passed in the HTTP request, without preprocessing
cgi_script_name [Netcgi_env.cgi_environment]
cgi_server_name [Netcgi_env.cgi_environment]
cgi_server_port [Netcgi_env.cgi_environment]
cgi_server_protocol [Netcgi_env.cgi_environment]
cgi_server_software [Netcgi_env.cgi_environment]
charset [Netcgi_types.cgi_argument]
The charset parameter of the content type of the header, or "" when there is no such parameter, or no header.
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_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.
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 [Netcgi_env.cgi_environment]
The CGI configuration
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.
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 [Netcgi_types.cgi_argument]
Returns the content type of the header, or "text/plain" when the header is missing.
content_type [Netmime.mime_header_ro]
Returns the Content-type as parsed value.
content_type_params [Netcgi_types.cgi_argument]
The parameters of the content type of the header, or [] when the header is missing.
cookies [Netcgi_env.cgi_environment]
Returns the list of cookies found in the request header
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.
def_term [Nethttpd_types.http_service]
The definition term
dele [Netpop.client]
Marks the message number of the current mailbox for deletion.
delete_argument [Netcgi_types.cgi_activation]
Deletes all arguments with the passed name.
delete_field [Netmime.mime_header]
These methods modify the fields of the header.
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

E
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 [Netcgi_types.cgi_activation]
The CGI environment object.
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
field [Netmime.mime_header_ro]
fields [Netmime.mime_header_ro]
filename [Netcgi_types.cgi_argument]
The filename parameter found in the header of file uploads.
finalize [Netcgi_types.cgi_activation]
This method calls finalize for every CGI argument to ensure that all files are deleted.
finalize [Netcgi_types.cgi_argument]
Arguments stored in temp files must be deleted when the argument is no longer used.
finalize [Netmime.mime_body_ro]
After the body has been finalized, it cannot be accessed any longer.
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
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.
front_token [Nethttpd_kernel.http_response]
The first token of the queue, represented as data_chunk.

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.

H
helo [Netsmtp.client]
Sends an HELLO command to the server.
help [Netsmtp.client]
Performs the Help command.

I
initial_argument [Netcgi_types.cgi_activation]
Returns a certain initial argument, or raises Not_found
initial_argument_value [Netcgi_types.cgi_activation]
Returns the value of the initial argument as string.
initial_arguments [Netcgi_types.cgi_activation]
The complete list of initial arguments
initial_multiple_argument [Netcgi_types.cgi_activation]
Returns a certain initial argument that occurs several times in the set of arguments
input [Netchannels.augment_raw_in_channel]
As in raw_in_channel
input [Netchannels.rec_in_channel]
Reads octets from the channel and puts them into the string.
input_byte [Netchannels.compl_in_channel]
Reads exactly one octet from the channel and returns its code, or raises End_of_file
input_ch [Netcgi_env.cgi_environment]
The input channel as such
input_ch_async [Nethttpd_engine.extended_async_environment]
This is the input_ch channel taken as asynchonous channel.
input_char [Netchannels.compl_in_channel]
Reads exactly one character from the channel, or raises End_of_file
input_content_length [Netcgi_env.cgi_environment]
Returns the "Content-length" request header field, or raises Not_found if it is not set
input_content_type [Netcgi_env.cgi_environment]
Returns the parsed "Content-type" request header field, or raises Not_found if it is not set.
input_content_type_string [Netcgi_env.cgi_environment]
Returns the "Content-type" request header field or "" if it is not set
input_header [Netcgi_env.cgi_environment]
The whole header
input_header_field [Netcgi_env.cgi_environment]
Returns the value of a field of the request header.
input_header_fields [Netcgi_env.cgi_environment]
Returns the input header as (name,value) pairs.
input_line [Netchannels.compl_in_channel]
Reads the next line from the channel.
input_state [Netcgi_env.cgi_environment]
Returns the current input state
input_timeout_class [Nethttpd_kernel.http_protocol]
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

L
lingering [Nethttpd_kernel.lingering_close]
Whether the socket is still lingering
list [Netpop.client]
Returns the scan listing for an optional message number or for all messages in the current mailbox.
log_error [Netcgi_env.cgi_environment]
Outputs a log message to the error log.

M
mail [Netsmtp.client]
Performs a MAIL FROM command.
mailboxes [Netaddress.group]
The member mailboxes
multiple_argument [Netcgi_types.cgi_activation]
Returns a certain current argument that occurs several times in the set of arguments
multiple_field [Netmime.mime_header_ro]
The current fields of the header.
multiple_input_header_field [Netcgi_env.cgi_environment]
Returns the values of all fields with the passed name of the request header.
multiple_output_header_field [Netcgi_env.cgi_environment]
Returns the values of all fields with the passed name of the repsonse header.

N
name [Nethttpd_types.http_service]
The name of the type of the service provider
name [Netcgi_types.cgi_argument]
The name of the CGI argument
name [Netaddress.group]
The name of the group
name [Netaddress.mailbox]
The name of the mailbox.
need_linger [Nethttpd_kernel.http_protocol]
Returns true when a lingering close operation is needed to reliably shut down the socket.
next_request [Nethttpd_reactor.http_reactor]
Tries to read the next request.
noop [Netsmtp.client]
NOOP : does nothing, keeps the connection alive.
noop [Netpop.client]
Pings the server to keep the session alive.

O
open_value_rd [Netcgi_types.cgi_argument]
Opens the contents of the value as an input channel.
open_value_rd [Netmime.mime_body_ro]
Opens the value for reading.
open_value_wr [Netcgi_types.cgi_argument]
Opens the value for writing.
open_value_wr [Netmime.mime_body]
Opens the value for writing.
output [Netcgi_types.cgi_activation]
The output channel to which the generated content is intended to be written.
output [Netchannels.augment_raw_out_channel]
As in raw_out_channel
output [Netchannels.rec_out_channel]
Takes octets from the string and writes them into the channel.
output_buffer [Netchannels.compl_out_channel]
Writes exactly the contents of the buffer
output_byte [Netchannels.compl_out_channel]
Writes exactly one byte passed as integer code
output_ch [Netcgi_env.cgi_environment]
The output channel as such
output_ch_async [Nethttpd_engine.extended_async_environment]
This is the output_ch channel taken as asynchronous channel.
output_channel [Netchannels.compl_out_channel]
Writes the contents of an in_obj_channel until the end of the input channel is reached.
output_char [Netchannels.compl_out_channel]
Writes exactly one character
output_header [Netcgi_env.cgi_environment]
The whole response header
output_header_field [Netcgi_env.cgi_environment]
Returns the value of a field of the response header.
output_header_fields [Netcgi_env.cgi_environment]
Returns the output header as (name,value) pairs.
output_state [Netcgi_env.cgi_environment]
Returns the output state
output_string [Netchannels.compl_out_channel]
Writes exactly the passed string

P
pass [Netpop.client]
Authenticates a user with the plain-text password pass.
peek_recv [Nethttpd_kernel.http_protocol]
Peeks the first token, but leaves it in the queue.
pipeline_len [Nethttpd_kernel.http_protocol]
Returns the number of unanswered requests = Number of received `Req_end tokens minus number of responses in state `Processed.
pos_in [Netchannels.augment_raw_in_channel]
As in raw_in_channel
pos_in [Netchannels.raw_in_channel]
Returns the current channel position.
pos_out [Netchannels.augment_raw_out_channel]
As in raw_out_channel
pos_out [Netchannels.raw_out_channel]
Returns the current channel position.
print [Nethttpd_types.http_service]
Outputs the definition term to a formatter
process_body [Nethttpd_types.http_service_receiver]
Second stage of HTTP processing: This method is called when the body is expected to be arriving.
process_header [Nethttpd_types.http_service]
First stage of HTTP processing: This method is called when the HTTP header has been received.
protocol [Nethttpd_kernel.http_response]
The HTTP version of the response.
protocol [Netcgi_env.cgi_environment]

Q
quit [Netsmtp.client]
Requests the server to end this session.
quit [Netpop.client]
Requests the server to end this session.

R
rcpt [Netsmtp.client]
Performs a RCPT TO command.
really_input [Netchannels.compl_in_channel]
Reads exactly as many octets from the channel as the second int argument specifies.
really_output [Netchannels.compl_out_channel]
Writes exactly as many octets to the channel as the second int argument specifies.
receive [Nethttpd_kernel.http_protocol]
Returns the first req_token from the receive queue.
recv_queue_byte_size [Nethttpd_kernel.http_protocol]
Returns the (estimated) size of the input queue in bytes
recv_queue_len [Nethttpd_kernel.http_protocol]
Returns the length of the receive queue (number of tokens)
reject_body [Nethttpd_reactor.http_reactive_request]
Call this method to unlock the body channels.
remote_socket_addr [Nethttpd_types.v_extended_environment]
These are always the physical IP addresses and ports of the two endpoints of the current connection.
remote_socket_addr [Nethttpd_types.extended_environment]
representation [Netcgi_types.cgi_argument]
The representation of the CGI argument
req_method [Nethttpd_reactor.internal_environment]
req_state [Nethttpd_engine.http_request_notification]
Returns the request processing state which is `Received_request at the moment when this notification is delivered.
req_state [Nethttpd_engine.http_request_header_notification]
Returns the request processing state which is `Received_header at the moment when this notification is delivered.
request_method [Netcgi_types.cgi_activation]
The HTTP method
resp_queue_len [Nethttpd_kernel.http_protocol]
Returns the length of the internal response queue (number of http_response objects that have not yet fully processed)
response [Nethttpd_reactor.internal_environment]
retr [Netpop.client]
Retrieves a message from the server.
ro [Netcgi_types.cgi_argument]
Whether this argument is read-only or not
ro [Netmime.mime_body]
whether this body is read-only or not
ro [Netmime.mime_header]
whether the header is read-only or not
rollback_work [Netchannels.trans_out_obj_channel]
Empties the transaction buffer
route [Netaddress.mailbox]
The route to the mailbox
rset [Netsmtp.client]
Reset the current transaction
rset [Netpop.client]
Unmarks any messages that have previously been marked as deleted.

S
schedule_accept_body [Nethttpd_engine.http_request_header_notification]
Schedules that the request body is accepted.
schedule_finish [Nethttpd_engine.http_request_notification]
Schedules that the request is finished.
schedule_finish [Nethttpd_engine.http_request_header_notification]
Schedules that the request is finished.
schedule_reject_body [Nethttpd_engine.http_request_header_notification]
Schedules that the request body is rejected.
send [Nethttpd_kernel.http_response]
Add token to the end of the send queue
send_file [Nethttpd_types.v_extended_environment]
Sends the output header with a file as body.
send_output_header [Netcgi_env.cgi_environment]
If the output state is `Start, this method will encode and send the output header to the output channel, and the state will be changed to `Sent_header.
send_queue_empty [Nethttpd_kernel.http_response]
Return whether the send queue is empty.
server_socket_addr [Nethttpd_types.v_extended_environment]
server_socket_addr [Nethttpd_types.extended_environment]
set_arguments [Netcgi_types.cgi_activation]
Replaces the set of current arguments with a new set.
set_callback [Nethttpd_kernel.http_response]
The function will be called when either set_state changes the state, or when the send queue becomes empty.
set_cgi [Netcgi_env.custom_environment]
Sets CGI properties
set_error_log [Netcgi_env.custom_environment]
Sets the error log function (prerr_endline by default)
set_fields [Netmime.mime_header]
set_header [Netcgi_types.cgi_activation]
Sets the header.
set_input_ch [Netcgi_env.custom_environment]
Sets the input channel to use
set_input_content_length [Netcgi_env.custom_environment]
Sets the input content length.
set_input_content_type [Netcgi_env.custom_environment]
Sets the input content type.
set_input_header_field [Netcgi_env.custom_environment]
Sets a request header field
set_input_header_fields [Netcgi_env.custom_environment]
Sets all request header fields at once
set_input_state [Netcgi_env.cgi_environment]
Sets the input state.
set_multiple_input_header_field [Netcgi_env.custom_environment]
Sets a request header field to a multiple value
set_multiple_output_header_field [Netcgi_env.cgi_environment]
Sets multiple values of a field of the response header.
set_output_ch [Netcgi_env.custom_environment]
Sets the output channel to use
set_output_header_field [Netcgi_env.cgi_environment]
Sets the value of a field of the response header.
set_output_header_fields [Netcgi_env.cgi_environment]
Sets the complete repsonse header at once.
set_output_state [Netcgi_env.cgi_environment]
Sets the output state.
set_redirection_header [Netcgi_types.cgi_activation]
Sets the header such that a redirection to the specified URL is performed.
set_state [Nethttpd_kernel.http_response]
Sets the state
set_status [Netcgi_env.cgi_environment]
Sets the response status.
set_value [Netcgi_types.cgi_argument]
If the representation supports mutable values, the value is set to the passed string.
set_value [Netmime.mime_body]
Sets the value.
setup_finished [Netcgi_env.custom_environment]
Finishes the setup.
shutdown [Nethttpd_kernel.http_protocol]
Shuts the socket down.
skip [Netstream.in_obj_stream]
Skip the n bytes of the stream.
spec [Netaddress.mailbox]
The formal address specification
stat [Netpop.client]
Returns information about the current mailbox as tuple (count,size,ext) where count is the number of messages in the mailbox, size is the size of the mailbox in octets, and ext is any server extension data.
state [Nethttpd_kernel.http_response]
Reports the state.
state [Netpop.client]
Current state of this session.
store [Netcgi_types.cgi_argument]
Returns where the argument value is stored
store [Netmime.mime_body_ro]
Where the body is actually stored.

T
test_coverage [Nethttpd_kernel.http_protocol]
For testing: returns a list of tokens indicating into which cases the program ran.
timeout [Nethttpd_kernel.http_protocol]
Process a timeout condition as cycle does
top [Netpop.client]
Returns the message header plus a limited number of lines of the message body.
transfer_encoding [Nethttpd_kernel.http_response]
Returns the selected transfer encoding.

U
uidl [Netpop.client]
Returns the unique identifier(s) for an optional message number or for all messages in the current mailbox.
unlock [Nethttpd_reactor.internal_environment]
update_argument [Netcgi_types.cgi_activation]
The passed argument replaces the current argument (or multiple argument) with the same name; if there is no such argument, the passed argument is added to the list of current args
update_field [Netmime.mime_header]
update_multiple_argument [Netcgi_types.cgi_activation]
The passed arguments must all have the same name.
update_multiple_field [Netmime.mime_header]
url [Netcgi_types.cgi_activation]
Returns the URL of the current CGI activation.
user [Netpop.client]
Specifies the name of the mailbox the client would like to open using plain-text authentication.
user_agent [Netcgi_env.cgi_environment]
Returns the "User-agent" field of the request header

V
value [Netcgi_types.cgi_argument]
The value of the CGI argument, after all transfer encodings have been removed.
value [Netmime.mime_body_ro]
The value method returns the _decoded_ body, i.e.

W
waiting_for_next_message [Nethttpd_kernel.http_protocol]
Whether the kernel is currently waiting for the beginning of a new arriving HTTP request.
want [Netstream.in_obj_stream]
Increases the length of the window such that the length is at least the passed number of bytes or that the window reaches EOF (whatever happens first).
want_another_block [Netstream.in_obj_stream]
The same as: want block_size
window [Netstream.in_obj_stream]
The look-ahead window.
window_at_eof [Netstream.in_obj_stream]
Whether the window is at eof
window_length [Netstream.in_obj_stream]
Returns the length of the window