Class: Concurrent::Collection::CopyOnNotifyObserverSet Private
- Inherits:
-
Synchronization::LockableObject
- Object
- Synchronization::LockableObject
- Concurrent::Collection::CopyOnNotifyObserverSet
- Defined in:
- lib/concurrent-ruby/concurrent/collection/copy_on_notify_observer_set.rb
Overview
This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.
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
-
#add_observer(observer = nil, func = :update, &block) ⇒ Object
private
Adds an observer to this set.
-
#count_observers ⇒ Integer
private
Return the number of observers associated with this object.
-
#delete_observer(observer) ⇒ Object
private
Remove ‘observer` as an observer on this object so that it will no longer receive notifications.
-
#delete_observers ⇒ Observable
private
Remove all observers associated with this object.
-
#initialize ⇒ CopyOnNotifyObserverSet
constructor
private
A new instance of CopyOnNotifyObserverSet.
-
#notify_and_delete_observers(*args, &block) ⇒ CopyOnWriteObserverSet
private
Notifies all registered observers with optional args and deletes them.
-
#notify_observers(*args, &block) ⇒ CopyOnWriteObserverSet
private
Notifies all registered observers with optional args.
Constructor Details
#initialize ⇒ CopyOnNotifyObserverSet
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a new instance of CopyOnNotifyObserverSet.
14 15 16 17 |
# File 'lib/concurrent-ruby/concurrent/collection/copy_on_notify_observer_set.rb', line 14 def initialize super() synchronize { ns_initialize } end |
Instance Method Details
#add_observer(observer = nil, func = :update, &block) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
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.
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
# File 'lib/concurrent-ruby/concurrent/collection/copy_on_notify_observer_set.rb', line 20 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 synchronize do @observers[observer] = func observer end end |
#count_observers ⇒ Integer
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Return the number of observers associated with this object.
55 56 57 |
# File 'lib/concurrent-ruby/concurrent/collection/copy_on_notify_observer_set.rb', line 55 def count_observers synchronize { @observers.count } end |
#delete_observer(observer) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Remove ‘observer` as an observer on this object so that it will no longer receive notifications.
39 40 41 42 43 44 |
# File 'lib/concurrent-ruby/concurrent/collection/copy_on_notify_observer_set.rb', line 39 def delete_observer(observer) synchronize do @observers.delete(observer) observer end end |
#delete_observers ⇒ Observable
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Remove all observers associated with this object.
47 48 49 50 51 52 |
# File 'lib/concurrent-ruby/concurrent/collection/copy_on_notify_observer_set.rb', line 47 def delete_observers synchronize do @observers.clear self end end |
#notify_and_delete_observers(*args, &block) ⇒ CopyOnWriteObserverSet
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Notifies all registered observers with optional args and deletes them.
72 73 74 75 76 |
# File 'lib/concurrent-ruby/concurrent/collection/copy_on_notify_observer_set.rb', line 72 def notify_and_delete_observers(*args, &block) observers = duplicate_and_clear_observers notify_to(observers, *args, &block) self end |
#notify_observers(*args, &block) ⇒ CopyOnWriteObserverSet
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Notifies all registered observers with optional args
62 63 64 65 66 |
# File 'lib/concurrent-ruby/concurrent/collection/copy_on_notify_observer_set.rb', line 62 def notify_observers(*args, &block) observers = duplicate_observers notify_to(observers, *args, &block) self end |