NAME

Catalyst::Engine - The Catalyst Engine

SYNOPSIS

See Catalyst.

DESCRIPTION

METHODS

$self->finalize_body($c)

Finalize body. Prints the response output.

$self->finalize_cookies($c)

Create CGI::Simple::Cookie objects from $c->res->cookies, and set them as response headers.

$self->finalize_error($c)

Output an appropriate error message. Called if there's an error in $c after the dispatch has finished. Will output debug messages if Catalyst is in debug mode, or a `please come back later` message otherwise.

$self->finalize_headers($c)

Abstract method, allows engines to write headers to response

$self->finalize_read($c)

$self->finalize_uploads($c)

Clean up after uploads, deleting temp files.

$self->prepare_body($c)

sets up the Catalyst::Request object body using HTTP::Body

$self->prepare_body_chunk($c)

Add a chunk to the request body.

$self->prepare_body_parameters($c)

Sets up parameters from body.

$self->prepare_connection($c)

Abstract method implemented in engines.

$self->prepare_cookies($c)

Parse cookies from header. Sets a CGI::Simple::Cookie object.

$self->prepare_headers($c)

$self->prepare_parameters($c)

sets up parameters from query and post parameters.

$self->prepare_path($c)

abstract method, implemented by engines.

$self->prepare_request($c)

$self->prepare_query_parameters($c)

process the query string and extract query parameters.

$self->prepare_read($c)

prepare to read from the engine.

$self->prepare_request(@arguments)

Populate the context object from the request object.

$self->prepare_uploads($c)

$self->prepare_write($c)

Abstract method. Implemented by the engines.

$self->read($c, [$maxlength])

$self->read_chunk($c, $buffer, $length)

Each engine inplements read_chunk as its preferred way of reading a chunk of data.

$self->read_length

The length of input data to be read. This is obtained from the Content-Length header.

$self->read_position

The amount of input data that has already been read.

$self->run($c)

Start the engine. Implemented by the various engine classes.

$self->write($c, $buffer)

Writes the buffer to the client.

$self->unescape_uri($uri)

Unescapes a given URI using the most efficient method available. Engines such as Apache may implement this using Apache's C-based modules, for example.

$self->finalize_output

<obsolete>, see finalize_body

AUTHORS

Catalyst Contributors, see Catalyst.pm

COPYRIGHT

This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself.

cpanm Catalyst::Runtime

perl -MCPAN -e shell
install Catalyst::Runtime