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
15       Finalize body.  Prints the response output.
16
17       $self->finalize_cookies($c)
18
19       Create CGI::Simple::Cookie objects from $c->res->cookies, and set them
20       as response headers.
21
22       $self->finalize_error($c)
23
24       Output an apropriate error message, called if there's an error in $c
25       after the dispatch has finished. Will output debug messages if Catalyst
26       is in debug mode, or a `please come back later` message otherwise.
27
28       $self->finalize_headers($c)
29
30       Abstract method, allows engines to write headers to response
31
32       $self->finalize_read($c)
33
34       $self->finalize_uploads($c)
35
36       Clean up after uploads, deleting temp files.
37
38       $self->prepare_body($c)
39
40       sets up the Catalyst::Request object body using HTTP::Body
41
42       $self->prepare_body_chunk($c)
43
44       Add a chunk to the request body.
45
46       $self->prepare_body_parameters($c)
47
48       Sets up parameters from body.
49
50       $self->prepare_connection($c)
51
52       Abstract method implemented in engines.
53
54       $self->prepare_cookies($c)
55
56       Parse cookies from header. Sets a CGI::Simple::Cookie object.
57
58       $self->prepare_headers($c)
59
60       $self->prepare_parameters($c)
61
62       sets up parameters from query and post parameters.
63
64       $self->prepare_path($c)
65
66       abstract method, implemented by engines.
67
68       $self->prepare_request($c)
69
70       $self->prepare_query_parameters($c)
71
72       process the query string and extract query parameters.
73
74       $self->prepare_read($c)
75
76       prepare to read from the engine.
77
78       $self->prepare_request(@arguments)
79
80       Populate the context object from the request object.
81
82       $self->prepare_uploads($c)
83
84       $self->prepare_write($c)
85
86       Abstract method. Implemented by the engines.
87
88       $self->read($c, [$maxlength])
89
90       $self->read_chunk($c, $buffer, $length)
91
92       Each engine inplements read_chunk as its preferred way of reading a
93       chunk of data.
94
95       $self->read_length
96
97       The length of input data to be read.  This is obtained from the Con‐
98       tent-Length header.
99
100       $self->read_position
101
102       The amount of input data that has already been read.
103
104       $self->run($c)
105
106       Start the engine. Implemented by the various engine classes.
107
108       $self->write($c, $buffer)
109
110       Writes the buffer to the client.
111
112       $self->unescape_uri($uri)
113
114       Unescapes a given URI using the most efficient method available.
115       Engines such as Apache may implement this using Apache's C-based mod‐
116       ules, for example.
117
118       $self->finalize_output
119
120       <obsolete>, see finalize_body
121

AUTHORS
123       Sebastian Riedel, <sri@cpan.org>
124
125       Andy Grundman, <andy@hybridized.org>
126

128       This program is free software, you can redistribute it and/or modify it
129       under the same terms as Perl itself.
130
131
132
133perl v5.8.8                       2007-09-20               Catalyst::Engine(3)



        

    


            
        

        

            Impressum