Class: MonitorMixin::ConditionVariable (Ruby 2.3.4)

MonitorMixin::ConditionVariable

FIXME: This isn’t documented in Nutshell.

Since MonitorMixin#new_cond returns a ConditionVariable, and the example above calls while_wait and signal, this class should be documented.

Public Class Methods

new(monitor)
 
               # File monitor.rb, line 154
def initialize(monitor)
  @monitor = monitor
  @cond = ::ConditionVariable.new
end
            

Public Instance Methods

broadcast()

Wakes up all threads waiting for this lock.

 
               # File monitor.rb, line 147
def broadcast
  @monitor.__send__(:mon_check_owner)
  @cond.broadcast
end
            
signal()

Wakes up the first thread in line waiting for this lock.

 
               # File monitor.rb, line 139
def signal
  @monitor.__send__(:mon_check_owner)
  @cond.signal
end
            
wait(timeout = nil)

Releases the lock held in the associated monitor and waits; reacquires the lock on wakeup.

If timeout is given, this method returns after timeout seconds passed, even if no other thread doesn’t signal.

 
               # File monitor.rb, line 107
def wait(timeout = nil)
  @monitor.__send__(:mon_check_owner)
  count = @monitor.__send__(:mon_exit_for_cond)
  begin
    @cond.wait(@monitor.instance_variable_get(:@mon_mutex), timeout)
    return true
  ensure
    @monitor.__send__(:mon_enter_for_cond, count)
  end
end
            
wait_until()

Calls wait repeatedly until the given block yields a truthy value.

 
               # File monitor.rb, line 130
def wait_until
  until yield
    wait
  end
end
            
wait_while()

Calls wait repeatedly while the given block yields a truthy value.

 
               # File monitor.rb, line 121
def wait_while
  while yield
    wait
  end
end