# timeout.rb

Path: | timeout.rb
Last Update: | Wed Jul 30 23:30:28 GMT+10:00 2003

     timeout.rb -- execution timeout

     Copyright (C) 2000  Network Applied Communication Laboratory, Inc.
     Copyright (C) 2000  Information-technology Promotion Agency, Japan

# SYNOPSIS

       require 'timeout'
       status = timeout(5) {
         # something may take time
       }

# DESCRIPTION

     timeout executes the block.  If the block execution terminates successfully
     before timeout, it returns true.  If not, it terminates the execution and
     raise TimeoutError exception.

## Parameters

      : timout

        The time in seconds to wait for block teminatation.

      : [exception]

        The exception classs to be raised on timeout.

# end

## Methods

timeout

## Constants

TimeoutError | = | Timeout::Error

## Classes and Modules

Module Timeout
::Class Timeout::Error

## Public Instance methods

timeout(n, e=Timeout::Error, &block)

compatible

[Source]

    # File timeout.rb, line 54
    def timeout(n, e=Timeout::Error, &block)
      Timeout::timeout(n, e, &block)
    end

[Validate]