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, #do_deferred, #ignore_errors, #notify_error, #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_versions ⇒ Object (readonly)

Returns the value of attribute core_versions.



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

def core_versions
  @core_versions
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 



93
94
95
96
97
 
# File 'lib/rsmp/site.rb', line 93

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 



99
100
101
 
# File 'lib/rsmp/site.rb', line 99

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

#alarm_activated_or_deactivated(alarm_state) ⇒ Object 



107
108
109
 
# File 'lib/rsmp/site.rb', line 107

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

#alarm_suspended_or_resumed(alarm_state) ⇒ Object 



103
104
105
 
# File 'lib/rsmp/site.rb', line 103

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

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



154
155
156
157
158
159
160
161
162
 
# File 'lib/rsmp/site.rb', line 154

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 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/rsmp/site.rb', line 78

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_sxl_version ⇒ Object 



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

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 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/rsmp/site.rb', line 117

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 



147
148
149
150
151
152
 
# File 'lib/rsmp/site.rb', line 147

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
 
# 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 }
    ],
    'core_versions' => 'all',
    '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
  setup_components @site_settings['components']
end

#run ⇒ Object 



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

def run
  log "Starting site #{@site_settings["site_id"]}",
      level: :info,
      timestamp: @clock.now
  @proxies.each { |proxy| proxy.start }
  @proxies.each { |proxy| proxy.wait }
end

#send_alarm(alarm) ⇒ Object 



111
112
113
114
115
 
# File 'lib/rsmp/site.rb', line 111

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

#stop ⇒ Object

stop



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

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 



139
140
141
142
143
144
145
 
# File 'lib/rsmp/site.rb', line 139

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