Index of class methods


A
accept [Netcgi.container]
argument [Netcgi_common.cgi]
argument [Netcgi.cgi]
#argument name returns the value of the argument named name.
argument_exists [Netcgi_common.cgi]
argument_exists [Netcgi.cgi]
#argument_exists returns false if the named parameter is missing and true otherwise.
argument_value [Netcgi_common.cgi]
argument_value [Netcgi.cgi]
#argument_value returns the value of the argument as a string.
arguments [Netcgi_common.cgi]
arguments [Netcgi.cgi]
The complete list of arguments.
at_exit [Netcgi_common.cgi]
at_exit [Netcgi.cgi]
#at_exit f registers the function f to be executed when #finalize is called (which is the case the request finishes).

B
broadcast [Netcgi.container]

C
cgi_auth_type [Netcgi_common.cgi_environment]
cgi_auth_type [Netcgi.cgi_environment]
cgi_gateway_interface [Netcgi_common.cgi_environment]
cgi_gateway_interface [Netcgi.cgi_environment]
cgi_https [Netcgi_common.cgi_environment]
cgi_https [Netcgi.cgi_environment]
A well-known extension is the HTTPS property.
cgi_path_info [Netcgi_common.cgi_environment]
cgi_path_info [Netcgi.cgi_environment]
cgi_path_translated [Netcgi_common.cgi_environment]
cgi_path_translated [Netcgi.cgi_environment]
cgi_properties [Netcgi_common.cgi_environment]
Return the parameter properties.
cgi_properties [Netcgi.cgi_environment]
Return all properties as an associative list.
cgi_property [Netcgi_common.cgi_environment]
cgi_property [Netcgi.cgi_environment]
Returns a (possibly non-standard) CGI environment property.
cgi_query_string [Netcgi_common.cgi_environment]
cgi_query_string [Netcgi.cgi_environment]
This is the row query string.
cgi_remote_addr [Netcgi_common.cgi_environment]
cgi_remote_addr [Netcgi.cgi_environment]
cgi_remote_host [Netcgi_common.cgi_environment]
cgi_remote_host [Netcgi.cgi_environment]
cgi_remote_ident [Netcgi_common.cgi_environment]
cgi_remote_ident [Netcgi.cgi_environment]
cgi_remote_user [Netcgi_common.cgi_environment]
cgi_remote_user [Netcgi.cgi_environment]
cgi_request_method [Netcgi_common.cgi_environment]
cgi_request_method [Netcgi.cgi_environment]
We recommend you to use the method Netcgi.cgi.request_method which is more type-safe and informative.
cgi_script_name [Netcgi_common.cgi_environment]
cgi_script_name [Netcgi.cgi_environment]
cgi_server_name [Netcgi_common.cgi_environment]
cgi_server_name [Netcgi.cgi_environment]
cgi_server_port [Netcgi_common.cgi_environment]
cgi_server_port [Netcgi.cgi_environment]
cgi_server_protocol [Netcgi_common.cgi_environment]
cgi_server_protocol [Netcgi.cgi_environment]
cgi_server_software [Netcgi_common.cgi_environment]
cgi_server_software [Netcgi.cgi_environment]
charset [Netcgi_common.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.
config [Netcgi_common.cgi_environment]
config [Netcgi.cgi_environment]
The configuration of the request.
content_type [Netcgi_common.cgi_argument]
content_type [Netcgi.cgi_argument]
Returns the content type of the header and its parameters as a couple (hdr, params).
cookie [Netcgi_common.cgi_environment]
cookie [Netcgi.cgi_environment]
#cookie cn returns the cookie with name cn.
cookies [Netcgi_common.cgi_environment]
cookies [Netcgi.cgi_environment]
Returns the list of valid cookies found in the request header.

D
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).

E
environment [Netcgi_common.cgi]
environment [Netcgi.cgi]
The environment object.

F
filename [Netcgi_common.cgi_argument]
filename [Netcgi.cgi_argument]
The filename parameter found in the header of file uploads.
fill_in_buf [Netcgi_common.in_obj_of_descr]
#fill_in_buf() refills in_buf if needed (when empty).
finalize [Netcgi_common.cgi_argument]
finalize [Netcgi_common.cgi]
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.

I
input_all_till [Netcgi_common.in_obj_of_descr]
#input_all_till c returns the next chunk of input until c is reached.
input_content_length [Netcgi_common.cgi_environment]
input_content_length [Netcgi.cgi_environment]
Returns the "Content-length" request header field.
input_content_type [Netcgi_common.cgi_environment]
input_content_type [Netcgi.cgi_environment]
Returns the parsed "Content-type" request header field.
input_content_type_string [Netcgi_common.cgi_environment]
input_content_type_string [Netcgi.cgi_environment]
Returns the "Content-type" request header field as a plain string or "" if it is not set.
input_header [Netcgi_common.cgi_environment]
For special header structures, just override this method.
input_header [Netcgi.cgi_environment]
The whole HTTP header.
input_header_field [Netcgi_common.cgi_environment]
input_header_field [Netcgi.cgi_environment]
#input_header_field ?default f returns the value of a field f of the HTTP request header.
input_header_fields [Netcgi_common.cgi_environment]
input_header_fields [Netcgi.cgi_environment]
Returns the input header as (name,value) pairs.

L
log_error [Netcgi_common.cgi_environment]
You may want to override this with your custom logging method.
log_error [Netcgi.cgi_environment]
#log_error msg appends msg to the webserver log.

M
multiple_argument [Netcgi_common.cgi]
multiple_argument [Netcgi.cgi]
#multiple_argument name returns all the values of the argument named name.
multiple_input_header_field [Netcgi_common.cgi_environment]
multiple_input_header_field [Netcgi.cgi_environment]
Returns the values of all fields with the passed name of the request header.
multiple_output_header_field [Netcgi_common.cgi_environment]
multiple_output_header_field [Netcgi.cgi_environment]
Returns the values of all fields with the passed name of the repsonse header.

N
name [Netcgi_common.cgi_argument]
name [Netcgi.cgi_argument]
The name of the argument.

O
open_value_rd [Netcgi_common.cgi_argument]
open_value_rd [Netcgi.cgi_argument]
Open the contents of the value as an input channel.
open_value_wr [Netcgi_common.rw_cgi_argument]
open_value_wr [Netcgi.rw_cgi_argument]
out_channel [Netcgi_common.cgi]
out_channel [Netcgi_common.cgi_environment]
out_channel [Netcgi.cgi]
The output channel to which the generated content is intended to be written.
out_channel [Netcgi.cgi_environment]
The "raw" output channel.
output [Netcgi_common.cgi]
output [Netcgi.cgi]
output_ch [Netcgi_common.cgi_environment]
output_ch [Netcgi.cgi_environment]
output_header [Netcgi_common.cgi_environment]
For special header structures, override this method and maybe #send_output_header.
output_header [Netcgi.cgi_environment]
The whole HTTP response header
output_header_field [Netcgi_common.cgi_environment]
output_header_field [Netcgi.cgi_environment]
Returns the value of a field of the response header.
output_header_fields [Netcgi_common.cgi_environment]
output_header_fields [Netcgi.cgi_environment]
Returns the output header as (name,value) pairs.

P
protocol [Netcgi_common.cgi_environment]
protocol [Netcgi.cgi_environment]
The server protocol in a decoded form.

R
representation [Netcgi_common.cgi_argument]
representation [Netcgi.cgi_argument]
The representation of the argument.
request [Netcgi_mod.cgi]
The underlying apache request structure.
request_method [Netcgi_common.cgi]
request_method [Netcgi.cgi]
The HTTP method used to make the request.
ro [Netcgi_common.rw_cgi_argument]
ro [Netcgi.rw_cgi_argument]
role [Netcgi_fcgi.cgi]
A FastCGI application can fulfill each of the following three roles:

S
send_output_header [Netcgi_common.cgi_environment]
send_output_header [Netcgi.cgi_environment]
This method will encode and send the output header to the output channel.
set_header [Netcgi_common.cgi]
set_header [Netcgi.cgi]
Sets the header (removing any previous one).
set_multiple_output_header_field [Netcgi_common.cgi_environment]
set_multiple_output_header_field [Netcgi.cgi_environment]
Sets multiple values of a field of the response header.
set_output_header_field [Netcgi_common.cgi_environment]
set_output_header_field [Netcgi.cgi_environment]
Sets the value of a field of the response header.
set_output_header_fields [Netcgi_common.cgi_environment]
set_output_header_fields [Netcgi.cgi_environment]
Sets the complete response header at once.
set_redirection_header [Netcgi_common.cgi]
set_redirection_header [Netcgi.cgi]
Sets the header such that a redirection to the specified URL is performed.
set_status [Netcgi_common.cgi_environment]
set_status [Netcgi.cgi_environment]
Sets the response status.
set_value [Netcgi_common.rw_cgi_argument]
set_value [Netcgi.rw_cgi_argument]
store [Netcgi_common.cgi_argument]
store [Netcgi.cgi_argument]
Tells whether the argument is stored in memory (as a string) or as a file (the argument of `File being the filename).

T
type_of_container [Netcgi.container]

U
unsafe_input [Netcgi_common.in_obj_of_descr]
unsafe_output [Netcgi_common.out_obj_of_descr]
unsafe_really_input [Netcgi_common.in_obj_of_descr]
unsafe_really_output [Netcgi_common.out_obj_of_descr]
url [Netcgi_common.cgi]
The following environment properties must be available for this method to work properly (please make sure your connector provides them; the CGI spec make them compulsory anyway): cgi_server_name, cgi_server_port, cgi_script_name, cgi_path_info
url [Netcgi.cgi]
Returns the URL of the current CGI-like script.
user_agent [Netcgi_common.cgi_environment]
user_agent [Netcgi.cgi_environment]
This is a convenience method that returns the "User-agent" field of the HTTP request header.

V
value [Netcgi_common.cgi_argument]
value [Netcgi.cgi_argument]
The value of the argument, after all transfer encodings have been removed.

W
write [Netcgi_common.out_obj_of_descr]
write buf ofs len writes the substring buf.[ofs .. ofs+len-1] to the file descriptor.





SourceForge.net Logo