mod_perl logo perl icon
previous page: Apache2::RequestUtil - Perl API for Apache request record utilspage up: mod_perl 2.0 APInext page: Apache2::ServerRec - Perl API for Apache server record accessors

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






Writing Apache Modules with Perl and C

Writing Apache Modules with Perl and C

By Lincoln Stein, Doug MacEachern
Embedding Perl in HTML with Mason

Embedding Perl in HTML with Mason

By Dave Rolsky, Ken Williams
mod_perl2 User's Guide

mod_perl2 User's Guide

By Stas Bekman, Jim Brandt
Practical mod_perl

Practical mod_perl

By Stas Bekman, Eric Cholet
The mod_perl Developer's Cookbook

The mod_perl Developer's Cookbook

By Geoffrey Young, Paul Lindner, Randy Kobes
mod_perl Pocket Reference

mod_perl Pocket Reference

By Andrew Ford


Table of Contents

Synopsis

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


TOP

Description

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



TOP

API

Apache2::Response provides the following functions and/or methods:



TOP

custom_response

Install a custom response handler for a given status

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

custom_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


TOP

make_etag

Construct an entity tag from the resource information. If it's a real file, build in some of the file characteristics.

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


TOP

meets_conditions

Implements condition GET 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();

Refer to the Generating Correct HTTP Headers document for an indepth discussion of this method.



TOP

rationalize_mtime

Return the latest rational time from a request/mtime pair.

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


TOP

send_cgi_header

Parse the header

  $r->send_cgi_header($buffer);

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 print()).

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



TOP

set_content_length

Set the content length for this request.

  $r->set_content_length($length);


TOP

set_etag

Set the E-tag outgoing header

  $r->set_etag();


TOP

set_keepalive

Set the keepalive status for this request

  $ret = $r->set_keepalive();

It's called by ap_http_header_filter(). For the complete complicated logic implemented by this method see httpd-2.0/server/http_protocol.c.



TOP

set_last_modified

sets the Last-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);


TOP

update_mtime

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

  $r->update_mtime($mtime);

See also: $r->set_last_modified.



TOP

Unsupported API

Apache2::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.



TOP

send_error_response

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

META: it's really an internal Apache method, I'm not quite sure how can it be used externally.



TOP

send_mmap

META: Autogenerated - needs to be reviewed/completed

Send an MMAP'ed file to the client

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

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



TOP

See Also

mod_perl 2.0 documentation.



TOP

Copyright

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



TOP

Authors

The mod_perl development team and numerous contributors.






TOP
previous page: Apache2::RequestUtil - Perl API for Apache request record utilspage up: mod_perl 2.0 APInext page: Apache2::ServerRec - Perl API for Apache server record accessors