eventbox 0.1.0

data/lib/eventbox/timer.rb

@@ -0,0 +1,172 @@
+# frozen-string-literal: true
+
+class Eventbox
+  # Simple timer services for Eventboxes
+  #
+  # This module can be included into Eventbox classes to add simple timer functions.
+  #
+  #   class MyBox < Eventbox
+  #     include Eventbox::Timer
+  #
+  #     async_call def init
+  #       super   # make sure Timer#init is called
+  #       timer_after(1) do
+  #         puts "one second elapsed"
+  #       end
+  #     end
+  #   end
+  #
+  # The main functions are timer_after and timer_every.
+  # They schedule asynchronous calls to the given block:
+  #   timer_after(3) do
+  #     # executed once after 3 seconds
+  #   end
+  #
+  #   timer_every(3) do
+  #     # executed repeatedly every 3 seconds
+  #   end
+  #
+  # Both functions return an Alarm object which can be used to cancel the alarm through timer_cancel.
+  #
+  # timer_after, timer_every and timer_cancel can be used within the event scope, in actions and from external scope.
+  #
+  # {Timer} always uses one action thread per Eventbox object, regardless of the number of scheduled timers.
+  module Timer
+    class Reload < RuntimeError
+    end
+    class InternalError < RuntimeError
+    end
+
+    class Alarm
+      # @private
+      def initialize(ts, &block)
+        @timestamp = ts
+        @block = block
+      end
+
+      # @private
+      attr_reader :timestamp
+    end
+
+    class OneTimeAlarm < Alarm
+      # @private
+      def fire_then_repeat?(now=Time.now)
+        @block.call
+        false
+      end
+    end
+
+    class RepeatedAlarm < Alarm
+      # @private
+      def initialize(ts, every_seconds, &block)
+        super(ts, &block)
+        @every_seconds = every_seconds
+      end
+
+      # @private
+      def fire_then_repeat?(now=Time.now)
+        @block.call
+        @timestamp = now + @every_seconds
+        true
+      end
+    end
+
+    extend Boxable
+
+    # @private
+    private async_call def init(*args)
+      super
+      @timer_alarms = []
+      @timer_action = timer_start_worker
+    end
+
+    # @private
+    private action def timer_start_worker
+      loop do
+        begin
+          interval = timer_next_timestamp&.-(Time.now)
+          Thread.handle_interrupt(Reload => :on_blocking) do
+            if interval.nil?
+              Kernel.sleep
+            elsif interval > 0.0
+              Kernel.sleep(interval)
+            end
+          end
+        rescue Reload
+        else
+          timer_fire
+        end
+      end
+    end
+
+    # Schedule a one shot alarm
+    #
+    # Call the given block after half a second:
+    #   timer_after(0.5) do
+    #     # executed in 0.5 seconds
+    #   end
+    sync_call def timer_after(seconds, now=Time.now, &block)
+      a = OneTimeAlarm.new(now + seconds, &block)
+      timer_add_alarm(a)
+      a
+    end
+
+    # Schedule a repeated alarm
+    #
+    # Call the given block in after half a second and then repeatedly every 0.5 seconds:
+    #   timer_after(0.5) do
+    #     # executed every 0.5 seconds
+    #   end
+    sync_call def timer_every(seconds, now=Time.now, &block)
+      a = RepeatedAlarm.new(now + seconds, seconds, &block)
+      timer_add_alarm(a)
+      a
+    end
+
+    # Cancel an alarm previously scheduled per timer_after or timer_every
+    async_call def timer_cancel(alarm)
+      a = @timer_alarms.delete(alarm)
+      if a
+        timer_check_integrity
+      end
+    end
+
+    # @private
+    private def timer_add_alarm(alarm)
+      i = @timer_alarms.bsearch_index {|t| t.timestamp <= alarm.timestamp }
+      if i
+        @timer_alarms[i, 0] = alarm
+      else
+        @timer_alarms << alarm
+        @timer_action.raise(Reload) unless @timer_action.current?
+      end
+      timer_check_integrity
+    end
+
+    # @private
+    private def timer_check_integrity
+      @timer_alarms.inject(nil) do |min, a|
+        raise InternalError, "alarms are not ordered: #{@timer_alarms.inspect}" if min && min < a.timestamp
+        a.timestamp
+      end
+    end
+
+    # @private
+    private sync_call def timer_next_timestamp
+      @timer_alarms.last&.timestamp
+    end
+
+    # @private
+    private sync_call def timer_fire(now=Time.now)
+      while @timer_alarms.last&.timestamp&.<=(now)
+        a = @timer_alarms.pop
+        if a.fire_then_repeat?(now)
+          timer_add_alarm(a)
+        end
+        timer_check_integrity
+      end
+      # the method result is irrelevant, but sync_call is necessary to yield the timer blocks
+      nil
+    end
+  end
+end

data/lib/eventbox/version.rb

@@ -0,0 +1,5 @@
+# frozen-string-literal: true
+
+class Eventbox
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: eventbox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lars Kanis
+autorequire: 
+bindir: exe
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDPDCCAiSgAwIBAgIBBTANBgkqhkiG9w0BAQsFADBEMQ0wCwYDVQQDDARsYXJz
+  MR8wHQYKCZImiZPyLGQBGRYPZ3JlaXotcmVpbnNkb3JmMRIwEAYKCZImiZPyLGQB
+  GRYCZGUwHhcNMTgwOTE0MjE0NjIyWhcNMTkwOTE0MjE0NjIyWjBEMQ0wCwYDVQQD
+  DARsYXJzMR8wHQYKCZImiZPyLGQBGRYPZ3JlaXotcmVpbnNkb3JmMRIwEAYKCZIm
+  iZPyLGQBGRYCZGUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDZb4Uv
+  RFJfRu/VEWiy3psh2jinETjiuBrL0NeRFGf8H7iU9+gx/DI/FFhfHGLrDeIskrJx
+  YIWDMmEjVO10UUdj7wu4ZhmU++0Cd7Kq9/TyP/shIP3IjqHjVLCnJ3P6f1cl5rxZ
+  gqo+d3BAoDrmPk0rtaf6QopwUw9RBiF8V4HqvpiY+ruJotP5UQDP4/lVOKvA8PI9
+  P0GmVbFBrbc7Zt5h78N3UyOK0u+nvOC23BvyHXzCtcFsXCoEkt+Wwh0RFqVZdnjM
+  LMO2vULHKKHDdX54K/sbVCj9pN9h1aotNzrEyo55zxn0G9PHg/G3P8nMvAXPkUTe
+  brhXrfCwWRvOXA4TAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0G
+  A1UdDgQWBBRAHK81igrXodaDj8a8/BIKsaZrETANBgkqhkiG9w0BAQsFAAOCAQEA
+  ZNTM80Pn9caTOcDYCmJi28qV0H8x6k5zeEd8PckEr9gYCFrUtVvtQPBi364PWo82
+  Img1GQle3nbhYuiNPRsjfr0uaTgUeA7JXw5OCEtgck2w93KzFISBt+jLyoprAJDh
+  uHImSFGzjRwHVi2Kihh1y4VR0ZkofNWaPqhxhxN7JCTVrV8MLqe2ZgHoe1WMGAyT
+  mmzdbSP3kmz9L2eshisCKPSi0qKk4VyBhdeeIf+3xMim/DK1gTz44BwHSCtGkaJT
+  NOQ0Qq2j8NtFfBHqGHBKaqj/Q0AciwGWIMfXJh3fTsRuMonkEu6TgB6M79HzgqQ8
+  sXOGZvvDWUBn5GWztfhdZw==
+  -----END CERTIFICATE-----
+date: 2018-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: |-
+  {Eventbox} objects are event based and single threaded from the inside but thread-safe and blocking from the outside.
+  Eventbox enforces a separation of code for event processing and code running blocking operations.
+  Code inside an {Eventbox} object is executed non-concurrently and hence shouldn't do any blocking operations.
+  This is similar to the typical JavaScript programming style.
+email:
+- lars@greiz-reinsdorf.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".appveyor.yml"
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docs/downloads.md
+- docs/server.md
+- docs/threadpool.md
+- eventbox.gemspec
+- lib/eventbox.rb
+- lib/eventbox/argument_wrapper.rb
+- lib/eventbox/boxable.rb
+- lib/eventbox/event_loop.rb
+- lib/eventbox/object_registry.rb
+- lib/eventbox/sanitizer.rb
+- lib/eventbox/thread_pool.rb
+- lib/eventbox/timer.rb
+- lib/eventbox/version.rb
+homepage: https://github.com/larskanis/eventbox
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Manage multithreading with the safety of event based programming
+test_files: []