Class: Rage::Configuration::Server

Inherits:

Object

• Object
• Rage::Configuration::Server

Defined in:

lib/rage/configuration.rb

Instance Attribute Summary

• #max_clients ⇒ Integer

  Limit the number of simultaneous connections the server can accept.

• #port ⇒ Integer

  Specify the port the server will listen on.

• #timeout ⇒ Integer

  Specify the connection timeout in seconds.

• #workers_count ⇒ Integer

  Specify the number of worker processes to spawn.

Instance Attribute Details

#max_clients ⇒ Integer

Note:

Decreasing this number is almost never a good idea. Depending on your application specifics, you are encouraged to use other methods to limit the number of concurrent connections:

• If your application is exposed to the public, you may want to use a cloud rate limiter, like Cloudflare WAF or Fastly WAF.

• Otherwise, consider using tools like Rack::Attack or connection_pool.

Limit the number of simultaneous connections the server can accept. Defaults to the maximum number of open files.

Examples:

Limit the amount of connections your application can accept

Rage.configure do
  config.middleware.use Rack::Attack
  Rack::Attack.throttle("req/ip", limit: 300, period: 5.minutes) do |req|
    req.ip
  end
end

Limit the amount of connections to a specific resource

HTTP = ConnectionPool.new(size: 5, timeout: 5) { Net::HTTP }
HTTP.with do |conn|
  conn.get("/my-resource")
end

Returns:

• (Integer)

# File 'lib/rage/configuration.rb', line 358

attr_accessor :port, :workers_count, :timeout, :max_clients

#port ⇒ Integer

Specify the port the server will listen on.

Examples:

Change the default port

Rage.configure do
  config.server.port = 3001
end

Returns:

• (Integer)

# File 'lib/rage/configuration.rb', line 358

def port
  @port
end

#timeout ⇒ Integer

Specify the connection timeout in seconds.

Examples:

Change the connection timeout

Rage.configure do
  config.server.timeout = 30
end

Returns:

• (Integer)

# File 'lib/rage/configuration.rb', line 358

attr_accessor :port, :workers_count, :timeout, :max_clients

#workers_count ⇒ Integer

Specify the number of worker processes to spawn. Use -1 to spawn one worker per CPU core.

Examples:

Change the number of worker processes

Rage.configure do
  config.server.workers_count = 4
end

Returns:

• (Integer)

# File 'lib/rage/configuration.rb', line 358

attr_accessor :port, :workers_count, :timeout, :max_clients