Index of class methods


A
add [Http_client.pipeline]
Adds the call to the end of the pipeline.
add [Ftp_client.ftp_client]
Adds an FTP method to the queue of methods to execute.
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_cmd [Ftp_client.ftp_client_pi]
Add another command to the queue.
add_key [Http_client.key_ring]
Adds a key to the ring
add_with_callback [Http_client.pipeline]
Adds the call to the end of the pipeline.
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.
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 [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.

C
clear [Http_client.key_ring]
Deletes all keys from this key ring
connect [Ftp_client.ftp_method]
The host and port the FTP method wants to be connected to.
connection_cache [Http_client.pipeline]
The current connection cache.
create_session [Http_client.auth_handler]
Create a new authentication session.

D
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:
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
dest_status [Http_client.http_call]
Returns the status line of the last response (but status lines with code 100 are ignored).
disable_local_option [Telnet_client.telnet_session]
disable_remote_option [Telnet_client.telnet_session]
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_local_option [Telnet_client.telnet_session]
enable_remote_option [Telnet_client.telnet_session]
execute [Ftp_client.ftp_method]
This method is called when the ftp_client_pi is connected and the queue of commands is empty.

F
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.
fixup_request [Http_client.generic_call]
This method is called just before sending the request.

G
get_host [Http_client.http_call]
The host name of the content server, extracted from the URI
get_local_option [Telnet_client.telnet_session]
get_options [Telnet_client.telnet_session]
Get the configuration options.
get_options [Http_client.pipeline]
get_path [Http_client.http_call]
The path extracted from the URI
get_port [Http_client.http_call]
The port number of the content server, extracted from the URI
get_reconnect_mode [Http_client.http_call]
Get what to do if the server needs to be reconnected, i.e.
get_redirect_mode [Http_client.http_call]
By default, the redirect mode is Redirect_if_idem.
get_remote_option [Telnet_client.telnet_session]
get_req_body [Http_client.http_call]
What has been sent as body in the (last) request.
get_req_header [Http_client.http_call]
Deprecated.
get_req_method [Http_client.http_call]
Get the name of the request method.
get_resp_body [Http_client.http_call]
Deprecated.
get_resp_header [Http_client.http_call]
Deprecated.
get_uri [Http_client.http_call]
the full URI of this message: http://server:port/path.

H
has_req_body [Http_client.http_call]
Whether the method allows to send a request body
has_resp_body [Http_client.http_call]
Whether the method allows to reply with a body.

I
input_eor [Ftp_data_endpoint.in_record_channel]
Skips over the remaining data of the current record and the record boundary to the next record.
input_queue [Telnet_client.telnet_session]
The queue of commands received from the remote side.
inquire_key [Http_client.key_handler]
The method is called when a new session must be authenticated.
invalidate [Http_client.auth_session]
The session is notified that authentication failed.
invalidate_key [Http_client.key_handler]
The handler is notified that authentication failed for this key
is_idempotent [Http_client.http_call]
Whether the method is to be considered as idempotent ( = repeated invocations have the same result and no side effect).
is_proxy_allowed [Http_client.http_call]
Deprecated.
is_served [Http_client.http_call]
true if request/response cycle(s) have been finished, i.e.

K
keys [Http_client.key_ring]
List of all known keys

L
local_receiver [Ftp_data_endpoint.ftp_data_receiver]
The local receiver.
local_sender [Ftp_data_endpoint.ftp_data_sender]
The local sender.

N
name [Http_client.basic_auth_method]
no_proxy [Http_client.http_call]
Same as set_proxy_enabled false
number_of_open_connections [Http_client.pipeline]
Returns the number of connections which are open at the same time and currently being used by this object (i.e.
number_of_open_messages [Http_client.pipeline]
Returns the number of messages which are still in the pipeline.

O
offer_local_option [Telnet_client.telnet_session]
option_negotiation_is_over [Telnet_client.telnet_session]
output_eor [Ftp_data_endpoint.out_record_channel]
Finishes the current record.
output_queue [Telnet_client.telnet_session]
The queue of commands to send to the remote side.

P
password [Http_client.key]
The password in cleartext
private_api [Http_client.http_call]
process_option_command [Telnet_client.telnet_session]
proxy_enabled [Http_client.http_call]
Returns the proxy mode

R
realm [Http_client.key]
The realm
request_body [Http_client.http_call]
The whole body of the request
request_header [Http_client.http_call]
The whole header of the request.
request_method [Http_client.http_call]
The HTTP method as string
request_remote_option [Telnet_client.telnet_session]
request_uri [Http_client.http_call]
The request URI as string.
reset [Telnet_client.telnet_session]
Closes the connection immediately and empties all queues.
reset [Http_client.pipeline]
Empties the pipeline and inactivates any open connection.
reset_local_option [Telnet_client.telnet_session]
reset_remote_option [Telnet_client.telnet_session]
response_body [Http_client.http_call]
The whole body of the response.
response_body_storage [Http_client.http_call]
How to create the response body.
response_header [Http_client.http_call]
The whole header of the response.
response_protocol [Http_client.http_call]
The HTTP version indicated in the response
response_status_code [Http_client.http_call]
The three-digit status code
response_status_text [Http_client.http_call]
The text transmitted along with the code
run [Telnet_client.telnet_session]
Run the event system
run [Http_client.pipeline]
Runs through the requests in the pipeline.
run [Ftp_client.ftp_client]
Starts the event system; same as Unixqueue.run
run [Ftp_client.ftp_client_pi]
Starts the event system; same as Unixqueue.run

S
same_call [Http_client.http_call]
This method returns a new object that will perform the same call as this object (this function is called "reload" in browsers).
send_abort [Ftp_client.ftp_client_pi]
Sends immediately an ABOR command, even when a data transfer is in progress.
send_synch [Telnet_client.telnet_session]
At the next output oppurtunity, a Synch sequence is sent to the remote peer.
set_callback [Telnet_client.telnet_session]
Sets the callback function.
set_connection [Telnet_client.telnet_session]
Sets the host name and the port of the remote server to contact.
set_connection_cache [Http_client.pipeline]
Set the connection cache.
set_event_system [Telnet_client.telnet_session]
Sets the event system to use.
set_event_system [Http_client.pipeline]
set_exception_handler [Telnet_client.telnet_session]
Sets the exception handler.
set_options [Telnet_client.telnet_session]
Set the configuration options.
set_options [Http_client.pipeline]
Get/Set the available options for the HTTP engine.
set_proxy [Http_client.pipeline]
set_proxy name port: sets that a proxy name listening on port is to be used
set_proxy_auth [Http_client.pipeline]
sets user and password for the proxy.
set_proxy_enabled [Http_client.http_call]
Sets the proxy mode
set_proxy_from_environment [Http_client.pipeline]
Inspect the environment variables http_proxy and no_proxy and set the proxy options from them.
set_realm [Http_client.basic_auth_method]
set_reconnect_mode [Http_client.http_call]
Sets the reconnect mode
set_redirect_mode [Http_client.http_call]
Sets the redirect mode
set_req_header [Http_client.http_call]
set_request_body [Http_client.http_call]
Replaces the whole body object
set_request_header [Http_client.http_call]
Replaces the whole `Base header object
set_request_uri [Http_client.http_call]
Sets the request URI
set_response_body_storage [Http_client.http_call]
Sets how to create the response body
state [Ftp_client.ftp_client_pi]
Returns the current state
status [Http_client.http_call]
The condensed status

U
update [Telnet_client.telnet_session]
If there are commands in the output queue, the event system is signaled that this client wants to do network I/O.
user [Http_client.key]
The user name