123456789_123456789_123456789_123456789_123456789_

Module: Puma

Overview

note that dsl is loaded at end of file, requires ConfigDefault constants

Constant Summary

  • HAS_FORK =

    Version:

    • 5.2.1

    # File 'lib/puma/detect.rb', line 9
    ::Process.respond_to? :fork
  • HAS_NATIVE_IO_WAIT =
    # File 'lib/puma/detect.rb', line 11
    ::IO.public_instance_methods(false).include? :wait_readable
  • HAS_SSL =

    at present, MiniSSL::Engine is only defined in extension code (puma_http11), not in minissl.rb

    # File 'lib/puma.rb', line 29
    const_defined?(:MiniSSL, false) && MiniSSL.const_defined?(:Engine, false)
  • HAS_UNIX_SOCKET =
    # File 'lib/puma.rb', line 31
    Object.const_defined? :UNIXSocket
  • HTTP_STATUS_CODES =

    Every standard HTTP code mapped to the appropriate message. Generated with: curl -s www.iana.org/assignments/http-status-codes/http-status-codes-1.csv | \

    ruby -ne 'm = /^(\d{3}),(?!Unassigned|\(Unused\))([^,]+)/.match($_) and \
              puts "#{m[1]} => \x27#{m[2].strip}\x27,"'
    # File 'lib/puma/const.rb', line 18
    {
      100 => 'Continue',
      101 => 'Switching Protocols',
      102 => 'Processing',
      200 => 'OK',
      201 => 'Created',
      202 => 'Accepted',
      203 => 'Non-Authoritative Information',
      204 => 'No Content',
      205 => 'Reset Content',
      206 => 'Partial Content',
      207 => 'Multi-Status',
      208 => 'Already Reported',
      226 => 'IM Used',
      300 => 'Multiple Choices',
      301 => 'Moved Permanently',
      302 => 'Found',
      303 => 'See Other',
      304 => 'Not Modified',
      305 => 'Use Proxy',
      307 => 'Temporary Redirect',
      308 => 'Permanent Redirect',
      400 => 'Bad Request',
      401 => 'Unauthorized',
      402 => 'Payment Required',
      403 => 'Forbidden',
      404 => 'Not Found',
      405 => 'Method Not Allowed',
      406 => 'Not Acceptable',
      407 => 'Proxy Authentication Required',
      408 => 'Request Timeout',
      409 => 'Conflict',
      410 => 'Gone',
      411 => 'Length Required',
      412 => 'Precondition Failed',
      413 => 'Payload Too Large',
      414 => 'URI Too Long',
      415 => 'Unsupported Media Type',
      416 => 'Range Not Satisfiable',
      417 => 'Expectation Failed',
      418 => 'I\'m A Teapot',
      421 => 'Misdirected Request',
      422 => 'Unprocessable Entity',
      423 => 'Locked',
      424 => 'Failed Dependency',
      426 => 'Upgrade Required',
      428 => 'Precondition Required',
      429 => 'Too Many Requests',
      431 => 'Request Header Fields Too Large',
      451 => 'Unavailable For Legal Reasons',
      500 => 'Internal Server Error',
      501 => 'Not Implemented',
      502 => 'Bad Gateway',
      503 => 'Service Unavailable',
      504 => 'Gateway Timeout',
      505 => 'HTTP Version Not Supported',
      506 => 'Variant Also Negotiates',
      507 => 'Insufficient Storage',
      508 => 'Loop Detected',
      510 => 'Not Extended',
      511 => 'Network Authentication Required'
    }.freeze
  • IS_JRUBY =
    # File 'lib/puma/detect.rb', line 13
    Object.const_defined? :JRUBY_VERSION
  • IS_MRI =

    Version:

    • 5.2.0

    # File 'lib/puma/detect.rb', line 21
    (RUBY_ENGINE == 'ruby' || RUBY_ENGINE.nil?)
  • IS_OSX =
    # File 'lib/puma/detect.rb', line 15
    RUBY_PLATFORM.include? 'darwin'
  • IS_WINDOWS =
    # File 'lib/puma/detect.rb', line 17
    !!(RUBY_PLATFORM =~ /mswin|ming|cygwin/) ||
    IS_JRUBY && RUBY_DESCRIPTION.include?('mswin')
  • Plugins =
    # File 'lib/puma/plugin.rb', line 74
    PluginRegistry.new
  • STATUS_WITH_NO_ENTITY_BODY =

    For some HTTP status codes the client only expects headers.

    # File 'lib/puma/const.rb', line 84
    {
      204 => true,
      205 => true,
      304 => true
    }.freeze

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

Class Attribute Details

.abstract_unix_socket?Boolean (readonly)

[ GitHub ]

  
# File 'lib/puma.rb', line 47

def self.abstract_unix_socket?
  @abstract_unix ||=
    if HAS_UNIX_SOCKET
      begin
        ::UNIXServer.new("\0puma.temp.unix").close
        true
      rescue ArgumentError  # darwin
        false
      end
    else
      false
    end
end

.cli_config (rw)

The CLI exports a Configuration instance here to allow apps to pick it up. An app must load this object conditionally because it is not set if the app is launched via any mechanism other than the CLI class.

[ GitHub ]

  
# File 'lib/puma/cli.rb', line 18

attr_accessor :cli_config

.forkable?Boolean (readonly)

Version:

  • 5.0.0

[ GitHub ]

  
# File 'lib/puma/detect.rb', line 41

def self.forkable?
  HAS_FORK
end

.jruby?Boolean (readonly)

[ GitHub ]

  
# File 'lib/puma/detect.rb', line 23

def self.jruby?
  IS_JRUBY
end

.mri?Boolean (readonly)

Version:

  • 5.0.0

[ GitHub ]

  
# File 'lib/puma/detect.rb', line 36

def self.mri?
  IS_MRI
end

.osx?Boolean (readonly)

[ GitHub ]

  
# File 'lib/puma/detect.rb', line 27

def self.osx?
  IS_OSX
end

.ssl?Boolean (readonly)

[ GitHub ]

  
# File 'lib/puma.rb', line 43

def self.ssl?
  HAS_SSL
end

.stats_object=(val) (writeonly)

[ GitHub ]

  
# File 'lib/puma.rb', line 62

def self.stats_object=(val)
  @get_stats = val
end

.windows?Boolean (readonly)

[ GitHub ]

  
# File 'lib/puma/detect.rb', line 31

def self.windows?
  IS_WINDOWS
end

Class Method Details

.set_thread_name(name)

[ GitHub ]

  
# File 'lib/puma.rb', line 77

def self.set_thread_name(name)
  Thread.current.name = "puma #{name}"
end

.stats

[ GitHub ]

  
# File 'lib/puma.rb', line 67

def self.stats
  Puma::JSONSerialization.generate @get_stats.stats
end

.stats_hash

Version:

  • 5.0.0

[ GitHub ]

  
# File 'lib/puma.rb', line 73

def self.stats_hash
  @get_stats.stats
end

Instance Attribute Details

#stats_hash (readonly)

Version:

  • 5.0.0

[ GitHub ]

  
# File 'lib/puma.rb', line 73

def self.stats_hash
  @get_stats.stats
end

#stats_object (rw)

[ GitHub ]

  
# File 'lib/puma.rb', line 67

def self.stats
  Puma::JSONSerialization.generate @get_stats.stats
end