Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/socketry/lightio
LightIO is a userland implemented green thread library for ruby
https://github.com/socketry/lightio
async concurrency eventloop fiber green io multithreading networking ruby thread
Last synced: 3 months ago
JSON representation
LightIO is a userland implemented green thread library for ruby
- Host: GitHub
- URL: https://github.com/socketry/lightio
- Owner: socketry
- License: mit
- Created: 2017-11-29T13:59:12.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-06-09T07:11:48.000Z (over 3 years ago)
- Last Synced: 2024-10-31T13:25:32.759Z (3 months ago)
- Topics: async, concurrency, eventloop, fiber, green, io, multithreading, networking, ruby, thread
- Language: Ruby
- Homepage:
- Size: 192 KB
- Stars: 162
- Watchers: 9
- Forks: 6
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# LightIO
[](http://rubygems.org/gems/lightio)
[](https://travis-ci.org/socketry/lightio)
[](https://coveralls.io/github/socketry/lightio?branch=master)
[](https://github.com/jjyr/lightio/blob/master/LICENSE.txt)
[](https://gitter.im/lightio-dev/Lobby)
LightIO provides green thread to ruby. Like Golang's goroutine, or Crystal's fiber. In LightIO it is called beam.
Example:
``` ruby
require 'lightio'
start = Time.now
beams = 1000.times.map do
# LightIO::Beam is green-thread, use it instead Thread
LightIO::Beam.new do
# do some io operations in beam
LightIO.sleep(1)
end
end
beams.each(&:join)
seconds = Time.now - start
puts "1000 beams take #{seconds - 1} seconds to create"
```
LightIO ship ruby stdlib compatible library under `LightIO` or `LightIO::Library` namespace,
these libraries provide the ability to schedule LightIO beams when IO operations occur.
LightIO also provide a monkey patch, it replaces ruby `Thread` with `LightIO::Thread`, and also replaces `IO` related classes.
Example:
``` ruby
require 'lightio'
# apply monkey patch at beginning
LightIO::Monkey.patch_all!
require 'net/http'
host = 'github.com'
port = 443
start = Time.now
10.times.map do
Thread.new do
Net::HTTP.start(host, port, use_ssl: true) do |http|
res = http.request_get('/ping')
p res.code
end
end
end.each(&:join)
puts "#{Time.now - start} seconds"
```
See [Examples](/examples) for detail.
### You Should Know
In fact ruby core team already plan to implement `Thread::Green` in core language, see https://bugs.ruby-lang.org/issues/13618
It means if ruby implemented `Thread::Green`, this library has no reason to exist.
But as a crazy userland implemented green thread library, it bring lots of fun to me, so I will continue to maintain it, and welcome to use.
See [Wiki](https://github.com/jjyr/lightio/wiki) and [Roadmap](https://github.com/jjyr/lightio/wiki/Current-status-and-roadmap) to get more information.
LightIO is build upon [nio4r](https://github.com/socketry/nio4r). Get heavily inspired by [gevent](http://www.gevent.org/), [async-io](https://github.com/socketry/async-io).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'lightio'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install lightio
## Documentation
[Please see LightIO Wiki](https://github.com/jjyr/lightio/wiki) for more information.
The following documentations is also usable:
* [Basic usage](https://github.com/socketry/lightio/wiki/Basic-Usage)
* [YARD documentation](http://www.rubydoc.info/github/socketry/lightio/master)
* [Examples](/examples)
## Discussion
https://groups.google.com/group/lightio
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/jjyr/lightio. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
Copyright, 2017-2018, by [Jiang Jinyang](http://justjjy.com/)
## Code of Conduct
Everyone interacting in the Lightio project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lightio/blob/master/CODE_OF_CONDUCT.md).