method

timeout

v1_9_3_392 - Show latest stable - 0 notes - Class: Timeout

timeout(sec, klass = nil) public

Perform an operation in a block, timing it out if it takes longer than sec seconds to complete.

`sec`	Number of seconds to wait for the block to terminate. Any number may be used, including Floats to specify fractional seconds.
`klass`	Exception Class to raise if the block fails to terminate in `sec` seconds. Omitting will use the default, Timeout::Error

The block will be executed on another thread and will be given one argument: sec.

Returns the result of the block if the block completed before sec seconds, otherwise throws an exception, based on the value of klass.

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.timeout().

Show source

# File lib/timeout.rb, line 53
  def timeout(sec, klass = nil)   #:yield: +sec+
    return yield(sec) if sec == nil or sec.zero?
    exception = klass || Class.new(ExitException)
    begin
      begin
        x = Thread.current
        y = Thread.start {
          begin
            sleep sec
          rescue => e
            x.raise e
          else
            x.raise exception, "execution expired"
          end
        }
        return yield(sec)
      ensure
        if y
          y.kill
          y.join # make sure y is dead.
        end
      end
    rescue exception => e
      rej = /\A#{Regexp.quote(__FILE__)}:#{__LINE__-4}\z/
      (bt = e.backtrace).reject! {|m| rej =~ m}
      level = -caller(CALLER_OFFSET).size
      while THIS_FILE =~ bt[level]
        bt.delete_at(level)
        level += 1
      end
      raise if klass            # if exception class is specified, it
                                # would be expected outside.
      raise Error, e.message, e.backtrace
    end
  end

timeout

Related methods