NAME

HTTP::Engine - Web Server Gateway Interface and HTTP Server Engine Drivers (Yet Another Catalyst::Engine)

SYNOPSIS

  use HTTP::Engine;
  my $engine = HTTP::Engine->new(
      interface => {
          module => 'ServerSimple',
          args   => {
              host => 'localhost',
              port =>  1978,
          },
          request_handler => 'main::handle_request',# or CODE ref
      },
  );
  $engine->run;

  use Data::Dumper;
  sub handle_request {
      my $req = shift;
      HTTP::Engine::Response->new( body => Dumper($req) );
  }

MILESTONE

0.x.x

A substantial document. (A tutorial, the Cookbook and hacking HowTo)

0.1.x (Now here)

Improvement in performance and resource efficiency. Most specifications are frozen. The specification is changed by the situation.

I want to perform Async support. (AnyEvent? Danga::Socket? IO::Async?)

0.1.4

switched to Any::Moose

0.0.99_x

It is an adjustment stage to the following version.

0.0.x

Version 0.0.x is a concept release, the internal interface is still fluid. It is mostly based on the code of Catalyst::Engine.

COMPATIBILITY

version over 0.0.13 is incompatible of version under 0.0.12.

using HTTP::Engine::Compat module if you want compatibility of version under 0.0.12.

version 0.0.13 is unsupported of context and middleware.

MIDDLEWARE

Middleware can be used if you wish. Please see HTTP::Engine::Middleware.

DESCRIPTION

HTTP::Engine abstracts handling the input and output of various web server environments, including CGI, mod_perl and FastCGI.

While some people use <CGI.pm> in a CGI environment, but switch <Apache::Request> under mod_perl for better performance, these HTTP request abstractions have incompatible interfaces, so it is not easy to switch between them.

HTTP::Engine will prepare a HTTP::Engine::Request object for you which is optimized for your current environment, and pass that to your request handler. Your request handler than prepares a HTTP::Engine::Response object, which we communicate back to the server for you.

HTTP::Engine::Request covers the bases of common request process tasks, like handling GET and POST parameters and processing file uploads. Unlike CGI.pm, but like most other web programming languages, it allows you to mix GET and POST parameters.

And importantly, it allows you to seamlessly move your code from CGI to a persistent without rewriting your code. At the same time, you'll maintain the possibility of additional performance benefits, as HTTP::Engine can transparently take advantage of native mod_perl functions when they are available.

COMMUNITY

The community can be found via:

  IRC: irc.perl.org#http-engine irc.freenode.net#coderepos

  Mailing list: http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/http-engine

  GitHub: http://github.com/http-engine/HTTP-Engine

  Twitter: http://twitter.com/httpengine

The following things are no longer used

  Wiki Page: http://coderepos.org/share/wiki/HTTP%3A%3AEngine

  SVN: http://svn.coderepos.org/share/lang/perl/HTTP-Engine  

  Trac: http://coderepos.org/share/browser/lang/perl/HTTP-Engine

FOLLOWER DOCUMENTS

http://en.wikibooks.org/wiki/Perl_Programming/HTTP::Engine writing by gugod++.

INTERFACES

Interfaces are the actual environment-dependent components which handles the actual interaction between your clients and the application.

For example, in CGI mode, you can write to STDOUT and expect your clients to see it, but in mod_perl, you may need to use $r->print instead.

Interfaces are the actual layers that does the interaction. HTTP::Engine currently supports the following:

# XXX TODO: Update the list

HTTP::Engine::Interface::ServerSimple

HTTP::Engine::Interface::FastCGI

HTTP::Engine::Interface::CGI

HTTP::Engine::Interface::Test

for test code interface

HTTP::Engine::Interface::ModPerl

experimental

HTTP::Engine::Interface::Standalone

old style

Interfaces can be specified as part of the HTTP::Engine constructor:

  my $interface = HTTP::Engine::Interface::FastCGI->new(
    request_handler => ...
  );
  HTTP::Engine->new(
    interface => $interface
  )->run();

Or you can let HTTP::Engine instantiate the interface for you:

  HTTP::Engine->new(
    interface => {
      module => 'FastCGI',
      args   => {
      }
      request_handler => ...
    }
  )->run();

CONCEPT

HTTP::Engine is Not

    session manager
    authentication manager
    URL dispatcher
    model manager
    toy
    black magick

HTTP::Engine is

    HTTP abstraction layer

HTTP::Engine's ancestry

    WSGI
    Rack

AUTHOR

Kazuhiro Osawa <yappo <at> shibuya <döt> pl>

Daisuke Maki

tokuhirom

nyarla

marcus

hidek

dann

typester (Interface::FCGI)

lopnor

nothingmuch

kan

Mark Stosberg (documentation)

walf443

kawa0117

mattn

otsune

gugod

stevan

hirose31

fujiwara

SEE ALSO

HTTP::Engine::Middleware, HTTP::Engine::Compat, HTTPEx::Declare, Any::Moose, Mouse, Moose

REPOSITORY

We moved to GitHub.

  git clone git://github.com/http-engine/HTTP-Engine.git

HTTP::Engine's Git repository is hosted at http://github.com/http-engine/HTTP-Engine. patches and collaborators are welcome.

LICENSE

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

cpanm HTTP::Engine

perl -MCPAN -e shell
install HTTP::Engine