Class: Puma::Runner
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
Const::PipeRequest
|
|
Inherits: | Object |
Defined in: | lib/puma/runner.rb |
Overview
Generic class that is used by Cluster
and Single
to serve requests. This class spawns a new instance of Server
via a call to #start_server.
Constant Summary
Const::PipeRequest
- Included
PIPE_BOOT, PIPE_EXTERNAL_TERM, PIPE_FORK, PIPE_IDLE, PIPE_PING, PIPE_TERM, PIPE_WAKEUP
Class Method Summary
- .new(launcher) ⇒ Runner constructor
Instance Attribute Summary
- #app readonly
- #development? ⇒ Boolean readonly
-
#options ⇒ Puma::UserFileDefaultOptions
readonly
Returns the hash of configuration options.
- #redirected_io? ⇒ Boolean readonly
-
#ruby_engine
readonly
deprecated
Deprecated.
Use
RUBY_DESCRIPTION
instead - #test? ⇒ Boolean readonly
Instance Method Summary
- #close_control_listeners
- #debug(str)
- #error(str)
- #load_and_bind
- #log(str)
- #output_header(mode)
- #redirect_io
- #start_control
- #start_server
- #stop_control
- #wakeup!
-
#debug_loaded_extensions(str)
private
this method call should always be guarded by
@log_writer.debug?
. - #ensure_output_directory_exists(path, io_name) private
- #stats private
- #utc_iso8601(val) private
Constructor Details
.new(launcher) ⇒ Runner
# File 'lib/puma/runner.rb', line 14
def initialize(launcher) @launcher = launcher @log_writer = launcher.log_writer @events = launcher.events @config = launcher.config @options = launcher. @app = nil @control = nil @started_at = Time.now @wakeup = nil end
Instance Attribute Details
#app (readonly)
[ GitHub ]# File 'lib/puma/runner.rb', line 179
def app @app ||= @config.app end
#development? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/puma/runner.rb', line 39
def development? @options[:environment] == "development" end
#options ⇒ Puma::UserFileDefaultOptions (readonly)
Returns the hash of configuration options.
# File 'lib/puma/runner.rb', line 28
attr_reader :
#redirected_io? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/puma/runner.rb', line 131
def redirected_io? @options[:redirect_stdout] || @options[:redirect_stderr] end
#ruby_engine (readonly)
Deprecated.
Use RUBY_DESCRIPTION
instead
# File 'lib/puma/runner.rb', line 98
def ruby_engine warn "Puma::Runner#ruby_engine is deprecated; use RUBY_DESCRIPTION instead. It will be removed in puma v7." if !defined?(RUBY_ENGINE) || RUBY_ENGINE == "ruby" "ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" else if defined?(RUBY_ENGINE_VERSION) "#{RUBY_ENGINE} #{RUBY_ENGINE_VERSION} - ruby #{RUBY_VERSION}" else "#{RUBY_ENGINE} #{RUBY_VERSION}" end end end
#test? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/puma/runner.rb', line 43
def test? @options[:environment] == "test" end
Instance Method Details
#close_control_listeners
# File 'lib/puma/runner.rb', line 92
def close_control_listeners @control.binder.close_listeners if @control end
#debug(str)
[ GitHub ]# File 'lib/puma/runner.rb', line 60
def debug(str) @log_writer.log "- #{str}" if @options[:debug] end
#debug_loaded_extensions(str) (private)
this method call should always be guarded by @log_writer.debug?
#ensure_output_directory_exists(path, io_name) (private)
[ GitHub ]# File 'lib/puma/runner.rb', line 190
def ensure_output_directory_exists(path, io_name) unless Dir.exist?(File.dirname(path)) raise "Cannot redirect #{io_name} to #{path}" end end
#error(str)
[ GitHub ]# File 'lib/puma/runner.rb', line 56
def error(str) @log_writer.error str end
#load_and_bind
[ GitHub ]# File 'lib/puma/runner.rb', line 162
def load_and_bind unless @config.app_configured? error "No application configured, nothing to run" exit 1 end begin @app = @config.app rescue Exception => e log "! Unable to load application: #{e.class}: #{e.}" raise e end @launcher.binder.parse @options[:binds] end
#log(str)
[ GitHub ]# File 'lib/puma/runner.rb', line 47
def log(str) @log_writer.log str end
#output_header(mode)
[ GitHub ]# File 'lib/puma/runner.rb', line 112
def output_header(mode) min_t = @options[:min_threads] max_t = @options[:max_threads] environment = @options[:environment] log "Puma starting in #{mode} mode..." log "* Puma version: #{Puma::Const::PUMA_VERSION} (\"#{Puma::Const::CODE_NAME}\")" log "* Ruby version: #{RUBY_DESCRIPTION}" log "* Min threads: #{min_t}" log "* Max threads: #{max_t}" log "* Environment: #{environment}" if mode == "cluster" log "* Master PID: #{Process.pid}" else log "* PID: #{Process.pid}" end end
#redirect_io
[ GitHub ]# File 'lib/puma/runner.rb', line 135
def redirect_io stdout = @options[:redirect_stdout] stderr = @options[:redirect_stderr] append = @options[:redirect_append] if stdout ensure_output_directory_exists(stdout, 'STDOUT') STDOUT.reopen stdout, (append ? "a" : "w") STDOUT.puts "=== puma startup: #{Time.now} ===" STDOUT.flush unless STDOUT.sync end if stderr ensure_output_directory_exists(stderr, 'STDERR') STDERR.reopen stderr, (append ? "a" : "w") STDERR.puts "=== puma startup: #{Time.now} ===" STDERR.flush unless STDERR.sync end if @options[:mutate_stdout_and_stderr_to_sync_on_write] STDOUT.sync = true STDERR.sync = true end end
#start_control
[ GitHub ]# File 'lib/puma/runner.rb', line 64
def start_control str = @options[:control_url] return unless str require_relative 'app/status' if token = @options[:control_auth_token] token = nil if token.empty? || token == 'none' end app = Puma::App::Status.new @launcher, token # A Reactor is not created and nio4r is not loaded when 'queue_requests: false' # Use `nil` for events, no hooks in control server control = Puma::Server.new app, nil, { min_threads: 0, max_threads: 1, queue_requests: false, log_writer: @log_writer } begin control.binder.parse [str], nil, 'Starting control server' rescue Errno::EADDRINUSE, Errno::EACCES => e raise e, "Error: Control server address '#{str}' is already in use. Original error: #{e.}" end control.run thread_name: 'ctl' @control = control end
#start_server
[ GitHub ]#stats (private)
[ GitHub ]# File 'lib/puma/runner.rb', line 200
def stats { versions: { puma: Puma::Const::PUMA_VERSION, ruby: { engine: RUBY_ENGINE, version: RUBY_VERSION, patchlevel: RUBY_PATCHLEVEL } } } end
#stop_control
# File 'lib/puma/runner.rb', line 52
def stop_control @control&.stop true end
#utc_iso8601(val) (private)
[ GitHub ]# File 'lib/puma/runner.rb', line 196
def utc_iso8601(val) "#{val.utc.strftime '%FT%T'}Z" end
#wakeup!
[ GitHub ]# File 'lib/puma/runner.rb', line 30
def wakeup! return unless @wakeup @wakeup.write PIPE_WAKEUP unless @wakeup.closed? rescue SystemCallError, IOError Puma::Util.purge_interrupt_queue end