=head1 DESCRIPTION
This is the Catalyst Response class, which provides methods for responding to
-the current client request.
+the current client request. The appropriate L<Catalyst::Engine> for your environment
+will turn the Catalyst::Response into a HTTP Response and return it to the client.
=head1 METHODS
-=head2 $res->body($text)
+=head2 $res->body(<$text|$fh|$iohandle_object)
$c->response->body('Catalyst rocks!');
-Sets or returns the output (text or binary data).
+Sets or returns the output (text or binary data). If you are returning a large body,
+you might want to use a L<IO::Handle> type of object (Something that implements the read method
+in the same fashion), or a filehandle GLOB. Catalyst
+will write it piece by piece into the response.
=head2 $res->content_encoding
Shortcut for $res->headers->content_type.
+This value is typically set by your view or plugin. For example,
+L<Catalyst::Plugin::Static::Simple> will guess the mime type based on the file
+it found, while L<Catalyst::View::TT> defaults to C<text/html>.
+
=head2 $res->cookies
Returns a reference to a hash containing cookies to be set. The keys of the
parameters of the same name, except they are used without a leading dash.
Possible parameters are:
-=head2 value
+=over
+
+=item value
+
+=item expires
-=head2 expires
+=item domain
-=head2 domain
+=item path
-=head2 path
+=item secure
-=head2 secure
+=back
=head2 $res->header
=head2 $res->redirect( $url, $status )
-Causes the response to redirect to the specified URL.
+Causes the response to redirect to the specified URL. The default status is
+C<302>.
$c->response->redirect( 'http://slashdot.org' );
$c->response->redirect( 'http://slashdot.org', 307 );
+This is a convenience method that sets the Location header to the
+redirect destination, and then sets the response status. You will
+want to C< return; > or C< $c->detach() > to interrupt the normal
+processing flow if you want the redirect to occur straight away.
+
=cut
sub redirect {
=head1 AUTHORS
-Sebastian Riedel, C<sri@cpan.org>
-
-Marcus Ramberg, C<mramberg@cpan.org>
+Catalyst Contributors, see Catalyst.pm
=head1 COPYRIGHT