stas 2004/01/14 14:31:39 Modified: src/docs/2.0/api/Apache RequestRec.pod Response.pod Server.pod Log: work in progress Revision Changes Path 1.6 +1 -1 modperl-docs/src/docs/2.0/api/Apache/RequestRec.pod Index: RequestRec.pod =================================================================== RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/RequestRec.pod,v retrieving revision 1.5 retrieving revision 1.6 diff -u -u -r1.5 -r1.6 --- RequestRec.pod 14 Jan 2004 09:23:47 -0000 1.5 +++ RequestRec.pod 14 Jan 2004 22:31:39 -0000 1.6 @@ -1,6 +1,6 @@ =head1 NAME -Apache::RequestRec - Perl API for XXX +Apache::RequestRec - Perl API for Apache request record accessors 1.2 +22 -38 modperl-docs/src/docs/2.0/api/Apache/Response.pod Index: Response.pod =================================================================== RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/Response.pod,v retrieving revision 1.1 retrieving revision 1.2 diff -u -u -r1.1 -r1.2 --- Response.pod 14 Jan 2004 09:23:47 -0000 1.1 +++ Response.pod 14 Jan 2004 22:31:39 -0000 1.2 @@ -1,6 +1,6 @@ =head1 NAME -Apache::Response - Perl API for XXX +Apache::Response - Perl API for Apache HTTP request response methods @@ -42,11 +42,11 @@ The current request -=item arg2: C<$status> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>) +=item arg2: C<$status> (integer) The status for which the custom response should be used -=item arg3: C<$string> (integer) +=item arg3: C<$string> (string) The custom response. This can be a static string, a file or a URL @@ -66,7 +66,7 @@ Construct an entity tag from the resource information. If it's a real file, build in some of the file characteristics. - $ret = $r->make_etag($force_weak); + $etag = $r->make_etag($force_weak); =over 4 @@ -74,12 +74,12 @@ The current request -=item arg2: C<$force_weak> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>) +=item arg2: C<$force_weak> (number) Force the entity tag to be weak - it could be modified again in as short an interval. -=item ret: C<$ret> (string) +=item ret: C<$etag> (string) The entity tag @@ -122,7 +122,7 @@ Return the latest rational time from a request/mtime pair. Mtime is returned unless it's in the future, in which case we return the current time. - $ret = $r->rationalize_mtime($mtime); + $rat_mtime = $r->rationalize_mtime($mtime); =over 4 @@ -130,11 +130,11 @@ The current request -=item arg2: C<$mtime> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>) +=item arg2: C<$mtime> (number) The last modified time -=item ret: C<$ret> (number) +=item ret: C<$rat_mtime> (number) the latest rational time. @@ -158,13 +158,13 @@ The current request -=item arg2: C<$recursive_error> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>) +=item arg2: C<$recursive_error> (string) -last arg indicates error status in case we get -an error in the process of trying to deal with an ErrorDocument -to handle some other error. In that case, we print the default -report for the first thing that went wrong, and more briefly report -on the problem with the ErrorDocument. +last arg indicates error status in case we get an error in the process +of trying to deal with an C<ErrorDocument> to handle some other error. +In that case, we print the default report for the first thing that +went wrong, and more briefly report on the problem with the +C<ErrorDocument>. =item ret: no return value @@ -188,11 +188,11 @@ The current request -=item arg2: C<$mm> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>) +=item arg2: C<$mm> (C<L<APR::Mmap|docs::2.0::api::APR::Mmap>>) The MMAP'ed file to send -=item arg3: C<$offset> (C<L<APR::Mmap|docs::2.0::api::APR::Mmap>>) +=item arg3: C<$offset> (number) The offset into the MMAP to start sending @@ -214,11 +214,7 @@ META: Autogenerated - needs to be reviewed/completed -Also, set content length. - -May return an error status, typically HTTP_NOT_MODIFIED (that when the -permit_cache argument is set to one). * -Set the content length for this request +Set the content length for this request. $r->set_content_length($length); @@ -228,7 +224,7 @@ The current request -=item arg2: C<$length> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>) +=item arg2: C<$length> (integer) The new content length @@ -252,8 +248,6 @@ =item arg1: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>) - - =item ret: no return value =back @@ -301,9 +295,7 @@ The current request -=item arg2: C<$dependency_mtime> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>) - - +=item arg2: C<$dependency_mtime> (number) =item ret: no return value @@ -325,11 +317,7 @@ =item arg1: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>) - - -=item arg2: C<$mtime> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>) - - +=item arg2: C<$mtime> (number) =item ret: no return value @@ -351,11 +339,7 @@ =item arg1: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>) - - -=item arg2: C<$buffer> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>) - - +=item arg2: C<$buffer> (string) =item ret: no return value 1.2 +266 -95 modperl-docs/src/docs/2.0/api/Apache/Server.pod Index: Server.pod =================================================================== RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/Server.pod,v retrieving revision 1.1 retrieving revision 1.2 diff -u -u -r1.1 -r1.2 --- Server.pod 14 Jan 2004 09:23:47 -0000 1.1 +++ Server.pod 14 Jan 2004 22:31:39 -0000 1.2 @@ -1,6 +1,6 @@ =head1 NAME -Apache::Server - Perl API for XXX +Apache::Server - Perl API for for Apache server record accessors @@ -34,13 +34,13 @@ The process this server is running in - $ret = $obj->process($newval); + $proc = $s->process(); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (C<L<Apache::Process|docs::2.0::api::Apache::Process>>) +=item ret: C<$proc> (C<L<Apache::Process|docs::2.0::api::Apache::Process>>) =back @@ -52,35 +52,54 @@ META: Autogenerated - needs to be reviewed/completed -The next server in the list +The next server in the list (if there are vhosts) - $ret = $obj->next($newval); + $next_s = $s->next(); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item ret: C<$next_s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) =back +For example the following code traverses all the servers, starting +from the base server and continuing to vhost servers, counting all +vhosts: + + use Apache::Server (); + use Apache::ServerUtil (); + my $server = Apache->server; + my $vhosts = 0; + for (my $s = $server->next; $s; $s = $s->next) { + $vhosts++; + } =head2 C<server_admin> -META: Autogenerated - needs to be reviewed/completed +Get/set the server admin value + + $server_admin = $s->server_admin(); + $prev_server_admin = $s->server_admin($new_server_admin); +=over 4 +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) - $ret = $obj->server_admin($newval); +=item opt arg2: C<$new_server_admin> (string) -=over 4 +If passed, sets the new server_admin. + +=item ret: C<$server_admin> (string) -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +Returns the server_admin setting. -=item arg2: C<$newval> (string) +If C<$new_server_admin> is passed returns the setting before the +change. =back @@ -90,20 +109,27 @@ =head2 C<server_hostname> -META: Autogenerated - needs to be reviewed/completed - -The server hostname +Get/set the server hostname value - $ret = $obj->server_hostname($newval); + $server_hostname = $s->server_hostname(); + $prev_server_hostname = $s->server_hostname($new_server_hostname); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (string) +=item opt arg2: C<$new_server_hostname> (string) -=back +If passed, sets the new server_hostname. +=item ret: C<$server_hostname> (string) + +Returns the server_hostname setting. + +If C<$new_server_hostname> is passed returns the setting before the +change. + +=back @@ -112,15 +138,25 @@ META: Autogenerated - needs to be reviewed/completed -for redirects, etc. - $ret = $obj->port($newval); +Get/set the port value + + $port = $s->port(); + $prev_port = $s->port($new_port); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) + +=item opt arg2: C<$new_port> (string) + +If passed, sets the new port. + +=item ret: C<$port> (string) + +Returns the port setting. -=item arg2: C<$newval> (integer) +If C<$new_port> is passed returns the setting before the change. =back @@ -133,14 +169,24 @@ META: Autogenerated - needs to be reviewed/completed +Get/set the error_fname value - $ret = $obj->error_fname($newval); + $error_fname = $s->error_fname(); + $prev_error_fname = $s->error_fname($new_error_fname); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (string) +=item opt arg2: C<$new_error_fname> (string) + +If passed, sets the new error_fname. + +=item ret: C<$error_fname> (string) + +Returns the error_fname setting. + +If C<$new_error_fname> is passed returns the setting before the change. =back @@ -148,23 +194,31 @@ + =head2 C<loglevel> META: Autogenerated - needs to be reviewed/completed -The log level for this server +Get/set the log level value - $ret = $obj->loglevel($newval); + $loglevel = $s->loglevel(); + $prev_loglevel = $s->loglevel($new_loglevel); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (integer) +=item opt arg2: C<$new_loglevel> (string) -=back +If passed, sets the new loglevel. + +=item ret: C<$loglevel> (string) + +Returns the loglevel setting. +If C<$new_loglevel> is passed returns the setting before the change. +=back @@ -174,16 +228,28 @@ - $ret = $obj->is_virtual($newval); +Get/set the is_virtual value + + $is_virtual = $s->is_virtual(); + $prev_is_virtual = $s->is_virtual($new_is_virtual); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (integer) +=item opt arg2: C<$new_is_virtual> (string) -=back +If passed, sets the new is_virtual. +META: this is wrong, it should be a read only accessor + +=item ret: C<$is_virtual> (string) + +Returns the is_virtual setting. + +If C<$new_is_virtual> is passed returns the setting before the change. + +=back @@ -192,19 +258,27 @@ META: Autogenerated - needs to be reviewed/completed -Config vector containing pointers to modules' per-server config -structures. +Get/set config vector containing pointers to modules' per-server +config structures. - $ret = $obj->module_config($newval); + $module_config = $s->module_config(); + $prev_module_config = $s->module_config($new_module_config); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>) +=item opt arg2: C<new_module_config> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>) -=back +If passed, sets the new module_config. + +=item ret: C<$module_config> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>) + +Returns the module_config setting. +If C<$new_module_config> is passed returns the setting before the change. + +=back @@ -213,18 +287,27 @@ META: Autogenerated - needs to be reviewed/completed -MIME type info, etc., before we start checking per-directory info +Get/set the lookup_defaults value. MIME type info, etc., before we +start checking per-directory info. - $ret = $obj->lookup_defaults($newval); + $lookup_defaults = $s->lookup_defaults(); + $prev_lookup_defaults = $s->lookup_defaults($new_lookup_defaults); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>) +=item opt arg2: C<$new_lookup_defaults> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>) -=back +If passed, sets the new lookup_defaults. +=item ret: C<$lookup_defaults> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>) + +Returns the lookup_defaults setting. + +If C<$new_lookup_defaults> is passed returns the setting before the change. + +=back @@ -234,14 +317,24 @@ META: Autogenerated - needs to be reviewed/completed +Get/set the addrs value - $ret = $obj->addrs($newval); + $addrs = $s->addrs(); + $prev_addrs = $s->addrs($new_addrs); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) + +=item opt arg2: C<$new_addrs> (C<L<Apache::ServerAddr|docs::2.0::api::Apache::ServerAddr>>) -=item arg2: C<$newval> (C<L<Apache::ServerAddr|docs::2.0::api::Apache::ServerAddr>>) +If passed, sets the new addrs. + +=item ret: C<$addrs> (C<L<Apache::ServerAddr|docs::2.0::api::Apache::ServerAddr>>) + +Returns the addrs setting. + +If C<$new_addrs> is passed returns the setting before the change. =back @@ -253,15 +346,24 @@ META: Autogenerated - needs to be reviewed/completed -Timeout, as an apr interval, before we give up +Get/set the timeout, as an apr interval, before we give up - $ret = $obj->timeout($newval); + $timeout = $s->timeout(); + $prev_timeout = $s->timeout($new_timeout); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) + +=item opt arg2: C<$new_timeout> (string) + +If passed, sets the new timeout. + +=item ret: C<$timeout> (string) -=item arg2: C<$newval> (number) +Returns the timeout setting. + +If C<$new_timeout> is passed returns the setting before the change. =back @@ -273,19 +375,26 @@ META: Autogenerated - needs to be reviewed/completed -The apr interval we will wait for another request +Get/set the apr interval we will wait for another request - $ret = $obj->keep_alive_timeout($newval); + $keep_alive_timeout = $s->keep_alive_timeout(); + $prev_keep_alive_timeout = $s->keep_alive_timeout($new_keep_alive_timeout); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (number) +=item opt arg2: C<$new_keep_alive_timeout> (string) -=back +If passed, sets the new keep_alive_timeout. + +=item ret: C<$keep_alive_timeout> (string) +Returns the keep_alive_timeout setting. +If C<$new_keep_alive_timeout> is passed returns the setting before the change. + +=back @@ -293,20 +402,26 @@ META: Autogenerated - needs to be reviewed/completed -Maximum requests per connection +Get/set maximum requests per connection - $ret = $obj->keep_alive_max($newval); + $keep_alive_max = $s->keep_alive_max(); + $prev_keep_alive_max = $s->keep_alive_max($new_keep_alive_max); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (integer) +=item opt arg2: C<$new_keep_alive_max> (string) -=back +If passed, sets the new keep_alive_max. +=item ret: C<$keep_alive_max> (string) +Returns the keep_alive_max setting. +If C<$new_keep_alive_max> is passed returns the setting before the change. + +=back =head2 C<keep_alive> @@ -315,17 +430,24 @@ Use persistent connections? - $ret = $obj->keep_alive($newval); + $keep_alive = $s->keep_alive(); + $prev_keep_alive = $s->keep_alive($new_keep_alive); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (integer) +=item opt arg2: C<$new_keep_alive> (string) -=back +If passed, sets the new keep_alive. +=item ret: C<$keep_alive> (string) +Returns the keep_alive setting. + +If C<$new_keep_alive> is passed returns the setting before the change. + +=back @@ -333,18 +455,26 @@ META: Autogenerated - needs to be reviewed/completed -Pathname for ServerPath +Get/set pathname for ServerPath - $ret = $obj->path($newval); + $path = $s->path(); + $prev_path = $s->path($new_path); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (string) +=item opt arg2: C<$new_path> (string) -=back +If passed, sets the new path. + +=item ret: C<$path> (string) + +Returns the path setting. +If C<$new_path> is passed returns the setting before the change. + +=back @@ -353,15 +483,24 @@ META: Autogenerated - needs to be reviewed/completed -Normal names for ServerAlias servers +Get/set normal names for ServerAlias servers - $ret = $obj->names($newval); + $names = $s->names(); + $prev_names = $s->names($new_names); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>) +=item opt arg2: C<$new_names> (C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>) + +If passed, sets the new names. + +=item ret: C<$names> (C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>) + +Returns the names setting. + +If C<$new_names> is passed returns the setting before the change. =back @@ -375,16 +514,24 @@ Wildcarded names for ServerAlias servers - $ret = $obj->wild_names($newval); + $wild_names = $s->wild_names(); + $prev_wild_names = $s->wild_names($new_wild_names); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>) +=item opt arg2: C<$new_wild_names> (C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>) -=back +If passed, sets the new wild_names. +=item ret: C<$wild_names> (C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>) + +Returns the wild_names setting. + +If C<$new_wild_names> is passed returns the setting before the change. + +=back @@ -393,20 +540,27 @@ META: Autogenerated - needs to be reviewed/completed -limit on size of the HTTP request line +Get/set limit on size of the HTTP request line - $ret = $obj->limit_req_line($newval); + $limit_req_line = $s->limit_req_line(); + $prev_limit_req_line = $s->limit_req_line($new_limit_req_line); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (integer) +=item opt arg2: C<$new_limit_req_line> (string) -=back +If passed, sets the new limit_req_line. + +=item ret: C<$limit_req_line> (string) +Returns the limit_req_line setting. +If C<$new_limit_req_line> is passed returns the setting before the +change. +=back =head2 C<limit_req_fieldsize> @@ -415,16 +569,25 @@ limit on size of any request header field - $ret = $obj->limit_req_fieldsize($newval); + $limit_req_fieldsize = $s->limit_req_fieldsize(); + $prev_limit_req_fieldsize = $s->limit_req_fieldsize($new_limit_req_fieldsize); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (integer) +=item opt arg2: C<$new_limit_req_fieldsize> (string) -=back +If passed, sets the new limit_req_fieldsize. + +=item ret: C<$limit_req_fieldsize> (string) +Returns the limit_req_fieldsize setting. + +If C<$new_limit_req_fieldsize> is passed returns the setting before +the change. + +=back @@ -433,18 +596,26 @@ META: Autogenerated - needs to be reviewed/completed -limit on number of request header fields +Get/set limit on number of request header fields - $ret = $obj->limit_req_fields($newval); + $limit_req_fields = $s->limit_req_fields(); + $prev_limit_req_fields = $s->limit_req_fields($new_limit_req_fields); =over 4 -=item arg1: C<$obj> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) +=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>) -=item arg2: C<$newval> (integer) +=item opt arg2: C<$new_limit_req_fields> (string) -=back +If passed, sets the new limit_req_fields. + +=item ret: C<$limit_req_fields> (string) + +Returns the limit_req_fields setting. +If C<$new_limit_req_fields> is passed returns the setting before the change. + +=back
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]