Timeout

超时长时间运行的块

概要

require 'timeout'
status = Timeout::timeout(5) {
  # Something that should be interrupted if it takes more than 5 seconds...
}

描述

超时提供了一种自动终止可能长时间运行的操作的方法，如果它没有在一段固定的时间内完成。

以前的版本没有使用名称空间模块，但是为了向后兼容提供超时。您应该更喜欢#timeout。

版权

公共类方法

超时（sec，klass = nil，message = nil）{| sec | ...}显示源文件

在块中执行操作，如果sec完成时间超过了几秒，则会发生错误。

sec

等待块终止的秒数。任何数字都可以使用，包括Floats指定小数秒。值为0或nil将在没有任何超时的情况下执行该块。

klass

如果该块未能在sec数秒内终止，则引发异常类。省略将使用默认的Timeout :: Error

message

用Exception Class引发错误消息。省略将使用默认的“执行过期”

如果块在sec秒之前完成，则返回块的结果，否则基于值的值抛出异常klass。

除非klass明确给出，否则抛出的用于终止给定块的异常无法在块内获救。

请注意，这是模块Timeout的一种方法，所以你可以include Timeout进入你的类，所以它们有一个超时方法和一个模块方法，所以你可以直接调用它作为#timeout。

# File lib/timeout.rb, line 74
def timeout(sec, klass = nil, message = nil)   #:yield: +sec+
  return yield(sec) if sec == nil or sec.zero?
  message ||= "execution expired".freeze
  from = "from #{caller_locations(1, 1)[0]}" if $DEBUG
  e = Error
  bl = proc do |exception|
    begin
      x = Thread.current
      y = Thread.start {
        Thread.current.name = from
        begin
          sleep sec
        rescue => e
          x.raise e
        else
          x.raise exception, message
        end
      }
      return yield(sec)
    ensure
      if y
        y.kill
        y.join # make sure y is dead.
      end
    end
  end
  if klass
    begin
      bl.call(klass)
    rescue klass => e
      bt = e.backtrace
    end
  else
    bt = Error.catch(message, &bl)
  end
  level = -caller(CALLER_OFFSET).size-2
  while THIS_FILE =~ bt[level]
    bt.delete_at(level)
  end
  raise(e, message, bt)
end

私有实例方法

超时（sec，klass = nil，message = nil）{| sec | ...}显示源文件

在块中执行操作，如果sec完成时间超过了几秒，则会发生错误。

秒

等待块终止的秒数。任何数字都可以使用，包括Floats指定小数秒。值为0或nil将在没有任何超时的情况下执行该块。

类

如果该块未能在sec数秒内终止，则引发异常类。省略将使用默认的Timeout :: Error

信息

用Exception Class引发错误消息。省略将使用默认的“执行过期”

如果块在sec秒之前完成，则返回块的结果，否则基于值的值抛出异常klass。

除非klass明确给出，否则抛出的用于终止给定块的异常无法在块内获救。

请注意，这是模块Timeout的一种方法，所以你可以include Timeout进入你的类，所以它们有一个超时方法和一个模块方法，所以你可以直接调用它作为#timeout。

# File lib/timeout.rb, line 74
def timeout(sec, klass = nil, message = nil)   #:yield: +sec+
  return yield(sec) if sec == nil or sec.zero?
  message ||= "execution expired".freeze
  from = "from #{caller_locations(1, 1)[0]}" if $DEBUG
  e = Error
  bl = proc do |exception|
    begin
      x = Thread.current
      y = Thread.start {
        Thread.current.name = from
        begin
          sleep sec
        rescue => e
          x.raise e
        else
          x.raise exception, message
        end
      }
      return yield(sec)
    ensure
      if y
        y.kill
        y.join # make sure y is dead.
      end
    end
  end
  if klass
    begin
      bl.call(klass)
    rescue klass => e
      bt = e.backtrace
    end
  else
    bt = Error.catch(message, &bl)
  end
  level = -caller(CALLER_OFFSET).size-2
  while THIS_FILE =~ bt[level]
    bt.delete_at(level)
  end
  raise(e, message, bt)
end