added synopsis to Engine subclassed and documented a couple of methods to make podcov...
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Engine / FCGI.pm
1 package Catalyst::Engine::FCGI;
2
3 use strict;
4 use base 'Catalyst::Engine::CGI';
5 use FCGI;
6
7 =head1 NAME
8
9 Catalyst::Engine::FCGI - Catalyst FCGI Engine
10
11 =head1 SYNOPSIS
12
13 A script using the Catalyst::Engine::FCGI module might look like:
14
15     #!/usr/bin/perl -w
16
17     BEGIN { 
18        $ENV{CATALYST_ENGINE} = 'FCGI';
19     }
20
21     use strict;
22     use lib '/path/to/MyApp/lib';
23     use MyApp;
24
25     MyApp->run;
26
27 =head1 DESCRIPTION
28
29 This is the Catalyst engine for FastCGI.
30
31 =head1 OVERLOADED METHODS
32
33 This class overloads some methods from C<Catalyst::Engine::CGI>.
34
35 =over 4
36
37 =item $c->run
38
39 =cut
40
41 sub run {
42     my $class   = shift;
43     my $request = FCGI::Request();
44     while ( $request->Accept() >= 0 ) {
45         $class->handler;
46     }
47 }
48
49 =back
50
51 =head1 SEE ALSO
52
53 L<Catalyst>.
54
55 =head1 AUTHOR
56
57 Sebastian Riedel, C<sri@cpan.org>
58
59 =head1 COPYRIGHT
60
61 This program is free software, you can redistribute it and/or modify it under
62 the same terms as Perl itself.
63
64 =cut
65
66 1;