rsmp 0.8.6 → 0.9.0

data/lib/rsmp/supervisor.rb

@@ -58,26 +58,31 @@ module RSMP
       end
     end
 
-    def start_action
+    # listen for connections
+    # Async::IO::Endpoint#accept createa an async task that we will wait for
+    def run
+      log "Starting supervisor on port #{@supervisor_settings["port"]}",
+          level: :info,
+          timestamp: @clock.now
+
       @endpoint = Async::IO::Endpoint.tcp('0.0.0.0', @supervisor_settings["port"])
-      @endpoint.accept do |socket|  # creates async tasks
+      tasks = @endpoint.accept do |socket|  # creates async tasks
         handle_connection(socket)
       rescue StandardError => e
         notify_error e, level: :internal
       end
+      tasks.each { |task| task.wait }
     rescue StandardError => e
       notify_error e, level: :internal
     end
 
+    # stop
     def stop
       log "Stopping supervisor #{@supervisor_settings["site_id"]}", level: :info
-      @proxies.each { |proxy| proxy.stop }
-      @proxies.clear
       super
-      @tcp_server.close if @tcp_server
-      @tcp_server = nil
     end
 
+    # handle an incoming connction by either accepting of rejecting it
     def handle_connection socket
       remote_port = socket.remote_address.ip_port
       remote_hostname = socket.remote_address.ip_address
@@ -85,9 +90,9 @@ module RSMP
 
       info = {ip:remote_ip, port:remote_port, hostname:remote_hostname, now:Clock.now}
       if accept? socket, info
-        connect socket, info
+        accept_connection socket, info
       else
-        reject socket, info
+        reject_connection socket, info
       end
     rescue ConnectionError => e
       log "Rejected connection from #{remote_ip}:#{remote_port}, #{e.to_s}", level: :warning
@@ -99,12 +104,6 @@ module RSMP
       close socket, info
     end
 
-    def starting
-      log "Starting supervisor on port #{@supervisor_settings["port"]}", 
-          level: :info,
-          timestamp: @clock.now
-    end
-
     def accept? socket, info
       true
     end
@@ -143,7 +142,8 @@ module RSMP
       message.attribute('siteId').first['sId']
     end
 
-    def connect socket, info
+    # accept an incoming connecting by creating and starting a proxy
+    def accept_connection socket, info
       log "Site connected from #{format_ip_and_port(info)}",
           ip: info[:ip],
           port: info[:port],
@@ -182,7 +182,8 @@ module RSMP
         proxy = build_proxy settings.merge(site_id:id)    # keep the id learned by peeking above
         @proxies.push proxy
       end
-      proxy.run     # will run until the site disconnects
+      proxy.start     # will run until the site disconnects
+      proxy.wait
     ensure
       site_ids_changed
       stop if @supervisor_settings['one_shot']
@@ -192,7 +193,7 @@ module RSMP
       @site_id_condition.signal
     end
 
-    def reject socket, info
+    def reject_connection socket, info
       log "Site rejected", ip: info[:ip], level: :info
     end
 
@@ -224,10 +225,13 @@ module RSMP
       nil
     end
 
-    def wait_for_site site_id, timeout
+    def wait_for_site site_id, timeout:
       site = find_site site_id
       return site if site
-      wait_for(@site_id_condition,timeout) { find_site site_id }
+      wait_for_condition(@site_id_condition,timeout:timeout) do
+        find_site site_id
+      end
+
     rescue Async::TimeoutError
       if site_id == :any
         str = "No site connected"
@@ -237,8 +241,8 @@ module RSMP
       raise RSMP::TimeoutError.new "#{str} within #{timeout}s"
     end
 
-    def wait_for_site_disconnect site_id, timeout
-      wait_for(@site_id_condition,timeout) { true unless find_site site_id }
+    def wait_for_site_disconnect site_id, timeout:
+      wait_for_condition(@site_id_condition,timeout:timeout) { true unless find_site site_id }
     rescue Async::TimeoutError
       raise RSMP::TimeoutError.new "Site '#{site_id}' did not disconnect within #{timeout}s"
     end

data/lib/rsmp/supervisor_proxy.rb

@@ -2,7 +2,7 @@
 
 require 'digest'
 
-module RSMP  
+module RSMP
   class SupervisorProxy < Proxy
 
     attr_reader :supervisor_id, :site
@@ -22,44 +22,67 @@ module RSMP
       site
     end
 
-    def start
+    # handle communication
+    # if disconnected, then try to reconnect
+    def run
+      loop do
+        connect
+        start_reader
+        start_handshake
+        wait_for_reader   # run until disconnected
+        break if reconnect_delay == false
+      rescue Restart
+        @logger.mute @ip, @port
+        raise
+      rescue RSMP::ConnectionError => e
+        log e, level: :error
+        break if reconnect_delay == false
+      rescue StandardError => e
+        notify_error e, level: :internal
+        break if reconnect_delay == false
+      ensure
+        close
+        stop_subtasks
+      end
+    end
+
+    def start_handshake
+      send_version @site_settings['site_id'], @site_settings["rsmp_versions"]
+    end
+
+    # connect to the supervisor and initiate handshake supervisor
+    def connect
       log "Connecting to supervisor at #{@ip}:#{@port}", level: :info
-      super
-      connect
+      set_state :connecting
+      connect_tcp
       @logger.unmute @ip, @port
       log "Connected to supervisor at #{@ip}:#{@port}", level: :info
-      start_reader
-      send_version @site_settings['site_id'], @site_settings["rsmp_versions"]
     rescue SystemCallError => e
-      log "Could not connect to supervisor at #{@ip}:#{@port}: Errno #{e.errno} #{e}", level: :error
-      retry_notice
+      raise ConnectionError.new "Could not connect to supervisor at #{@ip}:#{@port}: Errno #{e.errno} #{e}"
     rescue StandardError => e
-      log "Error while connecting to supervisor at #{@ip}:#{@port}: #{e}", level: :error
-      retry_notice
-    end
-
-    def retry_notice
-      unless @site.site_settings['intervals']['reconnect'] == :no
-        log "Will try to reconnect again every #{@site.site_settings['intervals']['reconnect']} seconds..", level: :info
-        @logger.mute @ip, @port
-      end
+      raise ConnectionError.new "Error while connecting to supervisor at #{@ip}:#{@port}: #{e}"
     end
 
-    def stop
-      log "Closing connection to supervisor", level: :info
+    def stop_task
       super
       @last_status_sent = nil
     end
 
-    def connect
-      return if @socket
+    def connect_tcp
       @endpoint = Async::IO::Endpoint.tcp(@ip, @port)
-      @socket = @endpoint.connect
+
+      # Async::IO::Endpoint#connect renames the current task. run in a subtask to avoid this
+      @task.async do |task|
+        task.annotate 'socket task'
+        @socket = @endpoint.connect
+      end.wait
+
       @stream = Async::IO::Stream.new(@socket)
       @protocol = Async::IO::Protocol::Line.new(@stream,WRAPPING_DELIMITER) # rsmp messages are json terminated with a form-feed
+      set_state :connected
     end
 
-    def connection_complete
+    def handshake_complete
       super
       sanitized_sxl_version = RSMP::Schemer.sanitize_version(sxl_version)
       log "Connection to supervisor established, using core #{@rsmp_version}, #{sxl} #{sanitized_sxl_version}", level: :info
@@ -114,16 +137,19 @@ module RSMP
     end
 
     def reconnect_delay
+      return false if @site_settings['intervals']['reconnect'] == :no
       interval = @site_settings['intervals']['reconnect']
-      log "Waiting #{interval} seconds before trying to reconnect", level: :info
+      log "Will try to reconnect again every #{interval} seconds...", level: :info
+      @logger.mute @ip, @port
       @task.sleep interval
+      true
     end
 
     def version_accepted message
       log "Received Version message, using RSMP #{@rsmp_version}", message: message, level: :log
       start_timer
       acknowledge message
-      connection_complete
+      handshake_complete
       @version_determined = true
     end
 
@@ -234,7 +260,7 @@ module RSMP
       update_list = {}
       component = message.attributes["cId"]
       @status_subscriptions[component] ||= {}
-      update_list[component] ||= {} 
+      update_list[component] ||= {}
       now = Time.now  # internal timestamp
       subs = @status_subscriptions[component]
 
@@ -299,7 +325,7 @@ module RSMP
           by_name.each_pair do |name,subscription|
             current = nil
             should_send = false
-            if subscription[:interval] == 0 
+            if subscription[:interval] == 0
               # send as soon as the data changes
               if component_object
                 current, age = *(component_object.get_status code, name)

data/lib/rsmp/task.rb

@@ -0,0 +1,84 @@
+module RSMP
+  class Restart < StandardError
+  end
+
+  module Task
+    attr_reader :task
+
+    def initialize_task
+      @task = nil
+    end
+
+    # start our async tasks and return immediately
+    # run() will be called inside the task to perform actual long-running work
+    def start
+      return if @task
+      Async do |task|
+        task.annotate "#{self.class.name} main task"
+        @task = task
+        run
+        stop_subtasks
+        @task = nil
+      end
+      self
+    end
+
+    # initiate restart by raising a Restart exception
+    def restart
+      raise Restart.new "restart initiated by #{self.class.name}:#{object_id}"
+    end
+
+    # get the status of our task, or nil of no task
+    def status
+      @task.status if @task
+    end
+
+    # perform any long-running work
+    # the method will be called from an async task, and should not return
+    # if subtasks are needed, the method should call wait() on each of them
+    # once running, ready() must be called
+    def run
+      start_subtasks
+    end
+
+    # wait for our task to complete
+    def wait
+      @task.wait if @task
+    end
+
+    # stop our task
+    def stop
+      stop_subtasks
+      stop_task if @task
+    end
+
+    def stop_subtasks
+    end
+
+    # stop our task and any subtask
+    def stop_task
+      @task.stop
+      @task = nil
+    end
+
+    # wait for an async condition to signal, then yield to block
+    # if block returns true we're done. otherwise, wait again
+    def wait_for_condition condition, timeout:, task:Async::Task.current, &block
+      unless task
+        raise RuntimeError.new("Can't wait without a task")
+      end
+      task.with_timeout(timeout) do
+        while task.running?
+          value = condition.wait
+          return value unless block
+          result = yield value
+          return result if result
+        end
+        raise RuntimeError.new("Can't wait for condition because task #{task.object_id} #{task.annotation} is not running")
+      end
+    rescue Async::TimeoutError
+      raise RSMP::TimeoutError.new
+    end
+
+  end
+end

data/lib/rsmp/tlc/signal_group.rb

@@ -9,25 +9,27 @@ module RSMP
       end
 
       def timer
-        @state = get_state
+        @state = compute_state
       end
 
-      def get_state
+      def compute_state
         return 'a' if node.main.dark_mode
         return 'c' if node.main.yellow_flash
 
         cycle_counter = node.main.cycle_counter
 
         if node.main.startup_sequence_active
-          @state = node.main.startup_state || 'a'
+          return node.main.startup_state || 'a'
         end
 
         default = 'a'   # phase a means disabled/dark
         plan = node.main.current_plan
         return default unless plan
         return default unless plan.states
+
         states = plan.states[c_id]
         return default unless states
+
         state = states[cycle_counter]
         return default unless state =~ /[a-hA-G0-9N-P]/  # valid signal group states
         state

data/lib/rsmp/tlc/signal_plan.rb

@@ -1,8 +1,8 @@
 module RSMP
   module TLC
     # A Traffic Light Controller Signal Plan.
-    # A signal plan is a description of how all signal groups should change 
-    # state over time. 
+    # A signal plan is a description of how all signal groups should change
+    # state over time.
     class SignalPlan
       attr_reader :nr, :states, :dynamic_bands
       def initialize nr:, states:, dynamic_bands:

data/lib/rsmp/tlc/traffic_controller.rb

@@ -23,24 +23,29 @@ module RSMP
         reset
       end
 
-      def reset
-        @cycle_counter = 0
-        @plan = 1
+      def reset_modes
         @dark_mode = true
         @yellow_flash = false
         @booting = false
-        @control_mode = 'control'
-        @police_key = 0
-        @intersection = 0
         @is_starting = false
-        @emergency_route = false
-        @emergency_route_number = 0
-        @traffic_situation = 0
+        @control_mode = 'control'
         @manual_control = false
         @fixed_time_control = false
         @isolated_control = false
         @yellow_flash = false
         @all_red = false
+        @police_key = 0
+      end
+
+      def reset
+        reset_modes
+
+        @cycle_counter = 0
+        @plan = 1
+        @intersection = 0
+        @emergency_route = false
+        @emergency_route_number = 0
+        @traffic_situation = 0
 
         @inputs = '0'*@num_inputs
         @input_activations = '0'*@num_inputs
@@ -76,12 +81,14 @@ module RSMP
 
       def timer now
         # TODO use monotone timer, to avoid jumps in case the user sets the system time
-        @signal_groups.each { |group| group.timer }
         time = Time.now.to_i
         return if time == @time_int
         @time_int = time
         move_cycle_counter
         move_startup_sequence if @startup_sequence_active
+
+        @signal_groups.each { |group| group.timer }
+
         output_states
       end
 
@@ -98,6 +105,8 @@ module RSMP
 
       def initiate_startup_sequence
         log "Initiating startup sequence", level: :info
+        reset_modes
+        @dark_mode = false
         @startup_sequence_active = true
         @startup_sequence_initiated_at = nil
         @startup_sequence_pos = nil
@@ -107,7 +116,6 @@ module RSMP
         @startup_sequence_active = false
         @startup_sequence_initiated_at = nil
         @startup_sequence_pos = nil
-
         @yellow_flash = false
         @dark_mode = false
       end
@@ -127,26 +135,40 @@ module RSMP
 
       def output_states
         return unless @live_output
+
         str = @signal_groups.map do |group|
-          s = "#{group.c_id}:#{group.state}"
-          if group.state =~ /^[1-9]$/
+          state = group.state
+          s = "#{group.c_id}:#{state}"
+          if state =~ /^[1-9]$/
               s.colorize(:green)
-          elsif group.state =~ /^[NOP]$/
+          elsif state =~ /^[NOP]$/
             s.colorize(:yellow)
-          elsif group.state =~ /^[ae]$/
-            s.colorize(:black)
-          elsif group.state =~ /^[f]$/
+          elsif state =~ /^[ae]$/
+            s.colorize(:light_black)
+          elsif state =~ /^[f]$/
             s.colorize(:yellow)
-          elsif group.state =~ /^[g]$/
+          elsif state =~ /^[g]$/
             s.colorize(:red)
           else
             s.colorize(:red)
           end
         end.join ' '
+
+        modes = '.'*9
+        modes[0] = 'B' if @booting
+        modes[1] = 'S' if @startup_sequence_active
+        modes[2] = 'D' if @dark_mode
+        modes[3] = 'Y' if @yellow_flash
+        modes[4] = 'M' if @manual_control
+        modes[5] = 'F' if @fixed_time_control
+        modes[6] = 'R' if @all_red
+        modes[7] = 'I' if @isolated_control
+        modes[8] = 'P' if @police_key != 0
+
         plan = "P#{@plan}"
 
         File.open @live_output, 'w' do |file|
-          file.puts "#{plan.rjust(4)} #{pos.to_s.rjust(4)} #{str}\r"
+          file.puts "#{modes}  #{plan.rjust(2)}  #{@cycle_counter.to_s.rjust(3)}  #{str}\r"
         end
       end
 
@@ -316,7 +338,7 @@ module RSMP
         return unless i>=0 && i<@num_inputs
         @inputs[i] = (arg['value'] ? '1' : '0')
       end
-      
+
       def set_fixed_time_control status
         @fixed_time_control = status
       end

data/lib/rsmp/tlc/traffic_controller_site.rb

@@ -18,6 +18,18 @@ module RSMP
         unless @main
           raise ConfigurationError.new "TLC must have a main component"
         end
+
+      end
+
+      def start
+        super
+        start_tlc_timer
+        @main.initiate_startup_sequence
+      end
+
+      def stop_subtasks
+        stop_tlc_timer
+        super
       end
 
       def build_plans signal_plans
@@ -56,49 +68,45 @@ module RSMP
         end
       end
 
-      def start_action
-        super
-        start_timer
-        @main.initiate_startup_sequence
-      end
-
-      def start_timer
+      def start_tlc_timer
         task_name = "tlc timer"
         log "Starting #{task_name} with interval #{@interval} seconds", level: :debug
 
         @timer = @task.async do |task|
-          task.annotate task_name
-          next_time = Time.now.to_f
-          loop do
-            begin
-              timer(@clock.now)
-            rescue EOFError => e
-              log "Connection closed: #{e}", level: :warning
-            rescue IOError => e
-              log "IOError", level: :warning
-            rescue Errno::ECONNRESET
-              log "Connection reset by peer", level: :warning
-            rescue Errno::EPIPE => e
-              log "Broken pipe", level: :warning
-            rescue StandardError => e
-              notify_error e, level: :internal
-            ensure
-              # adjust sleep duration to avoid drift. so wake up always happens on the
-              # same fractional second.
-              # note that Time.now is not monotonic. If the clock is changed,
-              # either manaully or via NTP, the sleep interval might jump.
-              # an alternative is to use ::Process.clock_gettime(::Process::CLOCK_MONOTONIC),
-              # to get the current time. this ensures a constant interval, but
-              # if the clock is changed, the wake up would then happen on a different
-              # fractional second
-              next_time += @interval
-              duration = next_time - Time.now.to_f
-              task.sleep duration
-            end
+        task.annotate task_name
+          run_tlc_timer task
+        end
+      end
+
+      def run_tlc_timer task
+        next_time = Time.now.to_f
+        loop do
+          begin
+            timer(@clock.now)
+          rescue StandardError => e
+            notify_error e, level: :internal
+          ensure
+            # adjust sleep duration to avoid drift. so wake up always happens on the
+            # same fractional second.
+            # note that Time.now is not monotonic. If the clock is changed,
+            # either manaully or via NTP, the sleep interval might jump.
+            # an alternative is to use ::Process.clock_gettime(::Process::CLOCK_MONOTONIC),
+            # to get the current time. this ensures a constant interval, but
+            # if the clock is changed, the wake up would then happen on a different
+            # fractional second
+            next_time += @interval
+            duration = next_time - Time.now.to_f
+            task.sleep duration
           end
         end
       end
 
+      def stop_tlc_timer
+        return unless @timer
+        @timer.stop
+        @timer = nil
+      end
+
       def timer now
         return unless @main
         @main.timer now
@@ -142,7 +150,6 @@ module RSMP
         when :restart
           log "Restarting TLC", level: :info
           restart
-          initiate_startup_sequence
         end
       end
     end

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.8.6"
+  VERSION = "0.9.0"
 end

data/lib/rsmp.rb

@@ -10,10 +10,10 @@ require 'json_schemer'
 require 'async/queue'
 
 require 'rsmp/rsmp'
+require 'rsmp/task'
 require 'rsmp/deep_merge'
 require 'rsmp/inspect'
 require 'rsmp/logging'
-require 'rsmp/wait'
 require 'rsmp/node'
 require 'rsmp/supervisor'
 require 'rsmp/components'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.9.0
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -186,6 +186,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yaml"
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
@@ -203,6 +204,7 @@ files:
 - documentation/classes_and_modules.md
 - documentation/collecting_message.md
 - documentation/message_distribution.md
+- documentation/tasks.md
 - exe/rsmp
 - lib/rsmp.rb
 - lib/rsmp/archive.rb
@@ -234,18 +236,16 @@ files:
 - lib/rsmp/rsmp.rb
 - lib/rsmp/site.rb
 - lib/rsmp/site_proxy.rb
-- lib/rsmp/site_proxy_wait.rb
 - lib/rsmp/supervisor.rb
 - lib/rsmp/supervisor_proxy.rb
+- lib/rsmp/task.rb
 - lib/rsmp/tlc/detector_logic.rb
 - lib/rsmp/tlc/signal_group.rb
 - lib/rsmp/tlc/signal_plan.rb
 - lib/rsmp/tlc/traffic_controller.rb
 - lib/rsmp/tlc/traffic_controller_site.rb
 - lib/rsmp/version.rb
-- lib/rsmp/wait.rb
 - rsmp.gemspec
-- test.rb
 homepage: https://github.com/rsmp-nordic/rsmp
 licenses:
 - MIT