Module: Unicorn
- Included in:
- Configurator
- Defined in:
- lib/unicorn.rb,
lib/unicorn/preread_input.rb
Overview
unicorn exposes very little of an user-visible API and most of its internals are subject to change. unicorn is designed to host Rack applications, so applications should be written against the Rack SPEC and not unicorn internals.
Defined Under Namespace
Modules: OobGC, Util Classes: Configurator, HttpServer, PrereadInput, StreamInput, TeeInput, Worker
Constant Summary collapse
- ClientShutdown =
Raised inside TeeInput when a client closes the socket inside the application dispatch. This is always raised with an empty backtrace since there is nothing in the application stack that is responsible for client shutdowns/disconnects. This exception is visible to Rack applications unless PrereadInput middleware is loaded. This is a subclass of the standard EOFError class and applications should not rescue it explicitly, but rescue EOFError instead.
Class.new(EOFError)
Class Method Summary collapse
-
.builder(ru, op) ⇒ Object
This returns a lambda to pass in as the app, this does not “build” the app (which we defer based on the outcome of “preload_app” in the Unicorn config).
-
.listener_names ⇒ Object
returns an array of strings representing TCP listen socket addresses and Unix domain socket paths.
- .log_error(logger, prefix, exc) ⇒ Object
-
.pipe ⇒ Object
remove this when we only support Ruby >= 2.0.
Class Method Details
.builder(ru, op) ⇒ Object
This returns a lambda to pass in as the app, this does not “build” the app (which we defer based on the outcome of “preload_app” in the Unicorn config). The returned lambda will be called when it is time to build the app.
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/unicorn.rb', line 39 def self.builder(ru, op) # allow Configurator to parse cli switches embedded in the ru file op = Unicorn::Configurator::RACKUP.merge!(:file => ru, :optparse => op) if ru =~ /\.ru$/ && !defined?(Rack::Builder) abort "rack and Rack::Builder must be available for processing #{ru}" end # Op is going to get cleared before the returned lambda is called, so # save this value so that it's still there when we need it: no_default_middleware = op[:no_default_middleware] # always called after config file parsing, may be called after forking lambda do || inner_app = case ru when /\.ru$/ raw = File.read(ru) raw.sub!(/^__END__\n.*/, '') eval("Rack::Builder.new {(\n#{raw}\n)}.to_app", TOPLEVEL_BINDING, ru) else require ru Object.const_get(File.basename(ru, '.rb').capitalize) end pp({ :inner_app => inner_app }) if $DEBUG return inner_app if no_default_middleware middleware = { # order matters ContentLength: nil, Chunked: nil, CommonLogger: [ $stderr ], ShowExceptions: nil, Lint: nil, TempfileReaper: nil, } # return value, matches rackup defaults based on env # Unicorn does not support persistent connections, but Rainbows! # and Zbatery both do. Users accustomed to the Rack::Server default # middlewares will need ContentLength/Chunked middlewares. case ENV["RACK_ENV"] when "development" when "deployment" middleware.delete(:ShowExceptions) middleware.delete(:Lint) else return inner_app end Rack::Builder.new do middleware.each do |m, args| use(Rack.const_get(m), *args) if Rack.const_defined?(m) end run inner_app end.to_app end end |
.listener_names ⇒ Object
returns an array of strings representing TCP listen socket addresses and Unix domain socket paths. This is useful for use with Raindrops::Middleware under Linux: raindrops.bogomips.org/
99 100 101 102 103 |
# File 'lib/unicorn.rb', line 99 def self.listener_names Unicorn::HttpServer::LISTENERS.map do |io| Unicorn::SocketHelper.sock_name(io) end + Unicorn::HttpServer::NEW_LISTENERS end |
.log_error(logger, prefix, exc) ⇒ Object
105 106 107 108 109 110 |
# File 'lib/unicorn.rb', line 105 def self.log_error(logger, prefix, exc) = exc. = .dump if /[[:cntrl:]]/ =~ logger.error "#{prefix}: #{} (#{exc.class})" exc.backtrace.each { |line| logger.error(line) } end |
.pipe ⇒ Object
remove this when we only support Ruby >= 2.0
113 114 115 |
# File 'lib/unicorn.rb', line 113 def self.pipe # :nodoc: Kgio::Pipe.new.each { |io| io.close_on_exec = true } end |