модуль Timeout

frozen_string_literal: false Timeout длительных блоков

Краткое описание

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

Описание

Timeout предоставляет способ автоматического завершения потенциально длительной операции, если она не завершилась в заданное время.

Предыдущие версии не использовали модуль для именования пространства имён, однако timeout предоставляется для обратной совместимости. Вы должны предпочесть #timeout вместо него.

Авторские права

Авторские права: (C) 2000 Network Applied Communication Laboratory, Inc.
Авторские права: (C) 2000 Агентство по содействию развитию информационных технологий, Япония

Методы публичного класса

timeout(sec, klass = nil) { |sec| ... } Показать исходный код

# File lib/timeout.rb, line 73
def timeout(sec, klass = 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 секунд.

sec: Количество секунд ожидания завершения блока. Можно использовать любое число, включая числа с плавающей точкой для указания долей секунды. Значение 0 или nil выполнит блок без таймаута.
klass: Класс исключения Exception, который будет вызван, если блок не завершится в течение sec секунд. Если опустить, будет использоваться значение по умолчанию Timeout::Error

Возвращает результат блока если блок завершился до sec секунд, в противном случае генерирует исключение, в зависимости от значения klass.

Исключение, вызываемое для завершения данного блока, нельзя перехватить внутри блока, если klass не указано явно.

Обратите внимание, что это метод модуля Timeout, поэтому вы можете include Timeout в свои классы, чтобы у них был метод timeout, а также метод модуля, чтобы вызвать его напрямую как #timeout.

Приватные методы экземпляра

timeout(sec, klass = nil) { |sec| ... } Показать исходный код

# File lib/timeout.rb, line 73
def timeout(sec, klass = 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 секунд.

sec: Количество секунд ожидания завершения блока. Можно использовать любое число, включая числа с плавающей точкой для указания долей секунды. Значение 0 или nil выполнит блок без таймаута.
klass: Класс исключения Exception, который будет вызван, если блок не завершится в течение sec секунд. Если опустить, будет использоваться значение по умолчанию Timeout::Error

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.