Class: Garcon::CopyOnNotifyObserverSet

Inherits:
Object
  • Object
show all
Defined in:
lib/garcon/task/copy_on_notify_observer_set.rb

Overview

A thread safe observer set implemented using copy-on-read approach: observers are added and removed from a thread safe collection; every time a notification is required the internal data structure is copied to prevent concurrency issues

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CopyOnNotifyObserverSet 



28
29
30
31
 
# File 'lib/garcon/task/copy_on_notify_observer_set.rb', line 28

def initialize
  @mutex = Mutex.new
  @observers = {}
end

Instance Method Details

#add_observer(observer = nil, func = :update, &block) ⇒ Object

Adds an observer to this set. If a block is passed, the observer will be created by this method and no other params should be passed



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/garcon/task/copy_on_notify_observer_set.rb', line 45

def add_observer(observer = nil, func = :update, &block)
  if observer.nil? && block.nil?
    raise ArgumentError, 'should pass observer as a first argument or block'
  elsif observer && block
    raise ArgumentError.new('cannot provide both an observer and a block')
  end

  if block
    observer = block
    func = :call
  end

  begin
    @mutex.lock
    @observers[observer] = func
  ensure
    @mutex.unlock
  end

  observer
end

#count_observers ⇒ Integer 



91
92
93
94
95
96
97
 
# File 'lib/garcon/task/copy_on_notify_observer_set.rb', line 91

def count_observers
  @mutex.lock
  result = @observers.count
  @mutex.unlock

  result
end

#delete_observer(observer) ⇒ Object 



71
72
73
74
75
76
77
 
# File 'lib/garcon/task/copy_on_notify_observer_set.rb', line 71

def delete_observer(observer)
  @mutex.lock
  @observers.delete(observer)
  @mutex.unlock

  observer
end

#delete_observers ⇒ CopyOnWriteObserverSet

Deletes all observers



81
82
83
84
85
86
87
 
# File 'lib/garcon/task/copy_on_notify_observer_set.rb', line 81

def delete_observers
  @mutex.lock
  @observers.clear
  @mutex.unlock

  self
end

#notify_and_delete_observers(*args, &block) ⇒ CopyOnWriteObserverSet

Notifies all registered observers with optional args and deletes them.



118
119
120
121
122
123
 
# File 'lib/garcon/task/copy_on_notify_observer_set.rb', line 118

def notify_and_delete_observers(*args, &block)
  observers = duplicate_and_clear_observers
  notify_to(observers, *args, &block)

  self
end

#notify_observers(*args, &block) ⇒ CopyOnWriteObserverSet

Notifies all registered observers with optional args



105
106
107
108
109
110
 
# File 'lib/garcon/task/copy_on_notify_observer_set.rb', line 105

def notify_observers(*args, &block)
  observers = duplicate_observers
  notify_to(observers, *args, &block)

  self
end