1Catalyst::Engine(3)   User Contributed Perl Documentation  Catalyst::Engine(3)
2
3
4

NAME

6       Catalyst::Engine - The Catalyst Engine
7

SYNOPSIS

9       See Catalyst.
10

DESCRIPTION

METHODS
13   $self->finalize_body($c)
14       Finalize body.  Prints the response output.
15
16   $self->finalize_cookies($c)
17       Create CGI::Simple::Cookie objects from $c->res->cookies, and set them
18       as response headers.
19
20   $self->finalize_error($c)
21       Output an appropriate error message. Called if there's an error in $c
22       after the dispatch has finished. Will output debug messages if Catalyst
23       is in debug mode, or a `please come back later` message otherwise.
24
25   $self->finalize_headers($c)
26       Abstract method, allows engines to write headers to response
27
28   $self->finalize_read($c)
29   $self->finalize_uploads($c)
30       Clean up after uploads, deleting temp files.
31
32   $self->prepare_body($c)
33       sets up the Catalyst::Request object body using HTTP::Body
34
35   $self->prepare_body_chunk($c)
36       Add a chunk to the request body.
37
38   $self->prepare_body_parameters($c)
39       Sets up parameters from body.
40
41   $self->prepare_connection($c)
42       Abstract method implemented in engines.
43
44   $self->prepare_cookies($c)
45       Parse cookies from header. Sets a CGI::Simple::Cookie object.
46
47   $self->prepare_headers($c)
48   $self->prepare_parameters($c)
49       sets up parameters from query and post parameters.
50
51   $self->prepare_path($c)
52       abstract method, implemented by engines.
53
54   $self->prepare_request($c)
55   $self->prepare_query_parameters($c)
56       process the query string and extract query parameters.
57
58   $self->prepare_read($c)
59       prepare to read from the engine.
60
61   $self->prepare_request(@arguments)
62       Populate the context object from the request object.
63
64   $self->prepare_uploads($c)
65   $self->prepare_write($c)
66       Abstract method. Implemented by the engines.
67
68   $self->read($c, [$maxlength])
69       Reads from the input stream by calling "$self->read_chunk".
70
71       Maintains the read_length and read_position counters as data is read.
72
73   $self->read_chunk($c, $buffer, $length)
74       Each engine implements read_chunk as its preferred way of reading a
75       chunk of data. Returns the number of bytes read. A return of 0
76       indicates that there is no more data to be read.
77
78   $self->read_length
79       The length of input data to be read.  This is obtained from the
80       Content-Length header.
81
82   $self->read_position
83       The amount of input data that has already been read.
84
85   $self->run($c)
86       Start the engine. Implemented by the various engine classes.
87
88   $self->write($c, $buffer)
89       Writes the buffer to the client.
90
91   $self->unescape_uri($uri)
92       Unescapes a given URI using the most efficient method available.
93       Engines such as Apache may implement this using Apache's C-based
94       modules, for example.
95
96   $self->finalize_output
97       <obsolete>, see finalize_body
98
99   $self->env
100       Hash containing environment variables including many special variables
101       inserted by WWW server - like SERVER_*, REMOTE_*, HTTP_* ...
102
103       Before accessing environment variables consider whether the same
104       information is not directly available via Catalyst objects $c->request,
105       $c->engine ...
106
107       BEWARE: If you really need to access some environment variable from
108       your Catalyst application you should use $c->engine->env->{VARNAME}
109       instead of $ENV{VARNAME}, as in some enviroments the %ENV hash does not
110       contain what you would expect.
111

AUTHORS
113       Catalyst Contributors, see Catalyst.pm
114

116       This library is free software. You can redistribute it and/or modify it
117       under the same terms as Perl itself.
118
119
120
121perl v5.12.1                      2010-07-28               Catalyst::Engine(3)



        

    


            
        

        

            Impressum