Extended maintenance of Ruby 1.9.3 ended on February 23, 2015. Read more

In Files

  • monitor.rb

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) click to toggle source 
 
               # File monitor.rb, line 153
def initialize(monitor)
  @monitor = monitor
  @cond = ::ConditionVariable.new
end

Public Instance Methods

broadcast() click to toggle source

Wakes up all threads waiting for this lock.

 
               # File monitor.rb, line 146
def broadcast
  @monitor.__send__(:mon_check_owner)
  @cond.broadcast
end
signal() click to toggle source

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

 
               # File monitor.rb, line 138
def signal
  @monitor.__send__(:mon_check_owner)
  @cond.signal
end
wait(timeout = nil) click to toggle source

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 106
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() click to toggle source

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

 
               # File monitor.rb, line 129
def wait_until
  until yield
    wait
  end
end
wait_while() click to toggle source

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

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

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.