You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs-cvs@perl.apache.org by st...@apache.org on 2004/07/10 10:28:54 UTC
cvs commit: modperl-docs/src/docs/2.0/api/Apache ServerRec.pod Log.pod RequestRec.pod Server.pod ServerUtil.pod
stas 2004/07/10 01:28:54
Modified: src/docs/2.0/api config.cfg
src/docs/2.0/api/Apache Log.pod RequestRec.pod Server.pod
ServerUtil.pod
Added: src/docs/2.0/api/Apache ServerRec.pod
Log:
work in progress
Revision Changes Path
1.38 +2 -1 modperl-docs/src/docs/2.0/api/config.cfg
Index: config.cfg
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/config.cfg,v
retrieving revision 1.37
retrieving revision 1.38
diff -u -u -r1.37 -r1.38
--- config.cfg 23 Jun 2004 21:18:08 -0000 1.37
+++ config.cfg 10 Jul 2004 08:28:53 -0000 1.38
@@ -21,7 +21,6 @@
Apache/Access.pod
Apache/CmdParms.pod
Apache/Command.pod
- Apache/compat.pod
Apache/Connection.pod
Apache/Const.pod
Apache/Directive.pod
@@ -37,6 +36,7 @@
Apache/RequestUtil.pod
Apache/Response.pod
Apache/Server.pod
+ Apache/ServerRec.pod
Apache/ServerUtil.pod
Apache/SubProcess.pod
Apache/SubRequest.pod
@@ -83,6 +83,7 @@
group => 'Helper Modules / Applications',
chapters => [qw(
+ Apache/compat.pod
Apache/porting.pod
Apache/Reload.pod
Apache/Status.pod
1.12 +2 -2 modperl-docs/src/docs/2.0/api/Apache/Log.pod
Index: Log.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/Log.pod,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -u -r1.11 -r1.12
--- Log.pod 22 May 2004 02:03:27 -0000 1.11
+++ Log.pod 10 Jul 2004 08:28:53 -0000 1.12
@@ -593,12 +593,12 @@
=head1 Unsupported API
-C<Apache::Log> also provides auto-generated perl interface for a few
+C<Apache::Log> also provides auto-generated Perl interface for a few
other methods which aren't tested at the moment and therefore their
API is a subject to change. These methods will be finalized later as a
need arises. If you want to rely on any of the following methods
please contact the L<the mod_perl development mailing
-list|maillist::dev> so we can help eachother take the steps necessary
+list|maillist::dev> so we can help each other take the steps necessary
to shift the method to an officially supported API.
1.19 +8 -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.18
retrieving revision 1.19
diff -u -u -r1.18 -r1.19
--- RequestRec.pod 28 May 2004 02:54:34 -0000 1.18
+++ RequestRec.pod 10 Jul 2004 08:28:53 -0000 1.19
@@ -25,9 +25,16 @@
=head1 Description
-C<Apache::RequestRec> provides the Perl API for Apache request object.
+C<Apache::RequestRec> provides the Perl API for Apache request_rec
+object.
+The following packages extend C<Apache::RequestRec> functionality:
+
+ Apache/RequestIO.pod
+ Apache/RequestRec.pod
+ Apache/RequestUtil.pod
+ ... complete ...
=head1 API
1.5 +1 -592 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.4
retrieving revision 1.5
diff -u -u -r1.4 -r1.5
--- Server.pod 22 May 2004 02:03:27 -0000 1.4
+++ Server.pod 10 Jul 2004 08:28:53 -0000 1.5
@@ -1,6 +1,6 @@
=head1 NAME
-Apache::Server - Perl API for for Apache server record accessors
+Apache::Server - Perl API for XXX
@@ -25,597 +25,6 @@
C<Apache::Server> provides the following functions and/or methods:
-
-
-
-=head2 C<process>
-
-META: Autogenerated - needs to be reviewed/completed
-
-The process this server is running in
-
- $proc = $s->process();
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=item ret: C<$proc> (C<L<Apache::Process|docs::2.0::api::Apache::Process>>)
-
-=back
-
-
-
-
-
-=head2 C<next>
-
-META: Autogenerated - needs to be reviewed/completed
-
-The next server in the list (if there are vhosts)
-
- $next_s = $s->next();
-
-=over 4
-
-=item obj: C<$s> (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>
-
-Get/set the server admin value
-
- $server_admin = $s->server_admin();
- $prev_server_admin = $s->server_admin($new_server_admin);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=item opt arg2: C<$new_server_admin> (string)
-
-If passed, sets the new server_admin.
-
-=item ret: C<$server_admin> (string)
-
-Returns the server_admin setting.
-
-If C<$new_server_admin> is passed returns the setting before the
-change.
-
-=back
-
-
-
-
-
-=head2 C<server_hostname>
-
-Get/set the server hostname value
-
- $server_hostname = $s->server_hostname();
- $prev_server_hostname = $s->server_hostname($new_server_hostname);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=item opt arg2: C<$new_server_hostname> (string)
-
-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
-
-
-
-
-=head2 C<port>
-
-META: Autogenerated - needs to be reviewed/completed
-
-
-Get/set the port value
-
- $port = $s->port();
- $prev_port = $s->port($new_port);
-
-=over 4
-
-=item obj: 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.
-
-If C<$new_port> is passed returns the setting before the change.
-
-=back
-
-
-
-
-
-=head2 C<error_fname>
-
-META: Autogenerated - needs to be reviewed/completed
-
-
-Get/set the error_fname value
-
- $error_fname = $s->error_fname();
- $prev_error_fname = $s->error_fname($new_error_fname);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=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
-
-
-
-
-
-
-=head2 C<loglevel>
-
-META: Autogenerated - needs to be reviewed/completed
-
-Get/set the log level value
-
- $loglevel = $s->loglevel();
- $prev_loglevel = $s->loglevel($new_loglevel);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=item opt arg2: C<$new_loglevel> (string)
-
-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
-
-
-
-=head2 C<is_virtual>
-
-META: Autogenerated - needs to be reviewed/completed
-
-
-
-Get/set the is_virtual value
-
- $is_virtual = $s->is_virtual();
- $prev_is_virtual = $s->is_virtual($new_is_virtual);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=item opt arg2: C<$new_is_virtual> (string)
-
-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
-
-
-
-
-=head2 C<module_config>
-
-META: Autogenerated - needs to be reviewed/completed
-
-Get/set config vector containing pointers to modules' per-server
-config structures.
-
- $module_config = $s->module_config();
- $prev_module_config = $s->module_config($new_module_config);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=item opt arg2: C<new_module_config> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>)
-
-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
-
-
-
-
-=head2 C<lookup_defaults>
-
-META: Autogenerated - needs to be reviewed/completed
-
-Get/set the lookup_defaults value. MIME type info, etc., before we
-start checking per-directory info.
-
- $lookup_defaults = $s->lookup_defaults();
- $prev_lookup_defaults = $s->lookup_defaults($new_lookup_defaults);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=item opt arg2: C<$new_lookup_defaults> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>)
-
-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
-
-
-
-
-=head2 C<addrs>
-
-META: Autogenerated - needs to be reviewed/completed
-
-
-Get/set the addrs value
-
- $addrs = $s->addrs();
- $prev_addrs = $s->addrs($new_addrs);
-
-=over 4
-
-=item obj: 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>>)
-
-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
-
-
-
-
-
-=head2 C<timeout>
-
-META: Autogenerated - needs to be reviewed/completed
-
-Get/set the timeout, as an apr interval, before we give up
-
- $timeout = $s->timeout();
- $prev_timeout = $s->timeout($new_timeout);
-
-=over 4
-
-=item obj: 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)
-
-Returns the timeout setting.
-
-If C<$new_timeout> is passed returns the setting before the change.
-
-=back
-
-
-
-
-
-=head2 C<keep_alive_timeout>
-
-META: Autogenerated - needs to be reviewed/completed
-
-Get/set the apr interval we will wait for another request
-
- $keep_alive_timeout = $s->keep_alive_timeout();
- $prev_keep_alive_timeout = $s->keep_alive_timeout($new_keep_alive_timeout);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=item opt arg2: C<$new_keep_alive_timeout> (string)
-
-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
-
-
-
-=head2 C<keep_alive_max>
-
-META: Autogenerated - needs to be reviewed/completed
-
-Get/set maximum requests per connection
-
- $keep_alive_max = $s->keep_alive_max();
- $prev_keep_alive_max = $s->keep_alive_max($new_keep_alive_max);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=item opt arg2: C<$new_keep_alive_max> (string)
-
-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>
-
-META: Autogenerated - needs to be reviewed/completed
-
-Use persistent connections?
-
- $keep_alive = $s->keep_alive();
- $prev_keep_alive = $s->keep_alive($new_keep_alive);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=item opt arg2: C<$new_keep_alive> (string)
-
-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
-
-
-
-=head2 C<path>
-
-META: Autogenerated - needs to be reviewed/completed
-
-Get/set pathname for ServerPath
-
- $path = $s->path();
- $prev_path = $s->path($new_path);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=item opt arg2: C<$new_path> (string)
-
-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
-
-
-
-
-=head2 C<names>
-
-META: Autogenerated - needs to be reviewed/completed
-
-Get/set normal names for ServerAlias servers
-
- $names = $s->names();
- $prev_names = $s->names($new_names);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=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
-
-
-
-
-
-=head2 C<wild_names>
-
-META: Autogenerated - needs to be reviewed/completed
-
-Wildcarded names for ServerAlias servers
-
- $wild_names = $s->wild_names();
- $prev_wild_names = $s->wild_names($new_wild_names);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=item opt arg2: C<$new_wild_names> (C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>)
-
-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
-
-
-
-
-=head2 C<limit_req_line>
-
-META: Autogenerated - needs to be reviewed/completed
-
-Get/set limit on size of the HTTP request line
-
- $limit_req_line = $s->limit_req_line();
- $prev_limit_req_line = $s->limit_req_line($new_limit_req_line);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=item opt arg2: C<$new_limit_req_line> (string)
-
-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>
-
-META: Autogenerated - needs to be reviewed/completed
-
-limit on size of any request header field
-
- $limit_req_fieldsize = $s->limit_req_fieldsize();
- $prev_limit_req_fieldsize = $s->limit_req_fieldsize($new_limit_req_fieldsize);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=item opt arg2: C<$new_limit_req_fieldsize> (string)
-
-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
-
-
-
-
-=head2 C<limit_req_fields>
-
-META: Autogenerated - needs to be reviewed/completed
-
-Get/set limit on number of request header fields
-
- $limit_req_fields = $s->limit_req_fields();
- $prev_limit_req_fields = $s->limit_req_fields($new_limit_req_fields);
-
-=over 4
-
-=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
-
-=item opt arg2: C<$new_limit_req_fields> (string)
-
-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
1.22 +52 -27 modperl-docs/src/docs/2.0/api/Apache/ServerUtil.pod
Index: ServerUtil.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/ServerUtil.pod,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -u -r1.21 -r1.22
--- ServerUtil.pod 5 Jul 2004 01:40:31 -0000 1.21
+++ ServerUtil.pod 10 Jul 2004 08:28:53 -0000 1.22
@@ -1,6 +1,6 @@
=head1 NAME
-Apache::ServerUtil - Perl API for XXX
+Apache::ServerUtil - Perl API for Apache server record utils
@@ -28,19 +28,11 @@
=head1 Description
-C<Apache::ServerUtil> provides the Perl API for Apache server object.
-
-META: to be completed
-
-
-
-=head1 Constants
-
+C<Apache::ServerUtil> provides the L<Apache server
+object|docs::2.0::api::Apache::Server> utilities API.
-=head2 C<Apache::server_root>
-returns the value set by the C<ServerRoot> directive.
=head1 Functions API
@@ -63,7 +55,7 @@
The pool to allocate the component from (should really be a
C<$pconf_pool>)
-=item arg1: C<$component> (string)
+=item arg1: C<$component> ( string )
The string to add
@@ -85,7 +77,7 @@
=over 4
-=item obj: C<$name> (string)
+=item obj: C<$name> ( string )
The define to check for
@@ -104,18 +96,15 @@
-
=head2 C<get_server_built>
-META: Autogenerated - needs to be reviewed/completed
-
Get the date and time that the server was built
- $when_built = Apache::get_server_built();
+ $when_built = Apache::ServerUtil::get_server_built();
=over 4
-=item ret: C<$when_built> (string)
+=item ret: C<$when_built> ( string )
The server build time string
@@ -126,15 +115,17 @@
+
+
=head2 C<get_server_version>
Get the server version string
- Apache::get_server_version();
+ $version = Apache::ServerUtil::get_server_version();
=over 4
-=item ret: C<$ret> (string)
+=item ret: C<$version> ( string )
The server version string
@@ -144,6 +135,31 @@
+
+
+
+=head2 C<server_root>
+
+returns the value set by the top-level C<ServerRoot> directive.
+
+ $server_root = Apache::ServerUtil::server_root();
+
+=over 4
+
+=item ret: C<$server_root> ( string )
+
+=item since: 1.99_10
+
+=back
+
+
+
+
+
+
+
+
+
=head1 Methods API
C<Apache::ServerUtil> provides the following functions and/or methods:
@@ -209,11 +225,11 @@
=item obj: C<$s>
( C<L<Apache::Server object|docs::2.0::api::Apache::Server>> )
-=item opt arg2: C<$key> (string)
+=item opt arg2: C<$key> ( string )
Key string
-=item opt arg3: C<$val> (string)
+=item opt arg3: C<$val> ( string )
Value string
@@ -307,7 +323,7 @@
=item obj: C<$s>
( C<L<Apache::Server object|docs::2.0::api::Apache::Server>> )
-=item arg1: C<$hook_name> (string)
+=item arg1: C<$hook_name> ( string )
a string representing the phase to handle.
@@ -383,11 +399,11 @@
=item obj: C<$rXXX> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)
-=item arg1: C<$prefix> (string)
+=item arg1: C<$prefix> ( string )
Text which is prepended to the return value
-=item ret: C<$sig> (string)
+=item ret: C<$sig> ( string )
HTML describing the server
@@ -475,6 +491,15 @@
+
+
+
+
+
+
+
+
+
=head2 C<server_root_relative>
Returns the canonical form of the filename made absolute to
@@ -487,9 +512,9 @@
=item obj: C<$s>
( C<L<Apache::Server object|docs::2.0::api::Apache::Server>> )
-=item opt arg2: C<$fname> (string)
+=item opt arg2: C<$fname> ( string )
-=item ret: C<$path> (string)
+=item ret: C<$path> ( string )
=item since: 1.99_10
1.1 modperl-docs/src/docs/2.0/api/Apache/ServerRec.pod
Index: ServerRec.pod
===================================================================
=head1 NAME
Apache::ServerRec - Perl API for Apache server record accessors
=head1 Synopsis
use Apache::ServerRec ();
META: to be completed
=head1 Description
C<Apache::ServerRec> provides the Perl API for Apache server_rec
object.
=head1 API
C<Apache::ServerRec> provides the following functions and/or methods:
=head2 C<process>
The process this server is running in
$proc = $s->process();
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item ret: C<$proc>
( C<L<Apache::Process object|docs::2.0::api::Apache::Process>> )
=item since: 1.99_15
=back
=head2 C<next>
The next server record in the list (if there are vhosts)
$s_next = $s->next();
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item ret: C<$s_next>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item since: 1.99_15
=back
For example the following code traverses all the servers, starting
from the base server and continuing to vhost servers, counting all
available vhosts:
use Apache::ServerRec ();
use Apache::ServerUtil ();
my $server = Apache->server;
my $vhosts = 0;
for (my $s = $server->next; $s; $s = $s->next) {
$vhosts++;
}
print "There are $vhosts virtual hosts";
=head2 C<server_admin>
Get/set the server admin value
$server_admin = $s->server_admin();
$prev_server_admin = $s->server_admin($new_server_admin);
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item opt arg2: C<$new_server_admin> ( string )
If passed, sets the new server_admin.
Note that under threaded mpms, this option works only before threads
are spawned (i.e. before the
C<L<ChildInit|docs::2.0::user::handlers::server/PerlChildInitHandler>>
phase).
=item ret: C<$server_admin> ( string )
Returns the server_admin setting.
If C<$new_server_admin> is passed returns the setting before the
change.
=item since: 1.99_15
=back
=head2 C<server_hostname>
Get/set the server hostname value
$server_hostname = $s->server_hostname();
$prev_server_hostname = $s->server_hostname($new_server_hostname);
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item opt arg2: C<$new_server_hostname> ( string )
If passed, sets the new server_hostname.
Note that under threaded mpms, this option works only before threads
are spawned (i.e. before the
C<L<ChildInit|docs::2.0::user::handlers::server/PerlChildInitHandler>>
phase).
=item ret: C<$server_hostname> ( string )
Returns the server_hostname setting.
If C<$new_server_hostname> is passed returns the setting before the
change.
=item since: 1.99_15
=back
=head2 C<port>
Get/set the port value
$port = $s->port();
$prev_port = $s->port($new_port);
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item opt arg2: C<$new_port> ( string )
If passed, sets the new port.
Note that under threaded mpms, this option works only before threads
are spawned (i.e. before the
C<L<ChildInit|docs::2.0::user::handlers::server/PerlChildInitHandler>>
phase).
META: I don't think one should be allowed to change port number after
the server has started.
=item ret: C<$port> ( string )
Returns the port setting.
If C<$new_port> is passed returns the setting before the change.
=item since: 1.99_15
=back
=head2 C<error_fname>
Get/set the C<ErrorLog> file value (e.g. F<logs/error_log>)
$error_fname = $s->error_fname();
$prev_error_fname = $s->error_fname($new_error_fname);
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item opt arg2: C<$new_error_fname> ( string )
If passed, sets the new value for C<ErrorLog>
Note that under threaded mpms, this option works only before threads
are spawned (i.e. before the
C<L<ChildInit|docs::2.0::user::handlers::server/PerlChildInitHandler>>
phase).
=item ret: C<$error_fname> ( string )
Returns the C<ErrorLog> value setting.
If C<$new_error_fname> is passed returns the setting before the change.
=item since: 1.99_15
=back
=head2 C<loglevel>
Get/set the C<LogLevel> directive value
$loglevel = $s->loglevel();
$prev_loglevel = $s->loglevel($new_loglevel);
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item opt arg2: C<$new_loglevel> ( string )
If passed, sets a new C<LogLevel> value
=item ret: C<$loglevel> ( string )
Returns the C<LogLevel> value
If C<$new_loglevel> is passed, returns the setting before the change.
=item since: 1.99_15
=back
=head2 C<is_virtual>
Test whether C<$s> is a virtual host object
$is_virtual = $s->is_virtual();
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item ret: C<$is_virtual> ( string )
Returns the is_virtual setting.
If C<$new_is_virtual> is passed returns the setting before the change.
=item since: 1.99_15
=back
=head2 C<timeout>
Get/set the timeout (in microsecs), before we give up doing something
$timeout = $s->timeout();
$prev_timeout = $s->timeout($new_timeout);
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item opt arg2: C<$new_timeout> ( string )
If passed, sets the new timeout (the value should be in microseconds).
Note that under threaded mpms, this option works only before threads
are spawned (i.e. before the
C<L<ChildInit|docs::2.0::user::handlers::server/PerlChildInitHandler>>
phase).
=item ret: C<$timeout> ( string )
Returns the timeout setting in microseconds.
If C<$new_timeout> is passed returns the setting before the change.
=item since: 1.99_15
=back
To stress out the timeout values is microseconds, here is how to set
the timeout to 20 secs:
$s->timeout(20_000_000);
=head2 C<keep_alive_timeout>
META: Autogenerated - needs to be reviewed/completed
Get/set the apr interval we will wait for another request
$keep_alive_timeout = $s->keep_alive_timeout();
$prev_keep_alive_timeout = $s->keep_alive_timeout($new_keep_alive_timeout);
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item opt arg2: C<$new_keep_alive_timeout> ( string )
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.
=item since: 1.99_15
=back
=head2 C<keep_alive_max>
META: Autogenerated - needs to be reviewed/completed
Get/set maximum requests per connection
$keep_alive_max = $s->keep_alive_max();
$prev_keep_alive_max = $s->keep_alive_max($new_keep_alive_max);
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item opt arg2: C<$new_keep_alive_max> ( string )
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.
=item since: 1.99_15
=back
=head2 C<keep_alive>
META: Autogenerated - needs to be reviewed/completed
Use persistent connections?
$keep_alive = $s->keep_alive();
$prev_keep_alive = $s->keep_alive($new_keep_alive);
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item opt arg2: C<$new_keep_alive> ( string )
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.
=item since: 1.99_15
=back
=head2 C<path>
META: Autogenerated - needs to be reviewed/completed
Get/set pathname for ServerPath
$path = $s->path();
$prev_path = $s->path($new_path);
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item opt arg2: C<$new_path> ( string )
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.
=item since: 1.99_15
=back
=head2 C<names>
META: Autogenerated - needs to be reviewed/completed
Get/set normal names for ServerAlias servers
$names = $s->names();
$prev_names = $s->names($new_names);
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=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.
=item since: 1.99_15
=back
=head2 C<wild_names>
META: Autogenerated - needs to be reviewed/completed
Wildcarded names for ServerAlias servers
$wild_names = $s->wild_names();
$prev_wild_names = $s->wild_names($new_wild_names);
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item opt arg2: C<$new_wild_names> (C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>)
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.
=item since: 1.99_15
=back
=head2 C<limit_req_line>
META: Autogenerated - needs to be reviewed/completed
Get/set limit on size of the HTTP request line
$limit_req_line = $s->limit_req_line();
$prev_limit_req_line = $s->limit_req_line($new_limit_req_line);
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item opt arg2: C<$new_limit_req_line> ( string )
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.
=item since: 1.99_15
=back
=head2 C<limit_req_fieldsize>
META: Autogenerated - needs to be reviewed/completed
limit on size of any request header field
$limit_req_fieldsize = $s->limit_req_fieldsize();
$prev_limit_req_fieldsize = $s->limit_req_fieldsize($new_limit_req_fieldsize);
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item opt arg2: C<$new_limit_req_fieldsize> ( string )
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.
=item since: 1.99_15
=back
=head2 C<limit_req_fields>
META: Autogenerated - needs to be reviewed/completed
Get/set limit on number of request header fields
$limit_req_fields = $s->limit_req_fields();
$prev_limit_req_fields = $s->limit_req_fields($new_limit_req_fields);
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item opt arg2: C<$new_limit_req_fields> ( string )
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.
=item since: 1.99_15
=back
=head1 Unsupported API
C<Apache::ServerRec> also provides auto-generated Perl interface for a
few other methods which aren't tested at the moment and therefore
their API is a subject to change. These methods will be finalized
later as a need arises. If you want to rely on any of the following
methods please contact the L<the mod_perl development mailing
list|maillist::dev> so we can help each other take the steps necessary
to shift the method to an officially supported API.
=head2 C<module_config>
Get config vector containing pointers to modules' per-server config
structures.
$module_config = $s->module_config();
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item ret: C<$module_config>
( C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>> )
Returns the module_config setting.
=item since: subject to change
=back
=head2 C<lookup_defaults>
Get the lookup_defaults value. MIME type info, etc., before we start
checking per-directory info.
$lookup_defaults = $s->lookup_defaults();
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item ret: C<$lookup_defaults>
( C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>> )
Returns the lookup_defaults setting.
=item since: subject to change
=back
=head2 C<addrs>
Get the addrs value
$addrs = $s->addrs();
=over 4
=item obj: C<$s>
( C<L<Apache::ServerRec object|docs::2.0::api::Apache::ServerRec>> )
=item ret: C<$addrs>
( C<L<Apache::ServerAddr|docs::2.0::api::Apache::ServerAddr>> )
Returns the addrs setting.
=item since: subject to change
=back
META: this methods returns a vhost-specific Apache::ServerAddr object,
which is not implemented at the moment. See the struct server_addr_rec
entry in httpd-2.0/include/httpd.h for more information. It seems that
most (all?) of the information in that record is available through
other APIs.
=head1 See Also
L<mod_perl 2.0 documentation|docs::2.0::index>.
=head1 Copyright
mod_perl 2.0 and its core modules are copyrighted under
The Apache Software License, Version 2.0.
=head1 Authors
L<The mod_perl development team and numerous
contributors|about::contributors::people>.
=cut
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-cvs-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-cvs-help@perl.apache.org