Description

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.timeout, and a backwards-compatible timeout.

Synopsis

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

Methods

timeout

Classes and Modules

Class Timeout::Error

Public Instance methods

timeout(sec, exception=Error) {|if sec == nil or sec.zero?| ...}

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

[Source]

    # File lib/timeout.rb, line 47
47:   def timeout(sec, exception=Error)
48:     return yield if sec == nil or sec.zero?
49:     raise ThreadError, "timeout within critical session" if Thread.critical
50:     begin
51:       x = Thread.current
52:       y = Thread.start {
53:         sleep sec
54:         x.raise exception, "execution expired" if x.alive?
55:       }
56:       yield sec
57:       #    return true
58:     ensure
59:       y.kill if y and y.alive?
60:     end
61:   end