Apache2::ServerRec - Perl API for Apache server record accessors

  use Apache2::ServerRec ();

  $error_fname = $s->error_fname();

  $is_virtual = $s->is_virtual();

  $keep_alive         = $s->keep_alive();
  $keep_alive_max     = $s->keep_alive_max();
  $keep_alive_timeout = $s->keep_alive_timeout();

  $limit_req_fields    = $s->limit_req_fields();
  $limit_req_fieldsize = $s->limit_req_fieldsize();
  $limit_req_line      = $s->limit_req_line();

  $path = $s->path();

  $hostname = $s->server_hostname();
  $port     = $s->port();

  $server_admin = $s->server_admin();

  $proc = $s->process();

  $timeout  = $s->timeout();
  $loglevel = $s->loglevel();

  my $server = Apache2::ServerUtil->server;
  my $vhosts = 0;
  for (my $s = $server->next; $s; $s = $s->next) {
      $vhosts++;
  }
  print "There are $vhosts virtual hosts";

CWApache2::ServerRec provides the Perl API for Apache server_rec object.

CWApache2::ServerUtil provides an extra functionality.

CWApache2::ServerRec provides the following functions and/or methods: Get/set the CWErrorLog file value (e.g. logs/error_log)

  $error_fname      = $s->error_fname();
  $prev_error_fname = $s->error_fname($new_error_fname);

since: 2.0.00

Test whether CW$s is a virtual host object

  $is_virtual = $s->is_virtual();

since: 2.0.00

Example:

  print "This is a virtual host" if $s->is_virtual();

  $keep_alive      = $s->keep_alive();
  $prev_keep_alive = $s->keep_alive($new_keep_alive);

since: 2.0.00

Get/set the CWMaxKeepAliveRequest setting, which specifies the maximum number of requests Apache will serve over a CWKeepAlive connection.

  $keep_alive_max      = $s->keep_alive_max();
  $prev_keep_alive_max = $s->keep_alive_max($new_keep_alive_max);

since: 2.0.00

Get/set the CWKeepAliveTimeout setting (in microsecs), which specifies how long Apache will wait for another request before breaking a CWKeepAlive connection.

  $keep_alive_timeout      = $s->keep_alive_timeout();
  $prev_keep_alive_timeout = $s->keep_alive_timeout($new_timeout);

since: 2.0.00

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);

since: 2.0.00

Get/set limit on size of any request header field

  $limit_req_fieldsize = $s->limit_req_fieldsize();
  $prev_limit          = $s->limit_req_fieldsize($new_limit);

since: 2.0.00

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);

since: 2.0.00

Get/set the CWLogLevel directive value

  $loglevel      = $s->loglevel();
  $prev_loglevel = $s->loglevel($new_loglevel);

since: 2.0.00

For example, to set the CWLogLevel value to CWinfo:

  use Apache2::Const -compile => qw(LOG_INFO);
  $s->loglevel(Apache2::Const::LOG_INFO);

  $s_next = $s->next();

since: 2.0.00

For example the following code traverses all the servers, starting from the base server and continuing to vhost servers, counting all available vhosts:

  use Apache2::ServerRec ();
  use Apache2::ServerUtil ();
  my $server = Apache2::ServerUtil->server;
  my $vhosts = 0;
  for (my $s = $server->next; $s; $s = $s->next) {
      $vhosts++;
  }
  print "There are $vhosts virtual hosts";

  $path      = $s->path();
  $prev_path = $s->path($new_path);

since: 2.0.00

Get/set the port value

  $port      = $s->port();
  $prev_port = $s->port($new_port);

since: 2.0.00

The process this server is running in

  $proc = $s->process();

since: 2.0.00

Get/set the CWServerAdmin value

  $server_admin      = $s->server_admin();
  $prev_server_admin = $s->server_admin($new_server_admin);

since: 2.0.00

Get/set the CWServerName value

  $server_hostname      = $s->server_hostname();
  $prev_server_hostname = $s->server_hostname($new_server_hostname);

since: 2.0.00

Get/set the timeout (CWTimeOut) (in microsecs), which Apache will wait for before it gives up doing something

  $timeout      = $s->timeout();
  $prev_timeout = $s->timeout($new_timeout);

since: 2.0.00

Let us repeat again: the timeout values is microseconds. For example to set the timeout to 20 secs:

  $s->timeout(20_000_000);

Note that under threaded MPMs, some of the read/write accessors, will be able to set values only before threads are spawned (i.e. before the CWChildInit phase). Therefore if you are developing your application on the non-threaded MPM, but planning to have it run under threaded mpm, you should not use those methods to set values after the ChildInit phase.

The affected accessor methods are marked as such in their respective documentation entries.

CWApache2::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 the mod_perl development mailing list so we can help each other take the steps necessary to shift the method to an officially supported API. Get the addrs value

  $addrs = $s->addrs();

since: subject to change

META: this methods returns a vhost-specific Apache2::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. Get the lookup_defaults value. MIME type info, etc., before we start checking per-directory info.

  $lookup_defaults = $s->lookup_defaults();

since: subject to change

Get config vector containing pointers to modules' per-server config structures.

  $module_config = $s->module_config();

since: subject to change

Get/set the value(s) for the CWServerAlias setting

  $names      = $s->names();
  $prev_names = $s->names($new_names);

since: 2.0.00

META: we don't have CWAPR::ArrayHeader yet Wildcarded names for ServerAlias servers

  $wild_names      = $s->wild_names();
  $prev_wild_names = $s->wild_names($new_wild_names);

since: 2.0.00

META: we don't have CWAPR::ArrayHeader yet

mod_perl 2.0 documentation.

mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.

The mod_perl development team and numerous contributors.