Class: RSMP::Site

Inherits:
Node
  • Object
show all
Includes:
Components
Defined in:
lib/rsmp/site.rb

Direct Known Subclasses

TLC::TrafficControllerSite

Instance Attribute Summary collapse

Attributes included from Components

#components, #main

Attributes inherited from Node

#archive, #clock, #collector, #deferred, #error_queue, #task

Attributes included from Task

#task

Attributes included from Logging

#archive

Instance Method Summary collapse

Methods included from Components

#add_component, #check_main_component, #clear_alarm_timestamps, #find_component, #infer_component_type, #initialize_components, #setup_components

Methods inherited from Node

#author, #check_required_settings, #clear_deferred, #defer, #distribute_error, #do_deferred, #ignore_errors, #now, #process_deferred, #stop_subtasks

Methods included from Task

#initialize_task, #restart, #start, #stop_subtasks, #stop_task, #task_status, #wait, #wait_for_condition

Methods included from Inspect

#inspect, #inspector

Methods included from Logging

#author, #initialize_logging, #log

Constructor Details

#initialize(options = {}) ⇒ Site

Returns a new instance of Site.



11
12
13
14
15
16
17
18
19
 
# File 'lib/rsmp/site.rb', line 11

def initialize options={}
  super options
  initialize_components
  handle_site_settings options
  @proxies = []
  @sleep_condition = Async::Notification.new
  @proxies_condition = Async::Notification.new
  build_proxies
end

Instance Attribute Details

#core_version ⇒ Object (readonly)

Returns the value of attribute core_version.



9
10
11
 
# File 'lib/rsmp/site.rb', line 9

def core_version
  @core_version
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



9
10
11
 
# File 'lib/rsmp/site.rb', line 9

def logger
  @logger
end

#proxies ⇒ Object (readonly)

Returns the value of attribute proxies.



9
10
11
 
# File 'lib/rsmp/site.rb', line 9

def proxies
  @proxies
end

#site_settings ⇒ Object (readonly)

Returns the value of attribute site_settings.



9
10
11
 
# File 'lib/rsmp/site.rb', line 9

def site_settings
  @site_settings
end

Instance Method Details

#aggregated_status_changed(component, options = {}) ⇒ Object 



117
118
119
120
121
 
# File 'lib/rsmp/site.rb', line 117

def aggregated_status_changed component, options={}
  @proxies.each do |proxy|
    proxy.send_aggregated_status component, options if proxy.ready?
  end
end

#alarm_acknowledged(alarm_state) ⇒ Object 



123
124
125
 
# File 'lib/rsmp/site.rb', line 123

def alarm_acknowledged alarm_state
  send_alarm AlarmAcknowledged.new( alarm_state.to_hash )
end

#alarm_activated_or_deactivated(alarm_state) ⇒ Object 



131
132
133
 
# File 'lib/rsmp/site.rb', line 131

def alarm_activated_or_deactivated alarm_state
  send_alarm AlarmIssue.new( alarm_state.to_hash )
end

#alarm_suspended_or_resumed(alarm_state) ⇒ Object 



127
128
129
 
# File 'lib/rsmp/site.rb', line 127

def alarm_suspended_or_resumed alarm_state
  send_alarm AlarmSuspended.new( alarm_state.to_hash )
end

#build_component(id:, type:, settings:) ⇒ Object 



178
179
180
181
182
183
184
185
186
 
# File 'lib/rsmp/site.rb', line 178

def build_component id:, type:, settings:
  settings ||= {}
  if type == 'main'
    Component.new id:id, node: self, grouped: true,
      ntsOId: settings['ntsOId'], xNId: settings['xNId']
  else
    Component.new id:id, node: self, grouped: false
  end
end

#build_proxies ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/rsmp/site.rb', line 102

def build_proxies
  @site_settings["supervisors"].each do |supervisor_settings|
    @proxies << SupervisorProxy.new({
      site: self,
      task: @task,
      settings: @site_settings,
      ip: supervisor_settings['ip'],
      port: supervisor_settings['port'],
      logger: @logger,
      archive: @archive,
      collect: @collect
    })
  end
end

#check_core_versions ⇒ Object 



71
72
73
74
75
76
77
78
 
# File 'lib/rsmp/site.rb', line 71

def check_core_versions
version = @site_settings['core_version']
  return unless version
  unless RSMP::Schema::core_versions.include? version
    error_str = "Unknown core version: #{version}"
    raise RSMP::ConfigurationError.new(error_str)
  end
end

#check_sxl_version ⇒ Object 



65
66
67
68
69
 
# File 'lib/rsmp/site.rb', line 65

def check_sxl_version
  sxl = @site_settings['sxl']
  version = @site_settings['sxl_version'].to_s
  RSMP::Schema::find_schema! sxl, version, lenient: true
end

#connect_to_supervisor(task, supervisor_settings) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/rsmp/site.rb', line 141

def connect_to_supervisor task, supervisor_settings
  proxy = build_proxy({
    site: self,
    task: @task,
    settings: @site_settings,
    ip: supervisor_settings['ip'],
    port: supervisor_settings['port'],
    logger: @logger,
    archive: @archive,
    collect: @collect
  })
  @proxies << proxy
  proxy.start
  @proxies_condition.signal
end

#find_supervisor(ip) ⇒ Object 



171
172
173
174
175
176
 
# File 'lib/rsmp/site.rb', line 171

def find_supervisor ip
  @proxies.each do |supervisor|
    return supervisor if ip == :any || supervisor.ip == ip
  end
  nil
end

#handle_site_settings(options = {}) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/rsmp/site.rb', line 29

def handle_site_settings options={}
  defaults = {
    'site_id' => 'RN+SI0001',
    'supervisors' => [
      { 'ip' => '127.0.0.1', 'port' => 12111 }
    ],
    'sxl' => 'tlc',
    'sxl_version' => RSMP::Schema.latest_version(:tlc),
    'intervals' => {
      'timer' => 0.1,
      'watchdog' => 1,
      'reconnect' => 0.1
    },
    'timeouts' => {
      'watchdog' => 2,
      'acknowledgement' => 2
    },
    'send_after_connect' => true,
    'components' => {
      'main' => {
        'C1' => {}
      }
    }
  }
  # only one main component can be defined, so replace the default if options define one
  if options.dig(:site_settings,'components','main')
    defaults['components']['main'] = options[:site_settings]['components']['main']
  end

  @site_settings = defaults.deep_merge options[:site_settings]

  check_sxl_version
  check_core_versions
  setup_components @site_settings['components']
end

#log_site_starting ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/rsmp/site.rb', line 84

def log_site_starting
  log "Starting #{site_type_name} #{@site_settings["site_id"]}", level: :info, timestamp: @clock.now
  sxl = "Using #{@site_settings["sxl"]} sxl #{@site_settings["sxl_version"]}"
  version = @site_settings["core_version"]
  unless version
    core = "accepting all core versions [#{RSMP::Schema.core_versions.join(', ')}]"
  else
    core = "accepting only core version #{version}"
  end
  log "#{sxl}, #{core}", level: :info, timestamp: @clock.now
end

#run ⇒ Object 



96
97
98
99
100
 
# File 'lib/rsmp/site.rb', line 96

def run
  log_site_starting
  @proxies.each { |proxy| proxy.start }
  @proxies.each { |proxy| proxy.wait }
end

#send_alarm(alarm) ⇒ Object 



135
136
137
138
139
 
# File 'lib/rsmp/site.rb', line 135

def send_alarm alarm
  @proxies.each do |proxy|
    proxy.send_message alarm if proxy.ready?
  end
end

#site_id ⇒ Object 



25
26
27
 
# File 'lib/rsmp/site.rb', line 25

def site_id
  @site_settings['site_id']
end

#site_type_name ⇒ Object 



80
81
82
 
# File 'lib/rsmp/site.rb', line 80

def site_type_name
  "site"
end

#stop ⇒ Object

stop



158
159
160
161
 
# File 'lib/rsmp/site.rb', line 158

def stop
  log "Stopping site #{@site_settings["site_id"]}", level: :info
  super
end

#sxl_version ⇒ Object 



21
22
23
 
# File 'lib/rsmp/site.rb', line 21

def sxl_version
  @site_settings['sxl_version']
end

#wait_for_supervisor(ip, timeout) ⇒ Object 



163
164
165
166
167
168
169
 
# File 'lib/rsmp/site.rb', line 163

def wait_for_supervisor ip, timeout
  supervisor = find_supervisor ip
  return supervisor if supervisor
  wait_for_condition(@proxy_condition,timeout:timeout) { find_supervisor ip }
rescue Async::TimeoutError
  raise RSMP::TimeoutError.new "Supervisor '#{ip}' did not connect within #{timeout}s"
end