Class: Puma::Binder
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
Const
|
|
Inherits: | Object |
Defined in: | lib/puma/binder.rb |
Constant Summary
-
RACK_VERSION =
# File 'lib/puma/binder.rb', line 14[1,3].freeze
Const
- Included
CGI_VER, CHUNKED, CHUNK_SIZE, CLOSE, CLOSE_CHUNKED, CODE_NAME, COLON, CONNECTION_CLOSE, CONNECTION_KEEP_ALIVE, CONTENT_LENGTH, CONTENT_LENGTH2, CONTENT_LENGTH_S, CONTINUE, EARLY_HINTS, ERROR_RESPONSE, FAST_TRACK_KA_TIMEOUT, FIRST_DATA_TIMEOUT, GATEWAY_INTERFACE, HALT_COMMAND, HEAD, HIJACK, HIJACK_IO, HIJACK_P, HTTP, HTTPS, HTTPS_KEY, HTTP_10_200, HTTP_11, HTTP_11_100, HTTP_11_200, HTTP_CONNECTION, HTTP_EXPECT, HTTP_HOST, HTTP_INJECTION_REGEX, HTTP_VERSION, HTTP_X_FORWARDED_FOR, HTTP_X_FORWARDED_PROTO, HTTP_X_FORWARDED_SCHEME, HTTP_X_FORWARDED_SSL, KEEP_ALIVE, LINE_END, LOCALHOST, LOCALHOST_ADDR, LOCALHOST_IP, MAX_BODY, MAX_FAST_INLINE, MAX_HEADER, NEWLINE, PATH_INFO, PERSISTENT_TIMEOUT, PORT_443, PORT_80, PUMA_CONFIG, PUMA_PEERCERT, PUMA_SERVER_STRING, PUMA_SOCKET, PUMA_TMP_BASE, PUMA_VERSION, QUERY_STRING, RACK_AFTER_REPLY, RACK_INPUT, RACK_URL_SCHEME, REMOTE_ADDR, REQUEST_METHOD, REQUEST_PATH, REQUEST_URI, RESTART_COMMAND, SERVER_NAME, SERVER_PORT, SERVER_PROTOCOL, SERVER_SOFTWARE, STOP_COMMAND, TRANSFER_ENCODING, TRANSFER_ENCODING2, TRANSFER_ENCODING_CHUNKED, WORKER_CHECK_INTERVAL, WRITE_TIMEOUT
Class Method Summary
- .new(events) ⇒ Binder constructor
Instance Attribute Summary
- #connected_port readonly
- #ios readonly
Instance Method Summary
- #add_ssl_listener(host, port, ctx, optimize_for_latency = true, backlog = 1024)
-
#add_tcp_listener(host, port, optimize_for_latency = true, backlog = 1024)
Tell the server to listen on host
host
, portport
. -
#add_unix_listener(path, umask = nil, mode = nil, backlog = 1024)
Tell the server to listen on
path
as a UNIX domain socket. - #close
- #close_listeners
- #close_unix_paths
- #env(sock)
- #import_from_env
- #inherit_ssl_listener(fd, ctx)
- #inherit_tcp_listener(host, port, fd)
- #inherit_unix_listener(path, fd)
- #loopback_addresses
- #parse(binds, logger)
- #redirects_for_restart
Constructor Details
.new(events) ⇒ Binder
# File 'lib/puma/binder.rb', line 16
def initialize(events) @events = events @listeners = [] @inherited_fds = {} @activated_sockets = {} @unix_paths = [] @proto_env = { "rack.version".freeze => RACK_VERSION, "rack.errors".freeze => events.stderr, "rack.multithread".freeze => true, "rack.multiprocess".freeze => false, "rack.run_once".freeze => false, "SCRIPT_NAME".freeze => ENV['SCRIPT_NAME'] || "", # I'd like to set a default CONTENT_TYPE here but some things # depend on their not being a default set and inferring # it from the content. And so if i set it here, it won't # infer properly. "QUERY_STRING".freeze => "", SERVER_PROTOCOL => HTTP_11, SERVER_SOFTWARE => PUMA_SERVER_STRING, GATEWAY_INTERFACE => CGI_VER } @envs = {} @ios = [] end
Instance Attribute Details
#connected_port (readonly)
[ GitHub ]# File 'lib/puma/binder.rb', line 241
attr_reader :connected_port
#ios (readonly)
[ GitHub ]# File 'lib/puma/binder.rb', line 46
attr_reader :ios
Instance Method Details
#add_ssl_listener(host, port, ctx, optimize_for_latency = true, backlog = 1024)
[ GitHub ]# File 'lib/puma/binder.rb', line 254
def add_ssl_listener(host, port, ctx, optimize_for_latency=true, backlog=1024) require 'puma/minissl' MiniSSL.check if host == "localhost" loopback_addresses.each do |addr| add_ssl_listener addr, port, ctx, optimize_for_latency, backlog end return end host = host[1..-2] if host[0..0] == '[' s = TCPServer.new(host, port) if optimize_for_latency s.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1) end s.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR, true) s.listen backlog ssl = MiniSSL::Server.new s, ctx env = @proto_env.dup env[HTTPS_KEY] = HTTPS @envs[ssl] = env @ios << ssl s end
#add_tcp_listener(host, port, optimize_for_latency = true, backlog = 1024)
Tell the server to listen on host host
, port port
. If optimize_for_latency
is true (the default) then clients connecting will be optimized for latency over throughput.
backlog
indicates how many unaccepted connections the kernel should allow to accumulate before returning connection refused.
# File 'lib/puma/binder.rb', line 220
def add_tcp_listener(host, port, optimize_for_latency=true, backlog=1024) if host == "localhost" loopback_addresses.each do |addr| add_tcp_listener addr, port, optimize_for_latency, backlog end return end host = host[1..-2] if host and host[0..0] == '[' s = TCPServer.new(host, port) if optimize_for_latency s.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1) end s.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR, true) s.listen backlog @connected_port = s.addr[1] @ios << s s end
#add_unix_listener(path, umask = nil, mode = nil, backlog = 1024)
Tell the server to listen on path
as a UNIX domain socket.
# File 'lib/puma/binder.rb', line 307
def add_unix_listener(path, umask=nil, mode=nil, backlog=1024) @unix_paths << path unless File.exist? path # Let anyone connect by default umask ||= 0 begin old_mask = File.umask(umask) if File.exist? path begin old = UNIXSocket.new path rescue SystemCallError, IOError File.unlink path else old.close raise "There is already a server bound to: #{path}" end end s = UNIXServer.new(path) s.listen backlog @ios << s ensure File.umask old_mask end if mode File.chmod mode, path end env = @proto_env.dup env[REMOTE_ADDR] = "127.0.0.1" @envs[s] = env s end
#close
[ GitHub ]# File 'lib/puma/binder.rb', line 52
def close @ios.each { |i| i.close } end
#close_listeners
[ GitHub ]#close_unix_paths
[ GitHub ]# File 'lib/puma/binder.rb', line 372
def close_unix_paths @unix_paths.each { |up| File.unlink(up) if File.exist? up } end
#env(sock)
[ GitHub ]# File 'lib/puma/binder.rb', line 48
def env(sock) @envs.fetch(sock, @proto_env) end
#import_from_env
[ GitHub ]# File 'lib/puma/binder.rb', line 56
def import_from_env remove = [] ENV.each do |k,v| if k =~ /PUMA_INHERIT_\d+/ fd, url = v.split(":", 2) @inherited_fds[url] = fd.to_i remove << k elsif k == 'LISTEN_FDS' && ENV['LISTEN_PID'].to_i == $$ v.to_i.times do |num| fd = num + 3 sock = TCPServer.for_fd(fd) begin key = [ :unix, Socket.unpack_sockaddr_un(sock.getsockname) ] rescue ArgumentError port, addr = Socket.unpack_sockaddr_in(sock.getsockname) if addr =~ /\:/ addr = "[#{addr}]" end key = [ :tcp, addr, port ] end @activated_sockets[key] = sock @events.debug "Registered #{key.join ':'} for activation from LISTEN_FDS" end remove << k << 'LISTEN_PID' end end remove.each do |k| ENV.delete k end end
#inherit_ssl_listener(fd, ctx)
[ GitHub ]#inherit_tcp_listener(host, port, fd)
[ GitHub ]# File 'lib/puma/binder.rb', line 243
def inherit_tcp_listener(host, port, fd) if fd.kind_of? TCPServer s = fd else s = TCPServer.for_fd(fd) end @ios << s s end
#inherit_unix_listener(path, fd)
[ GitHub ]# File 'lib/puma/binder.rb', line 345
def inherit_unix_listener(path, fd) @unix_paths << path unless File.exist? path if fd.kind_of? TCPServer s = fd else s = UNIXServer.for_fd fd end @ios << s env = @proto_env.dup env[REMOTE_ADDR] = "127.0.0.1" @envs[s] = env s end
#loopback_addresses
[ GitHub ]# File 'lib/puma/binder.rb', line 207
def loopback_addresses Socket.ip_address_list.select do |addrinfo| addrinfo.ipv6_loopback? || addrinfo.ipv4_loopback? end.map { |addrinfo| addrinfo.ip_address }.uniq end
#parse(binds, logger)
[ GitHub ]# File 'lib/puma/binder.rb', line 89
def parse(binds, logger) binds.each do |str| uri = URI.parse str case uri.scheme when "tcp" if fd = @inherited_fds.delete(str) io = inherit_tcp_listener uri.host, uri.port, fd logger.log "* Inherited #{str}" elsif sock = @activated_sockets.delete([ :tcp, uri.host, uri.port ]) io = inherit_tcp_listener uri.host, uri.port, sock logger.log "* Activated #{str}" else params = Util.parse_query uri.query opt = params.key?('low_latency') bak = params.fetch('backlog', 1024).to_i io = add_tcp_listener uri.host, uri.port, opt, bak @ios.each do |i| next unless TCPServer === i addr = if i.local_address.ipv6? "[#{i.local_address.ip_unpack[0]}]:#{i.local_address.ip_unpack[1]}" else i.local_address.ip_unpack.join(':') end logger.log "* Listening on tcp://#{addr}" end end @listeners << [str, io] if io when "unix" path = "#{uri.host}#{uri.path}".gsub("%20", " ") if fd = @inherited_fds.delete(str) io = inherit_unix_listener path, fd logger.log "* Inherited #{str}" elsif sock = @activated_sockets.delete([ :unix, path ]) io = inherit_unix_listener path, sock logger.log "* Activated #{str}" else umask = nil mode = nil backlog = 1024 if uri.query params = Util.parse_query uri.query if u = params['umask'] # Use Integer() to respect the 0 prefix as octal umask = Integer(u) end if u = params['mode'] mode = Integer('0'+u) end if u = params['backlog'] backlog = Integer(u) end end io = add_unix_listener path, umask, mode, backlog logger.log "* Listening on #{str}" end @listeners << [str, io] when "ssl" params = Util.parse_query uri.query ctx = MiniSSL::ContextBuilder.new(params, @events).context if fd = @inherited_fds.delete(str) logger.log "* Inherited #{str}" io = inherit_ssl_listener fd, ctx elsif sock = @activated_sockets.delete([ :tcp, uri.host, uri.port ]) io = inherit_ssl_listener sock, ctx logger.log "* Activated #{str}" else io = add_ssl_listener uri.host, uri.port, ctx logger.log "* Listening on #{str}" end @listeners << [str, io] if io else logger.error "Invalid URI: #{str}" end end # If we inherited fds but didn't use them (because of a # configuration change), then be sure to close them. @inherited_fds.each do |str, fd| logger.log "* Closing unused inherited connection: #{str}" begin IO.for_fd(fd).close rescue SystemCallError end # We have to unlink a unix socket path that's not being used uri = URI.parse str if uri.scheme == "unix" path = "#{uri.host}#{uri.path}" File.unlink path end end # Also close any unused activated sockets @activated_sockets.each do |key, sock| logger.log "* Closing unused activated socket: #{key.join ':'}" begin sock.close rescue SystemCallError end # We have to unlink a unix socket path that's not being used File.unlink key[1] if key[0] == :unix end end
#redirects_for_restart
[ GitHub ]# File 'lib/puma/binder.rb', line 376
def redirects_for_restart redirects = {:close_others => true} @listeners.each_with_index do |(l, io), i| ENV["PUMA_INHERIT_#{i}"] = "#{io.to_i}:#{l}" redirects[io.to_i] = io.to_i end redirects end