eventkit-eventloop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 252201710cd3e7692c813b5ec3d9f1ee3b8e3797
+  data.tar.gz: fae28a14ee68d67e1cb2a7fc283bc7c8765efdf7
+SHA512:
+  metadata.gz: 436a8cf96fdfcf0d4adb5d9b53314c9a66757f4d3cd6cd18617eb016a90addd3d700d94173d2655134bc36b215cccdc928c4154f3542912626ef4832a8b54c32
+  data.tar.gz: 42424b8334681b6d179112c09c4a5d5f504bee1337b612943289d8a63effdbd1a27bff33138421780c110e6f271ee3c3b779fed877daa388fa2bf6c1373ae30f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eventkit-promise.gemspec
+gemspec
+
+group :test do
+  gem 'rake', '~> 10.4'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Oliver Martell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Eventkit::Eventloop
+
+[![Build Status](https://travis-ci.org/omartell/eventkit-eventloop.svg?branch=master)](https://travis-ci.org/omartell/eventkit-eventloop)
+
+A basic event loop implemented with Ruby's IO.select to perform non blocking IO.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eventkit-eventloop'
+```
+
+## Event Loop Usage
+
+Eventkit provides a basic event loop on top of Ruby's IO.select.
+Callbacks can be registered to monitor the readability or writability of IO objects.
+These callbacks are executed when the IO object is ready to be read or written to.
+
+Another feature is timers, which allows you to execute code at some point in the future.
+
+```ruby
+require 'eventkit/event_loop'
+
+# Getting notified when an IO object is ready to be read or written
+event_loop = Eventkit::EventLoop.new
+
+server = TCPServer.new('localhost', 9595)
+
+client = TCPSocket.new('localhost', 9595)
+
+event_loop.register_read(server) do |server|
+  # This will be executed every time a new connection is ready to be accepted
+  connection, _ = server.accept_nonblock
+  event_loop.register_write(connection) do |connection|
+    bytes_written = connection.write_nonblock('hello world')
+  end
+end
+
+event_loop.start
+
+
+# Unsubscribing from notifications
+# A single read
+event_loop.deregister_read(io_object, handler)
+
+# A single write
+event_loop.deregister_write(io_object, handler)
+
+# All handlers
+event_loop.deregister_write(io_object)
+event_loop.deregister_read(io_object)
+
+
+# Registering a handler to be run on the next tick
+event_loop = Eventkit::EventLoop.new
+
+event_loop.on_next_tick do
+  puts 'hello world'
+  event_loop.stop
+end
+
+event_loop.start
+
+
+# Registering timers
+
+event_loop = Eventkit::EventLoop.new
+
+event_loop.register_timer(run_in: 5) do
+  # Block executes after 5 seconds have passed
+  puts 'hello world'
+  event_loop.stop
+end
+
+event_loop.start
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/eventkit-eventloop/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/eventkit-eventloop.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eventkit/event_loop'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eventkit-eventloop"
+  spec.version       = Eventkit::EventLoop::VERSION
+  spec.authors       = ["Oliver Martell"]
+  spec.email         = ["oliver.martell@gmail.com"]
+
+  spec.summary       = "Event loop for non blocking IO"
+  spec.description   =
+    "Event loop on top of IO.select for non blocking IO"
+  spec.homepage      = "http://github.com/omartell/eventkit-eventloop"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+end

data/lib/eventkit/event_loop.rb

@@ -0,0 +1,95 @@
+require 'set'
+require 'eventkit/timer'
+
+module Eventkit
+  class EventLoopAlreadyStartedError < StandardError; end
+
+  class EventLoop
+    VERSION = "0.1.0"
+    attr_reader :select_interval
+    private :select_interval
+
+    def initialize(config = {})
+      @read_handlers = Hash.new { |h, k| h[k] = [] }
+      @write_handlers = Hash.new { |h, k| h[k] = [] }
+      @select_interval = config.fetch(:select_interval, 1 / 100_000)
+      @timers = SortedSet.new
+      @stopped = false
+      @started = false
+    end
+
+    def start(&_block)
+      if @started
+        fail EventLoopAlreadyStartedError, 'This event loop instance has already started running'
+      else
+        @started = true
+      end
+
+      loop do
+        if stop_scheduled?
+          @stopped = false
+          break
+        end
+        tick
+      end
+    end
+
+    def stop
+      @stopped = true
+      @started = false
+    end
+
+    def stop_scheduled?
+      @stopped
+    end
+
+    def tick
+      ready_read, ready_write, _ = IO.select(@read_handlers.keys, @write_handlers.keys, [], select_interval)
+      ready_read.each { |io|
+        @read_handlers.fetch(io).each { |handler| handler.call(io) }
+      } if ready_read
+
+      ready_write.each { |io|
+        @write_handlers.fetch(io).each { |handler| handler.call(io) }
+      } if ready_write
+
+      @timers.select(&:expired?).each { |timer|
+        timer.handler.call
+        @timers.delete(timer)
+      }
+      nil
+    end
+
+    def on_next_tick(&handler)
+      register_timer(run_in: 0, &handler)
+    end
+
+    def register_timer(options, &handler)
+      @timers << Timer.new(options.fetch(:run_in), handler)
+    end
+
+    def register_read(io, &listener)
+      @read_handlers[io] += [listener]
+    end
+
+    def deregister_read(io, listener = nil)
+      if listener
+        @read_handlers[io] -= [listener]
+      else
+        @read_handlers[io] = []
+      end
+    end
+
+    def register_write(io, &listener)
+      @write_handlers[io] += [listener]
+    end
+
+    def deregister_write(io, listener = nil)
+      if listener
+        @write_handlers[io] -= [listener]
+      else
+        @write_handlers[io] = []
+      end
+    end
+  end
+end

data/lib/eventkit/timer.rb

@@ -0,0 +1,15 @@
+module Eventkit
+  Timer = Struct.new(:expires_in, :handler) do
+    def initialize(seconds, handler)
+      super(Time.now.to_f + seconds, handler)
+    end
+
+    def <=>(other)
+      expires_in <=> other.expires_in
+    end
+
+    def expired?
+      expires_in <= Time.now.to_f
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: eventkit-eventloop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oliver Martell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Event loop on top of IO.select for non blocking IO
+email:
+- oliver.martell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- eventkit-eventloop.gemspec
+- lib/eventkit/event_loop.rb
+- lib/eventkit/timer.rb
+homepage: http://github.com/omartell/eventkit-eventloop
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Event loop for non blocking IO
+test_files: []