Module: Mongo::Timeout

Defined in:
lib/mongo/timeout.rb

Class Method Summary collapse

Class Method Details

.timeout(sec, klass = nil, message = nil) ⇒ Object

Note:

Ruby versions older than 2.4.0 do not support specifying a custom error message, and any error message passed in as an argument will be ignored.

A wrapper around Ruby core’s Timeout::timeout method that provides a standardized API for Ruby versions older and newer than 2.4.0, which is when the third argument was introduced.

Parameters:

  • sec (Numeric) —

    The number of seconds before timeout.

  • klass (Class) (defaults to: nil) —

    The exception class to raise on timeout, optional. When no error exception is provided, Timeout::Error is raised.

  • message (String) (defaults to: nil) —

    The error message passed to the exception raised on timeout, optional. When no error message is provided, the default error message is “execution expired”.



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/mongo/timeout.rb', line 32

def timeout(sec, klass=nil, message=nil)
  if RUBY_VERSION < '2.4.0'
    ::Timeout.timeout(sec, klass) do
      yield
    end
  else
    # Jruby Timeout::timeout method does not support passing nil arguments.
    # Remove the nil arguments before passing them along to the core
    # Timeout::timeout method.
    optional_args = [klass, message].compact
    ::Timeout.timeout(sec, *optional_args) do
      yield
    end
  end
end