Apache2::Response - Perl API for Apache HTTP request response methods

  use Apache2::Response ();

  $r->custom_response(Apache2::Const::FORBIDDEN, "No Entry today");

  $etag = $r->make_etag($force_weak);
  $r->set_etag();
  $status = $r->meets_conditions();

  $mtime_rat = $r->rationalize_mtime($mtime);
  $r->set_last_modified($mtime);
  $r->update_mtime($mtime);

  $r->send_cgi_header($buffer);

  $r->set_content_length($length);

  $ret = $r->set_keepalive();

CWApache2::Response provides the Apache request object utilities API for dealing with HTTP response generation process.

CWApache2::Response provides the following functions and/or methods: Install a custom response handler for a given status

  $r->custom_response($status, $string);

ret: no return value

since: 2.0.00

CWcustom_response() doesn't alter the response code, but is used to replace the standard response body. For example, here is how to change the response body for the access handler failure:

  package MyApache2::MyShop;
  use Apache2::Response ();
  use Apache2::Const -compile => qw(FORBIDDEN OK);
  sub access {
      my $r = shift;

      if (MyApache2::MyShop::tired_squirrels()) {
          $r->custom_response(Apache2::Const::FORBIDDEN,
              "It's siesta time, please try later");
          return Apache2::Const::FORBIDDEN;
      }

      return Apache2::Const::OK;
  }
  ...

  # httpd.conf
  PerlModule MyApache2::MyShop
  <Location /TestAPI__custom_response>
      AuthName dummy
      AuthType none
      PerlAccessHandler   MyApache2::MyShop::access
      PerlResponseHandler MyApache2::MyShop::response
  </Location>

When squirrels can't run any more, the handler will return 403, with the custom message:

  It's siesta time, please try later

  $etag = $r->make_etag($force_weak);

since: 2.0.00

Implements condition CWGET rules for HTTP/1.1 specification. This function inspects the client headers and determines if the response fulfills the specified requirements.

  $status = $r->meets_conditions();

since: 2.0.00

Refer to the Generating Correct HTTP Headers document for an indepth discussion of this method. Return the latest rational time from a request/mtime pair.

  $mtime_rat = $r->rationalize_mtime($mtime);

since: 2.0.00

Parse the header

  $r->send_cgi_header($buffer);

ret: no return value

since: 2.0.00

This method is really for back-compatibility with mod_perl 1.0. It's very inefficient to send headers this way, because of the parsing overhead.

If there is a response body following the headers it'll be handled too (as if it was sent via CWCIprint()CW).

Notice that if only HTTP headers are included they won't be sent until some body is sent (again the send part is retained from the mod_perl 1.0 method). Set the content length for this request.

  $r->set_content_length($length);

ret: no return value

since: 2.0.00

Set the E-tag outgoing header

  $r->set_etag();

ret: no return value

since: 2.0.00

Set the keepalive status for this request

  $ret = $r->set_keepalive();

since: 2.0.00

It's called by CWap_http_header_filter(). For the complete complicated logic implemented by this method see httpd-2.0/server/http_protocol.c. sets the CWLast-Modified response header field to the value of the mtime field in the request structure rationalized to keep it from being in the future.

  $r->set_last_modified($mtime);

ret: no return value

since: 2.0.00

Set the CW$r->mtime field to the specified value if it's later than what's already there.

  $r->update_mtime($mtime);

ret: no return value

since: 2.0.00

See also: $r->set_last_modified.

CWApache2::Response 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. Send an error response back to client. It is used for any response that can be generated by the server from the request record. This includes all 204 (no content), 3xx (redirect), 4xx (client error), and 5xx (server error) messages that have not been redirected to another handler via the ErrorDocument feature.

  $r->send_error_response($recursive_error);

ret: no return value

since: 2.0.00

META: it's really an internal Apache method, I'm not quite sure how can it be used externally. META: Autogenerated - needs to be reviewed/completed

Send an MMAP'ed file to the client

  $ret = $r->send_mmap($mm, $offset, $length);

since: 2.0.00

META: requires a working APR::Mmap, which is not supported at the moment.

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.