Module Timeout
In: lib/timeout.rb

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

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

To view or add comments on this documentation, please go to the API wiki.

[Validate]