Class: WEBrick::Utils::TimeoutHandler (Ruby 2.2.3)
Description: Class : WEBrick::Utils::TimeoutHandler - Ruby 2.2.3

- Home
- Core 2.2.3
- Std-lib 2.2.3
- Downloads

Support for the Ruby 2.2 series has ended. See here for reference.

### Home Classes Methods

### In Files

- webrick/utils.rb

### Parent

Object

### Namespace

- CLASS WEBrick::Utils::TimeoutHandler::Thread

### Methods

- ::cancel
- ::new
- ::register
- #cancel
- #interrupt
- #register

### Included Modules

- Singleton

### Class/Module Index

Quicksearch

- Dir
- Errno
- Errno::ECONNABORTED
- Errno::ECONNRESET
- Errno::EPROTO
- File
- Object
- WEBrick
- WEBrick::AccessLog
- WEBrick::AccessLog::AccessLogError
- WEBrick::BasicLog
- WEBrick::CGI
- WEBrick::Config
- WEBrick::Config::OpenSSL
- WEBrick::Cookie
- WEBrick::Daemon
- WEBrick::GenericServer
- WEBrick::HTMLUtils
- WEBrick::HTTPAuth
- WEBrick::HTTPAuth::Authenticator
- WEBrick::HTTPAuth::BasicAuth
- WEBrick::HTTPAuth::DigestAuth
- WEBrick::HTTPAuth::Htdigest
- WEBrick::HTTPAuth::Htgroup
- WEBrick::HTTPAuth::Htpasswd
- WEBrick::HTTPAuth::ProxyAuthenticator
- WEBrick::HTTPAuth::ProxyBasicAuth
- WEBrick::HTTPAuth::ProxyDigestAuth
- WEBrick::HTTPAuth::UserDB
- WEBrick::HTTPProxyServer
- WEBrick::HTTPRequest
- WEBrick::HTTPResponse
- WEBrick::HTTPServer
- WEBrick::HTTPServerError
- WEBrick::HTTPServlet
- WEBrick::HTTPServlet::AbstractServlet
- WEBrick::HTTPServlet::CGIHandler
- WEBrick::HTTPServlet::DefaultFileHandler
- WEBrick::HTTPServlet::ERBHandler
- WEBrick::HTTPServlet::FileHandler
- WEBrick::HTTPServlet::HTTPServletError
- WEBrick::HTTPServlet::ProcHandler
- WEBrick::HTTPStatus
- WEBrick::HTTPStatus::ClientError
- WEBrick::HTTPStatus::EOFError
- WEBrick::HTTPStatus::Error
- WEBrick::HTTPStatus::Info
- WEBrick::HTTPStatus::Redirect
- WEBrick::HTTPStatus::ServerError
- WEBrick::HTTPStatus::Status
- WEBrick::HTTPStatus::Success
- WEBrick::HTTPUtils
- WEBrick::HTTPUtils::FormData
- WEBrick::HTTPVersion
- WEBrick::Log
- WEBrick::ServerError
- WEBrick::SimpleServer
- WEBrick::Utils
- WEBrick::Utils::TimeoutHandler
- WEBrick::Utils::TimeoutHandler::Thread

No matching classes.

# 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 151
    def TimeoutHandler.cancel(id)
      TimeoutMutex.synchronize{
        instance.cancel(Thread.current, id)
      }
    end

new() click to toggle source

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

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

register(seconds, exception) click to toggle source

Registers a new timeout handler

`time`

  Timeout in seconds

`exception`

  Exception to raise when timeout elapsed

                   # File webrick/utils.rb, line 143
    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 201
    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 180
    def interrupt(thread, id, exception)
      TimeoutMutex.synchronize{
        if cancel(thread, id) && thread.alive?
          thread.raise(exception, "execution timeout")
        end
      }
    end

register(thread, time, exception) click to toggle source

Registers a new timeout handler

`time`

  Timeout in seconds

`exception`

  Exception to raise when timeout elapsed

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