In Files

  • timeout.rb



Class/Module Index [+]




A way of performing a potentially long-running operation in a thread, and terminating it’s execution if it hasn’t finished within fixed amount of time.

Previous versions of timeout didn’t use a module for namespace. This version provides both ::timeout, and a backwards-compatible timeout.


require 'timeout'
status = Timeout::timeout(5) {
  # Something that should be interrupted if it takes too much time...

Public Class Methods

timeout(sec, klass = nil) click to toggle source

Executes the method’s block. If the block execution terminates before sec seconds has passed, it returns true. If not, it terminates the execution and raises exception (which defaults to Timeout::Error).

Note that this is both a method of module Timeout, so you can ‘include Timeout’ into your classes so they have a timeout method, as well as a module method, so you can call it directly as ::timeout.

               # File timeout.rb, line 52
def timeout(sec, klass = nil)
  return yield if sec == nil or
  raise ThreadError, "timeout within critical session" if Thread.critical
  exception = klass ||
    x = Thread.current
    y = Thread.start {
      sleep sec
      x.raise exception, "execution expired" if x.alive?
    yield sec
    #    return true
  rescue exception => e
    rej = /\A#{Regexp.quote(__FILE__)}:#{__LINE__-4}\z/o
    (bt = e.backtrace).reject! {|m| rej =~ m}
    level = -caller(CALLER_OFFSET).size
    while THIS_FILE =~ bt[level]
      level += 1
    raise if klass            # if exception class is specified, it
                              # would be expected outside.
    raise Error, e.message, e.backtrace
    y.kill if y and y.alive?

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit