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

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

### Home Classes Methods

### In Files

- webrick/utils.rb

### Parent

Object

### Methods

- ::cancel
- ::new
- ::register
- ::terminate

### Included Modules

- Singleton

### Class/Module Index

Quicksearch

- Errno
- Errno::ECONNABORTED
- Errno::ECONNRESET
- Errno::EPROTO
- Object
- WEBrick
- WEBrick::AccessLog
- WEBrick::AccessLog::AccessLogError
- WEBrick::BasicLog
- WEBrick::CGI
- WEBrick::Config
- 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

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 143
    def TimeoutHandler.cancel(id)
      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 154
    def initialize
      TimeoutMutex.synchronize{
        @timeout_info = Hash.new
      }
      @queue = Thread::Queue.new
      @watcher = nil
    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 136
    def TimeoutHandler.register(seconds, exception)
      at = Process.clock_gettime(Process::CLOCK_MONOTONIC) + seconds
      instance.register(Thread.current, at, exception)
    end

terminate() click to toggle source

                   # File webrick/utils.rb, line 147
    def self.terminate
      instance.terminate
    end