Class: Rack::Idle

Inherits:
Object
  • Object
show all
Defined in:
lib/rack/idle.rb

Overview

Rack::Idle is a Rack middleware that will automatically shutdown idle Rack servers.

Just add the following to your config.ru:

require "rack/idle"

use Rack::Idle

...

and once no requests have been received for 10 minutes exit will be called to shutdown the server.

The timeout can be customised like so:

use Rack::Idle, :timeout => 300 # 300 seconds == 5 minutes

Additionally a file can be monitored, and the server shutdown if the timestamp is updated:

use Rack::Idle, :watch => "restart.txt" # touch restart.txt to shutdown

Class Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app, opts = {}) ⇒ Idle

:call-seq: Idle.new(app, [options]) -> idle

Create a new idle middleware instance, wrapping app.

Available options:

timeout

Amount of time (in seconds) to wait after a request before calling exit to shutdown the server

watch

Path to a file (relative to the working directory) to monitor, shutting down the server if the last modified date is updated.



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/rack/idle.rb', line 37

def initialize(app, opts={})
  @app = app
  
  self.class.last_activity = Time.now
  timeout = (opts[:timeout] || 600)
  
  watch = opts[:watch]
  if watch && File.exist?(watch)
    watch_mtime = File.mtime(watch)
  elsif watch
    watch_mtime = Time.now
  end
  
  Thread.new do
    loop do
      exit if Time.now - self.class.last_activity > timeout
      exit if watch && File.exist?(watch) && File.mtime(watch) > watch_mtime
      sleep 1
    end
  end.abort_on_exception = true
end

Class Attribute Details

.last_activity ⇒ Object

:nodoc:



60
61
62
 
# File 'lib/rack/idle.rb', line 60

def last_activity
  @last_activity
end

Instance Method Details

#call(env) ⇒ Object

:call-seq: idle.call(env) -> status_headers_body

Proxied to the app supplied to ::new.



67
68
69
70
 
# File 'lib/rack/idle.rb', line 67

def call(env)
  self.class.last_activity = Time.now
  @app.call(env)
end