class Concurrent::Synchronization::AbstractLockableObject

@!visibility private

Protected Instance Methods

ns_broadcast() click to toggle source

@!macro synchronization_object_method_ns_broadcast

Broadcast to all waiting threads.
@return [self]
@note only to be used inside synchronized block
@note to provide direct access to this method in a descendant add method
  ```
  def broadcast
    synchronize { ns_broadcast }
  end
  ```
# File lib/concurrent-ruby/concurrent/synchronization/abstract_lockable_object.rb, line 92
def ns_broadcast
  raise NotImplementedError
end
ns_signal() click to toggle source

@!macro synchronization_object_method_ns_signal

Signal one waiting thread.
@return [self]
@note only to be used inside synchronized block
@note to provide direct access to this method in a descendant add method
  ```
  def signal
    synchronize { ns_signal }
  end
  ```
# File lib/concurrent-ruby/concurrent/synchronization/abstract_lockable_object.rb, line 77
def ns_signal
  raise NotImplementedError
end
ns_wait(timeout = nil) click to toggle source

@!macro synchronization_object_method_ns_wait

Wait until another thread calls #signal or #broadcast,
spurious wake-ups can happen.

@param [Numeric, nil] timeout in seconds, `nil` means no timeout
@return [self]
@note only to be used inside synchronized block
@note to provide direct access to this method in a descendant add method
  ```
  def wait(timeout = nil)
    synchronize { ns_wait(timeout) }
  end
  ```
# File lib/concurrent-ruby/concurrent/synchronization/abstract_lockable_object.rb, line 62
def ns_wait(timeout = nil)
  raise NotImplementedError
end
ns_wait_until(timeout = nil, &condition) click to toggle source

@!macro synchronization_object_method_ns_wait_until

Wait until condition is met or timeout passes,
protects against spurious wake-ups.
@param [Numeric, nil] timeout in seconds, `nil` means no timeout
@yield condition to be met
@yieldreturn [true, false]
@return [true, false] if condition met
@note only to be used inside synchronized block
@note to provide direct access to this method in a descendant add method
  ```
  def wait_until(timeout = nil, &condition)
    synchronize { ns_wait_until(timeout, &condition) }
  end
  ```
# File lib/concurrent-ruby/concurrent/synchronization/abstract_lockable_object.rb, line 33
def ns_wait_until(timeout = nil, &condition)
  if timeout
    wait_until = Concurrent.monotonic_time + timeout
    loop do
      now              = Concurrent.monotonic_time
      condition_result = condition.call
      return condition_result if now >= wait_until || condition_result
      ns_wait wait_until - now
    end
  else
    ns_wait timeout until condition.call
    true
  end
end
synchronize() click to toggle source

@!macro synchronization_object_method_synchronize

@yield runs the block synchronized against this object,
  equivalent of java's `synchronize(this) {}`
@note can by made public in descendants if required by `public :synchronize`
# File lib/concurrent-ruby/concurrent/synchronization/abstract_lockable_object.rb, line 14
def synchronize
  raise NotImplementedError
end