WEBrick::Utils::TimeoutHandler

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’

Public Class Methods

cancel(id) click to toggle source

Cancels the timeout handler id

 
               # File webrick/utils.rb, line 167
def TimeoutHandler.cancel(id)
  TimeoutMutex.synchronize{
    instance.cancel(Thread.current, id)
  }
end

new() click to toggle source

 
               # File webrick/utils.rb, line 173
def initialize
  @timeout_info = Hash.new
  Thread.start{
    while true
      now = Time.now
      @timeout_info.each{|thread, ary|
        ary.dup.each{|info|
          time, exception = *info
          interrupt(thread, info.object_id, exception) if time < now
        }
      }
      sleep 0.5
    end
  }
end

Registers a new timeout handler

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

 
               # File webrick/utils.rb, line 159
def TimeoutHandler.register(seconds, exception)
  TimeoutMutex.synchronize{
    instance.register(Thread.current, Time.now + seconds, exception)
  }
end

Public Instance Methods

cancel(thread, id) click to toggle source

Cancels the timeout handler id

 
               # File webrick/utils.rb, line 212
def cancel(thread, id)
  if ary = @timeout_info[thread]
    ary.delete_if{|info| info.object_id == id }
    if ary.empty?
      @timeout_info.delete(thread)
    end
    return true
  end
  return false
end

interrupt(thread, id, exception) click to toggle source

Interrupts the timeout handler id and raises exception

 
               # File webrick/utils.rb, line 191
def interrupt(thread, id, exception)
  TimeoutMutex.synchronize{
    if cancel(thread, id) && thread.alive?
      thread.raise(exception, "execution timeout")
    end
  }
end

Registers a new timeout handler

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

 
               # File webrick/utils.rb, line 204
def register(thread, time, exception)
  @timeout_info[thread] ||= Array.new
  @timeout_info[thread] << [time, exception]
  return @timeout_info[thread].last.object_id
end

Commenting is here to help enhance the documentation. For example, sample code, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

Home Classes Methods

In Files

Parent

Methods

Included Modules

Class/Module Index

WEBrick::Utils::TimeoutHandler

Public Class Methods

Public Instance Methods