3
Apache::Server - Perl API for for Apache server record accessors
10
use Apache::Server ();
26
C<Apache::Server> provides the following functions and/or methods:
33
META: Autogenerated - needs to be reviewed/completed
35
The process this server is running in
37
$proc = $s->process();
41
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
43
=item ret: C<$proc> (C<L<Apache::Process|docs::2.0::api::Apache::Process>>)
53
META: Autogenerated - needs to be reviewed/completed
55
The next server in the list (if there are vhosts)
61
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
63
=item ret: C<$next_s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
67
For example the following code traverses all the servers, starting
68
from the base server and continuing to vhost servers, counting all
71
use Apache::Server ();
72
use Apache::ServerUtil ();
73
my $server = Apache->server;
75
for (my $s = $server->next; $s; $s = $s->next) {
82
=head2 C<server_admin>
84
Get/set the server admin value
86
$server_admin = $s->server_admin();
87
$prev_server_admin = $s->server_admin($new_server_admin);
91
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
93
=item opt arg2: C<$new_server_admin> (string)
95
If passed, sets the new server_admin.
97
=item ret: C<$server_admin> (string)
99
Returns the server_admin setting.
101
If C<$new_server_admin> is passed returns the setting before the
110
=head2 C<server_hostname>
112
Get/set the server hostname value
114
$server_hostname = $s->server_hostname();
115
$prev_server_hostname = $s->server_hostname($new_server_hostname);
119
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
121
=item opt arg2: C<$new_server_hostname> (string)
123
If passed, sets the new server_hostname.
125
=item ret: C<$server_hostname> (string)
127
Returns the server_hostname setting.
129
If C<$new_server_hostname> is passed returns the setting before the
139
META: Autogenerated - needs to be reviewed/completed
142
Get/set the port value
145
$prev_port = $s->port($new_port);
149
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
151
=item opt arg2: C<$new_port> (string)
153
If passed, sets the new port.
155
=item ret: C<$port> (string)
157
Returns the port setting.
159
If C<$new_port> is passed returns the setting before the change.
167
=head2 C<error_fname>
169
META: Autogenerated - needs to be reviewed/completed
172
Get/set the error_fname value
174
$error_fname = $s->error_fname();
175
$prev_error_fname = $s->error_fname($new_error_fname);
179
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
181
=item opt arg2: C<$new_error_fname> (string)
183
If passed, sets the new error_fname.
185
=item ret: C<$error_fname> (string)
187
Returns the error_fname setting.
189
If C<$new_error_fname> is passed returns the setting before the change.
200
META: Autogenerated - needs to be reviewed/completed
202
Get/set the log level value
204
$loglevel = $s->loglevel();
205
$prev_loglevel = $s->loglevel($new_loglevel);
209
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
211
=item opt arg2: C<$new_loglevel> (string)
213
If passed, sets the new loglevel.
215
=item ret: C<$loglevel> (string)
217
Returns the loglevel setting.
219
If C<$new_loglevel> is passed returns the setting before the change.
227
META: Autogenerated - needs to be reviewed/completed
231
Get/set the is_virtual value
233
$is_virtual = $s->is_virtual();
234
$prev_is_virtual = $s->is_virtual($new_is_virtual);
238
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
240
=item opt arg2: C<$new_is_virtual> (string)
242
If passed, sets the new is_virtual.
244
META: this is wrong, it should be a read only accessor
246
=item ret: C<$is_virtual> (string)
248
Returns the is_virtual setting.
250
If C<$new_is_virtual> is passed returns the setting before the change.
257
=head2 C<module_config>
259
META: Autogenerated - needs to be reviewed/completed
261
Get/set config vector containing pointers to modules' per-server
264
$module_config = $s->module_config();
265
$prev_module_config = $s->module_config($new_module_config);
269
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
271
=item opt arg2: C<new_module_config> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>)
273
If passed, sets the new module_config.
275
=item ret: C<$module_config> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>)
277
Returns the module_config setting.
279
If C<$new_module_config> is passed returns the setting before the change.
286
=head2 C<lookup_defaults>
288
META: Autogenerated - needs to be reviewed/completed
290
Get/set the lookup_defaults value. MIME type info, etc., before we
291
start checking per-directory info.
293
$lookup_defaults = $s->lookup_defaults();
294
$prev_lookup_defaults = $s->lookup_defaults($new_lookup_defaults);
298
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
300
=item opt arg2: C<$new_lookup_defaults> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>)
302
If passed, sets the new lookup_defaults.
304
=item ret: C<$lookup_defaults> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>)
306
Returns the lookup_defaults setting.
308
If C<$new_lookup_defaults> is passed returns the setting before the change.
317
META: Autogenerated - needs to be reviewed/completed
320
Get/set the addrs value
322
$addrs = $s->addrs();
323
$prev_addrs = $s->addrs($new_addrs);
327
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
329
=item opt arg2: C<$new_addrs> (C<L<Apache::ServerAddr|docs::2.0::api::Apache::ServerAddr>>)
331
If passed, sets the new addrs.
333
=item ret: C<$addrs> (C<L<Apache::ServerAddr|docs::2.0::api::Apache::ServerAddr>>)
335
Returns the addrs setting.
337
If C<$new_addrs> is passed returns the setting before the change.
347
META: Autogenerated - needs to be reviewed/completed
349
Get/set the timeout, as an apr interval, before we give up
351
$timeout = $s->timeout();
352
$prev_timeout = $s->timeout($new_timeout);
356
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
358
=item opt arg2: C<$new_timeout> (string)
360
If passed, sets the new timeout.
362
=item ret: C<$timeout> (string)
364
Returns the timeout setting.
366
If C<$new_timeout> is passed returns the setting before the change.
374
=head2 C<keep_alive_timeout>
376
META: Autogenerated - needs to be reviewed/completed
378
Get/set the apr interval we will wait for another request
380
$keep_alive_timeout = $s->keep_alive_timeout();
381
$prev_keep_alive_timeout = $s->keep_alive_timeout($new_keep_alive_timeout);
385
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
387
=item opt arg2: C<$new_keep_alive_timeout> (string)
389
If passed, sets the new keep_alive_timeout.
391
=item ret: C<$keep_alive_timeout> (string)
393
Returns the keep_alive_timeout setting.
395
If C<$new_keep_alive_timeout> is passed returns the setting before the change.
401
=head2 C<keep_alive_max>
403
META: Autogenerated - needs to be reviewed/completed
405
Get/set maximum requests per connection
407
$keep_alive_max = $s->keep_alive_max();
408
$prev_keep_alive_max = $s->keep_alive_max($new_keep_alive_max);
412
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
414
=item opt arg2: C<$new_keep_alive_max> (string)
416
If passed, sets the new keep_alive_max.
418
=item ret: C<$keep_alive_max> (string)
420
Returns the keep_alive_max setting.
422
If C<$new_keep_alive_max> is passed returns the setting before the change.
429
META: Autogenerated - needs to be reviewed/completed
431
Use persistent connections?
433
$keep_alive = $s->keep_alive();
434
$prev_keep_alive = $s->keep_alive($new_keep_alive);
438
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
440
=item opt arg2: C<$new_keep_alive> (string)
442
If passed, sets the new keep_alive.
444
=item ret: C<$keep_alive> (string)
446
Returns the keep_alive setting.
448
If C<$new_keep_alive> is passed returns the setting before the change.
456
META: Autogenerated - needs to be reviewed/completed
458
Get/set pathname for ServerPath
461
$prev_path = $s->path($new_path);
465
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
467
=item opt arg2: C<$new_path> (string)
469
If passed, sets the new path.
471
=item ret: C<$path> (string)
473
Returns the path setting.
475
If C<$new_path> is passed returns the setting before the change.
484
META: Autogenerated - needs to be reviewed/completed
486
Get/set normal names for ServerAlias servers
488
$names = $s->names();
489
$prev_names = $s->names($new_names);
493
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
495
=item opt arg2: C<$new_names> (C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>)
497
If passed, sets the new names.
499
=item ret: C<$names> (C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>)
501
Returns the names setting.
503
If C<$new_names> is passed returns the setting before the change.
513
META: Autogenerated - needs to be reviewed/completed
515
Wildcarded names for ServerAlias servers
517
$wild_names = $s->wild_names();
518
$prev_wild_names = $s->wild_names($new_wild_names);
522
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
524
=item opt arg2: C<$new_wild_names> (C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>)
526
If passed, sets the new wild_names.
528
=item ret: C<$wild_names> (C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>)
530
Returns the wild_names setting.
532
If C<$new_wild_names> is passed returns the setting before the change.
539
=head2 C<limit_req_line>
541
META: Autogenerated - needs to be reviewed/completed
543
Get/set limit on size of the HTTP request line
545
$limit_req_line = $s->limit_req_line();
546
$prev_limit_req_line = $s->limit_req_line($new_limit_req_line);
550
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
552
=item opt arg2: C<$new_limit_req_line> (string)
554
If passed, sets the new limit_req_line.
556
=item ret: C<$limit_req_line> (string)
558
Returns the limit_req_line setting.
560
If C<$new_limit_req_line> is passed returns the setting before the
566
=head2 C<limit_req_fieldsize>
568
META: Autogenerated - needs to be reviewed/completed
570
limit on size of any request header field
572
$limit_req_fieldsize = $s->limit_req_fieldsize();
573
$prev_limit_req_fieldsize = $s->limit_req_fieldsize($new_limit_req_fieldsize);
577
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
579
=item opt arg2: C<$new_limit_req_fieldsize> (string)
581
If passed, sets the new limit_req_fieldsize.
583
=item ret: C<$limit_req_fieldsize> (string)
585
Returns the limit_req_fieldsize setting.
587
If C<$new_limit_req_fieldsize> is passed returns the setting before
595
=head2 C<limit_req_fields>
597
META: Autogenerated - needs to be reviewed/completed
599
Get/set limit on number of request header fields
601
$limit_req_fields = $s->limit_req_fields();
602
$prev_limit_req_fields = $s->limit_req_fields($new_limit_req_fields);
606
=item obj: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::Server>>)
608
=item opt arg2: C<$new_limit_req_fields> (string)
610
If passed, sets the new limit_req_fields.
612
=item ret: C<$limit_req_fields> (string)
614
Returns the limit_req_fields setting.
616
If C<$new_limit_req_fields> is passed returns the setting before the change.
624
L<mod_perl 2.0 documentation|docs::2.0::index>.
631
mod_perl 2.0 and its core modules are copyrighted under
632
The Apache Software License, Version 1.1.
639
L<The mod_perl development team and numerous
640
contributors|about::contributors::people>.
added
removed
docs/api/Apache/Server.pod
