Parent

Namespace

Rack::Server

Attributes

options[W]

Public Class Methods

logging_middleware() click to toggle source
# File lib/rack/server.rb, line 202
def self.logging_middleware
  lambda { |server|
    server.server.name =~ /CGI/ ? nil : [Rack::CommonLogger, $stderr]
  }
end
middleware() click to toggle source
# File lib/rack/server.rb, line 208
def self.middleware
  @middleware ||= begin
    m = Hash.new {|h,k| h[k] = []}
    m["deployment"].concat [
      [Rack::ContentLength],
      [Rack::Chunked],
      logging_middleware
    ]
    m["development"].concat m["deployment"] + [[Rack::ShowExceptions], [Rack::Lint]]
    m
  end
end
new(options = nil) click to toggle source

Options may include:

  • :app

    a rack application to run (overrides :config)
  • :config

    a rackup configuration file path to load (.ru)
  • :environment

    this selects the middleware that will be wrapped around
    your application. Default options available are:
      - development: CommonLogger, ShowExceptions, and Lint
      - deployment: CommonLogger
      - none: no extra middleware
    note: when the server is a cgi server, CommonLogger is not included.
  • :server

    choose a specific Rack::Handler, e.g. cgi, fcgi, webrick
  • :daemonize

    if true, the server will daemonize itself (fork, detach, etc)
  • :pid

    path to write a pid file after daemonize
  • :Host

    the host address to bind to (used by supporting Rack::Handler)
  • :Port

    the port to bind to (used by supporting Rack::Handler)
  • :AccessLog

    webrick acess log options (or supporting Rack::Handler)
  • :debug

    turn on debug output ($DEBUG = true)
  • :warn

    turn on warnings ($-w = true)
  • :include

    add given paths to $LOAD_PATH
  • :require

    require the given libraries
# File lib/rack/server.rb, line 178
def initialize(options = nil)
  @options = options
  @app = options[:app] if options && options[:app]
end
start(options = nil) click to toggle source

Start a new rack server (like running rackup). This will parse ARGV and provide standard ARGV rackup options, defaulting to load ‘config.ru’.

Providing an options hash will prevent ARGV parsing and will not include any default options.

This method can be used to very easily launch a CGI application, for example:

Rack::Server.start(
  :app => lambda do |e|
    [200, {'Content-Type' => 'text/html'}, ['hello world']]
  end,
  :server => 'cgi'
)

Further options available here are documented on Rack::Server#initialize

# File lib/rack/server.rb, line 140
def self.start(options = nil)
  new(options).start
end

Public Instance Methods

app() click to toggle source
# File lib/rack/server.rb, line 198
def app
  @app ||= options[:builder] ? build_app_from_string : build_app_and_options_from_config
end
default_options() click to toggle source
# File lib/rack/server.rb, line 187
def default_options
  {
    :environment => ENV['RACK_ENV'] || "development",
    :pid         => nil,
    :Port        => 9292,
    :Host        => "0.0.0.0",
    :AccessLog   => [],
    :config      => "config.ru"
  }
end
middleware() click to toggle source
# File lib/rack/server.rb, line 221
def middleware
  self.class.middleware
end
options() click to toggle source
# File lib/rack/server.rb, line 183
def options
  @options ||= parse_options(ARGV)
end
server() click to toggle source
# File lib/rack/server.rb, line 267
def server
  @_server ||= Rack::Handler.get(options[:server]) || Rack::Handler.default(options)
end
start(&blk) click to toggle source
# File lib/rack/server.rb, line 225
def start &blk
  if options[:warn]
    $-w = true
  end

  if includes = options[:include]
    $LOAD_PATH.unshift(*includes)
  end

  if library = options[:require]
    require library
  end

  if options[:debug]
    $DEBUG = true
    require 'pp'
    p options[:server]
    pp wrapped_app
    pp app
  end

  check_pid! if options[:pid]

  # Touch the wrapped app, so that the config.ru is loaded before
  # daemonization (i.e. before chdir, etc).
  wrapped_app

  daemonize_app if options[:daemonize]

  write_pid if options[:pid]

  trap(:INT) do
    if server.respond_to?(:shutdown)
      server.shutdown
    else
      exit
    end
  end

  server.run wrapped_app, options, &blk
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.