Overview

• module Falcon
  • module Body
    • class RequestFinished < Protocol::HTTP::Body::Wrapper

      Wraps a response body and decrements a metric after the body is closed.
  • module Command
    • class Host < Samovar::Command

      Implements the falcon host command. Designed for deployment.
    • module Paths

      A helper for resolving wildcard configuration paths.
    • class Proxy < Samovar::Command

      Implements the falcon proxy command.

      • options

        The command line options.
    • class Redirect < Samovar::Command

      Implements the falcon redirect command.

      • options

        The command line options.
    • class Serve < Samovar::Command

      Implements the falcon serve command. Designed for development.

      • options

        The command line options.
    • class Top < Samovar::Command

      The top level command for the falcon executable.

      • options

        The command line options.
    • class Virtual < Samovar::Command

      Implements the falcon virtual command. Designed for deployment.

      • options

        The command line options.
  • class CompositeServer

    A composite server that manages multiple class Falcon::Server instances.
  • class Endpoint < Async::HTTP::Endpoint

    An HTTP-specific endpoint which adds localhost TLS.
  • module Environment

    Pre-defined environments for hosting web applications.

    • module Application

      Provides an environment for hosting a web application that uses TLS.
    • module Cluster

      Provides an environment for hosting a cluster of Falcon server workers, where each worker binds its own endpoint.
    • module Configured

      This module provides a common interface for configuring the Falcon application.
    • module LetsEncryptTLS

      Provides an environment that uses "Lets Encrypt" for TLS.
    • module Proxy

      Provides an environment for hosting a TLS-capable reverse proxy using SNI.
    • module Rack

      Provides an environment for hosting a web application that use a Rackup config.ru file.
    • module Rackup

      Provides an environment for hosting loading a Rackup config.ru file.
    • module Redirect

      Provides an environment for redirecting insecure web traffic to a secure endpoint.
    • module SelfSignedTLS

      Provides an environment that exposes a self-signed TLS certificate using the localhost gem.
    • module Serve

      Provides application configuration discovery and loading for falcon serve.
    • module Server

      Provides an environment for hosting a web application that uses a Falcon server.
    • module TLS

      Provides an environment that exposes a TLS context for hosting a secure web application.
    • module Virtual

      Provides an environment for running virtual hosts with front-end proxy and redirect services.
  • class Listener

    Describes a bound listener for a Falcon server.
  • module Middleware
    • module BadRequest

      A static middleware which always returns a 400 bad request response.
    • class Proxy < Protocol::HTTP::Middleware

      A HTTP middleware for proxying requests to a given set of hosts.
    • module NotFound

      A static middleware which always returns a 404 not found response.
    • class Redirect < Protocol::HTTP::Middleware

      A HTTP middleware for redirecting a given set of hosts to a different endpoint.
    • class Verbose < Protocol::HTTP::Middleware

      A HTTP middleware for logging requests and responses.
  • class ProxyEndpoint < ::IO::Endpoint::Generic

    An endpoint suitable for proxing requests, typically via a unix pipe.
  • module Rackup
    • class Handler

      The falcon adaptor for the rackup executable.
  • class Railtie < Rails::Railtie

    Rails integration for Falcon, configuring ActiveSupport to use fiber-based isolation.
  • class Server < Async::HTTP::Server

    A server listening on a specific endpoint, hosting a specific middleware.
  • module Service
    • class Cluster < Server

      A managed service for running Falcon workers with independently bound endpoints.
    • class Server < Async::Service::Managed::Service

      A managed service for running Falcon servers.
    • class Virtual < Async::Service::Generic

      A controller which mananages several virtual hosts.
  • module TLS

    TLS configuration and cipher suites for Falcon servers.
• module Rack
  • module Handler
    • class Falcon < ::Falcon::Rackup::Handler

      Rack (v2) expects the constant to be in the Rack::Handler namespace, so we define a new handler class in the Rack::Handler namespace that inherits from Falcon::Rackup::Handler.
• module Rackup
  • module Handler
    • class Falcon < ::Falcon::Rackup::Handler

      Sinatra (and possibly others) try to extract the name using the final part of the class path, so we define a new class in the Rack::Handler namespace that inherits from Falcon::Rackup::Handler, that follows that convention.
• Provider