Class: Puma::Launcher
- Inherits:
-
Object
- Object
- Puma::Launcher
- Defined in:
- lib/puma/launcher.rb
Overview
Puma::Launcher is the single entry point for starting a Puma server based on user configuration. It is responsible for taking user supplied arguments and resolving them with configuration in ‘config/puma.rb` or `config/puma/<env>.rb`.
It is responsible for either launching a cluster of Puma workers or a single puma server.
Constant Summary collapse
- KEYS_NOT_TO_PERSIST_IN_STATE =
[ :logger, :lowlevel_error_handler, :before_worker_shutdown, :before_worker_boot, :before_worker_fork, :after_worker_boot, :before_fork, :on_restart ]
Instance Attribute Summary collapse
-
#binder ⇒ Object
readonly
Returns the value of attribute binder.
-
#config ⇒ Object
readonly
Returns the value of attribute config.
-
#events ⇒ Object
readonly
Returns the value of attribute events.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
-
#restart_dir ⇒ Object
readonly
Returns the value of attribute restart_dir.
Instance Method Summary collapse
-
#connected_port ⇒ Object
Return which tcp port the launcher is using, if it’s using TCP.
-
#delete_pidfile ⇒ Object
Delete the configured pidfile.
-
#halt ⇒ Object
Begin async shutdown of the server.
-
#initialize(conf, launcher_args = {}) ⇒ Launcher
constructor
Returns an instance of Launcher.
-
#phased_restart ⇒ Object
Begin a phased restart if supported.
-
#restart ⇒ Object
Begin async restart of the server.
- #restart_args ⇒ Object
-
#run ⇒ Object
Run the server.
-
#stats ⇒ Object
Return stats about the server.
-
#stop ⇒ Object
Begin async shutdown of the server gracefully.
-
#write_pid ⇒ Object
If configured, write the pid of the current process out to a file.
-
#write_state ⇒ Object
Write a state file that can be used by pumactl to control the server.
Constructor Details
#initialize(conf, launcher_args = {}) ⇒ Launcher
Returns an instance of Launcher
conf
A Puma::Configuration object indicating how to run the server.
launcher_args
A Hash that currently has one required key ‘:events`, this is expected to hold an object similar to an `Puma::Events.stdio`, this object will be responsible for broadcasting Puma’s internal state to a logging destination. An optional key ‘:argv` can be supplied, this should be an array of strings, these arguments are re-used when restarting the puma server.
Examples:
conf = Puma::Configuration.new do |c|
c.threads 1, 10
c.app do |env|
[200, {}, ["hello world"]]
end
end
Puma::Launcher.new(conf, argv: Puma::Events.stdio).run
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 |
# File 'lib/puma/launcher.rb', line 47 def initialize(conf, launcher_args={}) @runner = nil @events = launcher_args[:events] || Events::DEFAULT @argv = launcher_args[:argv] || [] @original_argv = @argv.dup @config = conf @binder = Binder.new(@events) @binder.import_from_env @environment = conf.environment # Advertise the Configuration Puma.cli_config = @config if defined?(Puma.cli_config) @config.load @options = @config. generate_restart_data if clustered? && (Puma.jruby? || Puma.windows?) unsupported 'worker mode not supported on JRuby or Windows' end if @options[:daemon] && Puma.windows? unsupported 'daemon mode not supported on Windows' end Dir.chdir(@restart_dir) prune_bundler if prune_bundler? @environment = @options[:environment] if @options[:environment] set_rack_environment if clustered? @events.formatter = Events::PidFormatter.new @options[:logger] = @events @runner = Cluster.new(self, @events) else @runner = Single.new(self, @events) end @status = :run end |
Instance Attribute Details
#binder ⇒ Object (readonly)
Returns the value of attribute binder.
95 96 97 |
# File 'lib/puma/launcher.rb', line 95 def binder @binder end |
#config ⇒ Object (readonly)
Returns the value of attribute config.
95 96 97 |
# File 'lib/puma/launcher.rb', line 95 def config @config end |
#events ⇒ Object (readonly)
Returns the value of attribute events.
95 96 97 |
# File 'lib/puma/launcher.rb', line 95 def events @events end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
95 96 97 |
# File 'lib/puma/launcher.rb', line 95 def @options end |
#restart_dir ⇒ Object (readonly)
Returns the value of attribute restart_dir.
95 96 97 |
# File 'lib/puma/launcher.rb', line 95 def restart_dir @restart_dir end |
Instance Method Details
#connected_port ⇒ Object
Return which tcp port the launcher is using, if it’s using TCP
189 190 191 |
# File 'lib/puma/launcher.rb', line 189 def connected_port @binder.connected_port end |
#delete_pidfile ⇒ Object
Delete the configured pidfile
119 120 121 122 |
# File 'lib/puma/launcher.rb', line 119 def delete_pidfile path = @options[:pidfile] File.unlink(path) if path && File.exist?(path) end |
#halt ⇒ Object
Begin async shutdown of the server
138 139 140 141 |
# File 'lib/puma/launcher.rb', line 138 def halt @status = :halt @runner.halt end |
#phased_restart ⇒ Object
Begin a phased restart if supported
156 157 158 159 160 161 162 |
# File 'lib/puma/launcher.rb', line 156 def phased_restart unless @runner.respond_to?(:phased_restart) and @runner.phased_restart log "* phased-restart called but not available, restarting normally." return restart end true end |
#restart ⇒ Object
Begin async restart of the server
150 151 152 153 |
# File 'lib/puma/launcher.rb', line 150 def restart @status = :restart @runner.restart end |
#restart_args ⇒ Object
193 194 195 196 197 198 199 200 |
# File 'lib/puma/launcher.rb', line 193 def restart_args cmd = @options[:restart_cmd] if cmd cmd.split(' ') + @original_argv else @restart_argv end end |
#run ⇒ Object
Run the server. This blocks until the server is stopped
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/puma/launcher.rb', line 165 def run @config.clamp @config.plugins.fire_starts self setup_signals set_process_title @runner.run case @status when :halt log "* Stopping immediately!" when :run, :stop graceful_stop when :restart log "* Restarting..." @runner.before_restart restart! when :exit # nothing end end |
#stats ⇒ Object
Return stats about the server
98 99 100 |
# File 'lib/puma/launcher.rb', line 98 def stats @runner.stats end |
#stop ⇒ Object
Begin async shutdown of the server gracefully
144 145 146 147 |
# File 'lib/puma/launcher.rb', line 144 def stop @status = :stop @runner.stop end |
#write_pid ⇒ Object
If configured, write the pid of the current process out to a file.
126 127 128 129 130 131 132 133 134 135 |
# File 'lib/puma/launcher.rb', line 126 def write_pid path = @options[:pidfile] return unless path File.open(path, 'w') { |f| f.puts Process.pid } cur = Process.pid at_exit do delete_pidfile if cur == Process.pid end end |
#write_state ⇒ Object
Write a state file that can be used by pumactl to control the server
104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/puma/launcher.rb', line 104 def write_state write_pid path = @options[:state] return unless path sf = StateFile.new sf.pid = Process.pid sf.control_url = @options[:control_url] sf.control_auth_token = @options[:control_auth_token] sf.save path end |