Class: RSMP::Node

Inherits:
Object
  • Object
show all
Includes:
Inspect, Logging, Task
Defined in:
lib/rsmp/node/node.rb

Overview

Base class for sites and supervisors.

Direct Known Subclasses

Site, Supervisor

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Task

#initialize_task, #restart, #run, #start, #stop, #stop_task, #task_status, #wait, #wait_for_condition

Methods included from Inspect

#inspect, #inspector

Methods included from Logging

#initialize_logging, #log

Constructor Details

#initialize(options = {}) ⇒ Node

Returns a new instance of Node.



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

def initialize(options = {})
  initialize_logging options
  initialize_task
  @deferred = []
  @clock = Clock.new
  @error_queue = Async::Queue.new
  @ignore_errors = []
  @collect = options[:collect]
end

Instance Attribute Details

#archive ⇒ Object (readonly)

Returns the value of attribute archive.



8
9
10
 
# File 'lib/rsmp/node/node.rb', line 8

def archive
  @archive
end

#clock ⇒ Object (readonly)

Returns the value of attribute clock.



8
9
10
 
# File 'lib/rsmp/node/node.rb', line 8

def clock
  @clock
end

#collector ⇒ Object (readonly)

Returns the value of attribute collector.



8
9
10
 
# File 'lib/rsmp/node/node.rb', line 8

def collector
  @collector
end

#deferred ⇒ Object (readonly)

Returns the value of attribute deferred.



8
9
10
 
# File 'lib/rsmp/node/node.rb', line 8

def deferred
  @deferred
end

#error_queue ⇒ Object (readonly)

Returns the value of attribute error_queue.



8
9
10
 
# File 'lib/rsmp/node/node.rb', line 8

def error_queue
  @error_queue
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



8
9
10
 
# File 'lib/rsmp/node/node.rb', line 8

def logger
  @logger
end

#task ⇒ Object (readonly)

Returns the value of attribute task.



8
9
10
 
# File 'lib/rsmp/node/node.rb', line 8

def task
  @task
end

Instance Method Details

#author ⇒ Object 



75
76
77
 
# File 'lib/rsmp/node/node.rb', line 75

def author
  site_id
end

#check_required_settings(settings, required) ⇒ Object

Raises:

  • (ArgumentError) 


67
68
69
70
71
72
73
 
# File 'lib/rsmp/node/node.rb', line 67

def check_required_settings(settings, required)
  raise ArgumentError, 'Settings is empty' unless settings

  required.each do |setting|
    raise ArgumentError, "Missing setting: #{setting}" unless settings.include? setting.to_s
  end
end

#clear_deferred ⇒ Object 



63
64
65
 
# File 'lib/rsmp/node/node.rb', line 63

def clear_deferred
  @deferred.clear
end

#defer(key, item = nil) ⇒ Object 



49
50
51
 
# File 'lib/rsmp/node/node.rb', line 49

def defer(key, item = nil)
  @deferred << [key, item]
end

#distribute_error(error, options = {}) ⇒ Object 



39
40
41
42
43
44
45
46
47
 
# File 'lib/rsmp/node/node.rb', line 39

def distribute_error(error, options = {})
  return if @ignore_errors.find { |klass| error.is_a? klass }

  if options[:level] == :internal
    log ["#{error} in task: #{Async::Task.current}", error.backtrace].flatten.join("\n"),
        level: :error
  end
  @error_queue.enqueue error
end

#do_deferred(key, item = nil) ⇒ Object 



61
 
# File 'lib/rsmp/node/node.rb', line 61

def do_deferred(key, item = nil); end

#ignore_errors(classes) ⇒ Object 



31
32
33
34
35
36
37
 
# File 'lib/rsmp/node/node.rb', line 31

def ignore_errors(classes)
  was = @ignore_errors
  @ignore_errors = [classes].flatten
  yield
ensure
  @ignore_errors = was
end

#now ⇒ Object 



20
21
22
 
# File 'lib/rsmp/node/node.rb', line 20

def now
  clock.now
end

#process_deferred ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/rsmp/node/node.rb', line 53

def process_deferred
  cloned = @deferred.clone # clone in case do_deferred restarts the current task
  @deferred.clear
  cloned.each do |pair|
    do_deferred pair.first, pair.last
  end
end

#stop_subtasks ⇒ Object

stop proxies, then call super



25
26
27
28
29
 
# File 'lib/rsmp/node/node.rb', line 25

def stop_subtasks
  @proxies.each(&:stop)
  @proxies.clear
  super
end