module Timeout
Timeout long-running blocks
Synopsis¶↑
require'timeout'status =Timeout.timeout(5) {# Something that should be interrupted if it takes more than 5 seconds...}
Description¶↑
Timeout provides a way to auto-terminate a potentially long-running operation if it hasn’t finished in a fixed amount of time.
Copyright¶↑
- Copyright
© 2000 Network Applied Communication Laboratory, Inc.
- Copyright
© 2000 Information-technology Promotion Agency, Japan
Constants
- VERSION
The version
Public Class Methods
Source
# File lib/timeout.rb, line 170deftimeout(sec,klass =nil,message =nil,&block)#:yield: +sec+returnyield(sec)ifsec==nilorsec.zero?raiseArgumentError,"Timeout sec must be a non-negative number"if0>secmessage||="execution expired"ifFiber.respond_to?(:current_scheduler)&& (scheduler =Fiber.current_scheduler)&.respond_to?(:timeout_after)returnscheduler.timeout_after(sec,klass||Error,message,&block)endTimeout.ensure_timeout_thread_createdperform =Proc.newdo|exc|request =Request.new(Thread.current,sec,exc,message)QUEUE_MUTEX.synchronizedoQUEUE<<requestCONDVAR.signalendbeginreturnyield(sec)ensurerequest.finishedendendifklassperform.call(klass)elseError.handle_timeout(message,&perform)endend
Perform an operation in a block, raising an error if it takes longer thansec seconds to complete.
secNumber of seconds to wait for the block to terminate. Any non-negative number or nil may be used, including Floats to specify fractional seconds. A value of 0 or
nilwill execute the block without any timeout. Any negative number will raise anArgumentError.klassExceptionClass to raise if the block fails to terminate insecseconds. Omitting will use the default,Timeout::ErrormessageErrormessage to raise withExceptionClass. Omitting will use the default, “execution expired”
Returns the result of the blockif the block completed beforesec seconds, otherwise throws an exception, based on the value ofklass.
The exception thrown to terminate the given block cannot be rescued inside the block unlessklass is given explicitly. However, the block can use ensure to prevent the handling of the exception. For that reason, this method cannot be relied on to enforce timeouts for untrusted blocks.
If a scheduler is defined, it will be used to handle the timeout by invoking Scheduler#timeout_after.
Note that this is both a method of moduleTimeout, so you caninclude Timeout into your classes so they have atimeout method, as well as a module method, so you can call it directly asTimeout.timeout().
Private Instance Methods
Source
# File lib/timeout.rb, line 170deftimeout(sec,klass =nil,message =nil,&block)#:yield: +sec+returnyield(sec)ifsec==nilorsec.zero?raiseArgumentError,"Timeout sec must be a non-negative number"if0>secmessage||="execution expired"ifFiber.respond_to?(:current_scheduler)&& (scheduler =Fiber.current_scheduler)&.respond_to?(:timeout_after)returnscheduler.timeout_after(sec,klass||Error,message,&block)endTimeout.ensure_timeout_thread_createdperform =Proc.newdo|exc|request =Request.new(Thread.current,sec,exc,message)QUEUE_MUTEX.synchronizedoQUEUE<<requestCONDVAR.signalendbeginreturnyield(sec)ensurerequest.finishedendendifklassperform.call(klass)elseError.handle_timeout(message,&perform)endend
Perform an operation in a block, raising an error if it takes longer thansec seconds to complete.
secNumber of seconds to wait for the block to terminate. Any non-negative number or nil may be used, including Floats to specify fractional seconds. A value of 0 or
nilwill execute the block without any timeout. Any negative number will raise anArgumentError.klassExceptionClass to raise if the block fails to terminate insecseconds. Omitting will use the default,Timeout::ErrormessageErrormessage to raise withExceptionClass. Omitting will use the default, “execution expired”
Returns the result of the blockif the block completed beforesec seconds, otherwise throws an exception, based on the value ofklass.
The exception thrown to terminate the given block cannot be rescued inside the block unlessklass is given explicitly. However, the block can use ensure to prevent the handling of the exception. For that reason, this method cannot be relied on to enforce timeouts for untrusted blocks.
If a scheduler is defined, it will be used to handle the timeout by invoking Scheduler#timeout_after.
Note that this is both a method of moduleTimeout, so you caninclude Timeout into your classes so they have atimeout method, as well as a module method, so you can call it directly asTimeout.timeout().