AnyEvent-HTTPD

 view release on metacpan or  search on metacpan

README  view on Meta::CPAN

NAME
    AnyEvent::HTTPD - A simple lightweight event based web (application)
    server

VERSION
    Version 0.93

SYNOPSIS
        use AnyEvent::HTTPD;

        my $httpd = AnyEvent::HTTPD->new (port => 9090);

        $httpd->reg_cb (
           '/' => sub {
              my ($httpd, $req) = @_;

              $req->respond ({ content => ['text/html',
                 "<html><body><h1>Hello World!</h1>"
                 . "<a href=\"/test\">another test page</a>"
                 . "</body></html>"
              ]});
           },
           '/test' => sub {
              my ($httpd, $req) = @_;

              $req->respond ({ content => ['text/html',
                 "<html><body><h1>Test page</h1>"
                 . "<a href=\"/\">Back to the main page</a>"
                 . "</body></html>"
              ]});
           },
        );

        $httpd->run; # making a AnyEvent condition variable would also work

DESCRIPTION
    This module provides a simple HTTPD for serving simple web application
    interfaces. It's completly event based and independend from any event
    loop by using the AnyEvent module.

    It's HTTP implementation is a bit hacky, so before using this module
    make sure it works for you and the expected deployment. Feel free to
    improve the HTTP support and send in patches!

    The documentation is currently only the source code, but next versions
    of this module will be better documented hopefully. See also the
    "samples/" directory in the AnyEvent::HTTPD distribution for basic
    starting points.

FEATURES
    *   support for GET and POST requests.

    *   support for HTTP 1.0 keep-alive.

    *   processing of "x-www-form-urlencoded" and "multipart/form-data"
        ("multipart/mixed") encoded form parameters.

    *   support for streaming responses.

    *   with version 0.8 no more dependend on LWP for HTTP::Date.

    *   (limited) support for SSL

METHODS
    The AnyEvent::HTTPD class inherits directly from
    AnyEvent::HTTPD::HTTPServer which inherits the event callback interface
    from Object::Event.

    Event callbacks can be registered via the Object::Event API (see the
    documentation of Object::Event for details).

    For a list of available events see below in the *EVENTS* section.

    new (%args)
        This is the constructor for a AnyEvent::HTTPD object. The %args hash
        may contain one of these key/value pairs:

        host => $host
            The TCP address of the HTTP server will listen on. Usually
            0.0.0.0 (the default), for a public server, or 127.0.0.1 for a
            local server.

        port => $port
            The TCP port the HTTP server will listen on. If undefined some
            free port will be used. You can get it via the "port" method.

        ssl => $tls_ctx
            If this option is given the server will listen for a SSL/TLS
            connection on the configured port. As $tls_ctx you can pass
            anything that you can pass as "tls_ctx" to an AnyEvent::Handle
            object.

            Example:

               my $httpd =
                  AnyEvent::HTTPD->new (
                     port => 443,
                     ssl  => { cert_file => "/path/to/my/server_cert_and_key.pem" }
                  );

            Or:

               my $httpd =
                  AnyEvent::HTTPD->new (
                     port => 443,
                     ssl  => AnyEvent::TLS->new (...),
                  );

        request_timeout => $seconds
            This will set the request timeout for connections. The default
            value is 60 seconds.

        backlog => $int
            The backlog argument defines the maximum length the queue of
            pending connections may grow to. The real maximum queue length
            will be 1.5 times more than the value specified in the backlog
            argument.



( run in 0.940 second using v1.01-cache-2.11-cpan-39bf76dae61 )