123456789_123456789_123456789_123456789_123456789_

Class: MonitorMixin::ConditionVariable

Relationships & Source Files
Namespace Children
Exceptions:
Timeout
Inherits: Object
Defined in: lib/monitor.rb

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.

Class Method Summary

Instance Method Summary

  • #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.

Constructor Details

.new(monitor) ⇒ ConditionVariable (private)

[ GitHub ] 

  


# File 'lib/monitor.rb', line 153



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


  







Instance Method Details



  

    #broadcast  
  



  

    

Wakes up all threads waiting for this lock.


  



  [ GitHub ]


  

  


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



def broadcast
  @monitor.__send__(:mon_check_owner)
  @cond.broadcast
end


  








  

    #signal  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/monitor.rb', line 138



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.


  



  [ GitHub ]


  

  


# File 'lib/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  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/monitor.rb', line 129



def wait_until
  until yield
    wait
  end
end


  








  

    #wait_while  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/monitor.rb', line 120



def wait_while
  while yield
    wait
  end
end