https://github.com/ruby/timeout

Timeout provides a way to auto-terminate a potentially long-running operation if it hasn't finished in a fixed amount of time.
https://github.com/ruby/timeout

ruby

Last synced: about 1 month ago
JSON representation

Timeout provides a way to auto-terminate a potentially long-running operation if it hasn't finished in a fixed amount of time.

• Host: GitHub
• URL: https://github.com/ruby/timeout
• Owner: ruby
• License: bsd-2-clause
• Created: 2019-08-06T03:47:53.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-31T00:43:13.000Z (10 months ago)
• Last Synced: 2024-05-08T18:40:25.016Z (6 months ago)
• Topics: ruby
• Language: Ruby
• Homepage:
• Size: 133 KB
• Stars: 136
• Watchers: 32
• Forks: 20
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
# Timeout

Timeout provides a way to auto-terminate a potentially long-running

operation if it hasn't finished in a fixed amount of time.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'timeout'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install timeout

## Usage

```ruby

require 'timeout'

status = Timeout.timeout(5) {

  # Something that should be interrupted if it takes more than 5 seconds...

}

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/timeout.