Sha256: 540c175177bb8db1a3ac6f42af3d4cd181c7b9d2809ce581aca97147d372097b
Contents?: true
Size: 1.09 KB
Versions: 4
Compression:
Stored size: 1.09 KB
Contents
# 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.
Version data entries
4 entries across 3 versions & 2 rubygems