Overview

• module Falcon
  • module Command
    • class Host

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

      A helper for resolving wildcard configuration paths.
    • class Proxy

      Implements the falcon proxy command.

      • options

        The command line options.
    • class Redirect
      • options

        The command line options.
    • class Serve

      Implements the falcon serve command. Designed for development.

      • options

        The command line options.
    • class Top

      The top level command for the falcon executable.

      • options

        The command line options.
    • class Virtual

      Implements the falcon virtual command. Designed for deployment.

      • options

        The command line options.
  • class Configuration

    Manages environments which describes how to host a specific application.

    • class Loader

      The domain specific language for loading configuration files.
  • class 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 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 Server

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

      Provides an environment for hosting a supervisor which can monitor multiple applications.
    • module TLS

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

      A static middleware which always returns a 400 bad request response.
    • class Proxy

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

      • Provider
    • module NotFound

      A static middleware which always returns a 404 not found response.
    • class Redirect

      A HTTP middleware for redirecting a given set of hosts to a different endpoint.

      • Provider
    • class Verbose

      A HTTP middleware for logging requests and responses.
  • class ProxyEndpoint

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

      The falcon adaptor for the rackup executable.
  • class Railtie
  • class Server

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

      A controller which mananages several virtual hosts.
  • module TLS
• module Rack
  • module Handler
    • class Falcon

      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

      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.