WEBrick::Utils::TimeoutHandler

Class

Class used to manage timeout handlers across multiple threads.

Timeout handlers should be managed by using the class methods which are synchronized.

id = TimeoutHandler.register(10, Timeout::Error)
begin
  sleep 20
  puts 'foo'
ensure
  TimeoutHandler.cancel(id)
end

will raise Timeout::Error

id = TimeoutHandler.register(10, Timeout::Error)
begin
  sleep 5
  puts 'foo'
ensure
  TimeoutHandler.cancel(id)
end

will print ‘foo’

Constants

TimeoutMutex

Mutex used to synchronize access across threads

Class Methods

cancel(id)

lib/webrick/utils.rb View on GitHub

          
            # File tmp/rubies/ruby-2.6.10/lib/webrick/utils.rb, line 142
def TimeoutHandler.cancel(id)
  instance.cancel(Thread.current, id)
end

Cancels the timeout handler id

new

lib/webrick/utils.rb View on GitHub

          
            # File tmp/rubies/ruby-2.6.10/lib/webrick/utils.rb, line 153
def initialize
  TimeoutMutex.synchronize{
    @timeout_info = Hash.new
  }
  @queue = Thread::Queue.new
  @watcher = nil
end

Creates a new TimeoutHandler. You should use ::register and ::cancel instead of creating the timeout handler directly.

register(seconds, exception)

lib/webrick/utils.rb View on GitHub

          
            # File tmp/rubies/ruby-2.6.10/lib/webrick/utils.rb, line 135
def TimeoutHandler.register(seconds, exception)
  at = Process.clock_gettime(Process::CLOCK_MONOTONIC) + seconds
  instance.register(Thread.current, at, exception)
end

Registers a new timeout handler

time: Timeout in seconds
exception: Exception to raise when timeout elapsed

terminate

lib/webrick/utils.rb View on GitHub

          
            # File tmp/rubies/ruby-2.6.10/lib/webrick/utils.rb, line 146
def self.terminate
  instance.terminate
end

No documentation available