Class: MonitorMixin::ConditionVariable

Overview

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.

#broadcast

Wakes up all threads waiting for this lock.
#signal

Wakes up the first thread in line waiting for this lock.
#wait(timeout = nil)

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

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

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

[ GitHub ]

# File 'ext/monitor/lib/monitor.rb', line 146


def initialize(monitor)
  @monitor = monitor
  @cond = Thread::ConditionVariable.new
end

Wakes up all threads waiting for this lock.

[ GitHub ]

# File 'ext/monitor/lib/monitor.rb', line 139


def broadcast
  @monitor.mon_check_owner
  @cond.broadcast
end

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

[ GitHub ]

# File 'ext/monitor/lib/monitor.rb', line 131


def signal
  @monitor.mon_check_owner
  @cond.signal
end

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.

[ GitHub ]

# File 'ext/monitor/lib/monitor.rb', line 105


def wait(timeout = nil)
  @monitor.mon_check_owner
  @monitor.wait_for_cond(@cond, timeout)
end

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

[ GitHub ]

# File 'ext/monitor/lib/monitor.rb', line 122


def wait_until
  until yield
    wait
  end
end

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

[ GitHub ]

# File 'ext/monitor/lib/monitor.rb', line 113


def wait_while
  while yield
    wait
  end
end