123456789_123456789_123456789_123456789_123456789_

Module: Mutex_m

Relationships & Source Files
Defined in: lib/mutex_m.rb

Overview

mutex_m.rb

When ‘mutex_m’ is required, any object that extends or includes Mutex_m will be treated like a Mutex.

Start by requiring the standard library Mutex_m:

require "mutex_m"

From here you can extend an object with Mutex instance methods:

obj = Object.new
obj.extend Mutex_m

Or mixin Mutex_m into your module to your class inherit Mutex instance methods — remember to call super() in your class initialize method.

class Foo
  include Mutex_m
  def initialize
    # ...
    super()
  end
  # ...
end
obj = Foo.new
# this obj can be handled like Mutex

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Class Method Details

.append_features(cl)

This method is for internal use only.
[ GitHub ] 

  


# File 'lib/mutex_m.rb', line 59



def Mutex_m.append_features(cl) # :nodoc:
  super
  define_aliases(cl) unless cl.instance_of?(Module)
end


  








  

    .define_aliases(cl)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/mutex_m.rb', line 46



def Mutex_m.define_aliases(cl) # :nodoc:
  cl.alias_method(:locked?, :mu_locked?)
  cl.alias_method(:lock, :mu_lock)
  cl.alias_method(:unlock, :mu_unlock)
  cl.alias_method(:try_lock, :mu_try_lock)
  cl.alias_method(:synchronize, :mu_synchronize)
end


  








  

    .extend_object(obj)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/mutex_m.rb', line 64



def Mutex_m.extend_object(obj) # :nodoc:
  super
  obj.mu_extended
end


  








  

    .prepend_features(cl)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/mutex_m.rb', line 54



def Mutex_m.prepend_features(cl) # :nodoc:
  super
  define_aliases(cl) unless cl.instance_of?(Module)
end


  







Instance Attribute Details



  

    #mu_locked?  ⇒ Boolean  (readonly)
  



  

    

See Thread::Mutex#locked?


  





  


  [ GitHub ]


  

  


# File 'lib/mutex_m.rb', line 86



def mu_locked?
  @_mutex.locked?
end


  







Instance Method Details



  

    #initialize(*args)   (private)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/mutex_m.rb', line 116



def initialize(*args) # :nodoc:
  mu_initialize
  super
end


  








  

    #mu_extended  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/mutex_m.rb', line 69



def mu_extended # :nodoc:
  unless (defined? locked? and
          defined? lock and
          defined? unlock and
          defined? try_lock and
          defined? synchronize)
    Mutex_m.define_aliases(singleton_class)
  end
  mu_initialize
end


  








  

    #mu_initialize   (private)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/mutex_m.rb', line 112



def mu_initialize # :nodoc:
  @_mutex = Thread::Mutex.new
end


  








  

    #mu_lock  
  



  

    

See Thread::Mutex#lock


  



  [ GitHub ]


  

  


# File 'lib/mutex_m.rb', line 96



def mu_lock
  @_mutex.lock
end


  








  

    #mu_synchronize(&block)  
  



  

    

See Thread::Mutex#synchronize


  



  [ GitHub ]


  

  


# File 'lib/mutex_m.rb', line 81



def mu_synchronize(&block)
  @_mutex.synchronize(&block)
end


  








  

    #mu_try_lock  
  



  

    

See Thread::Mutex#try_lock


  



  [ GitHub ]


  

  


# File 'lib/mutex_m.rb', line 91



def mu_try_lock
  @_mutex.try_lock
end


  








  

    #mu_unlock  
  



  

    

See Thread::Mutex#unlock


  



  [ GitHub ]


  

  


# File 'lib/mutex_m.rb', line 101



def mu_unlock
  @_mutex.unlock
end


  








  

    #sleep(timeout = nil)  
  



  

    

See Thread::Mutex#sleep


  



  [ GitHub ]


  

  


# File 'lib/mutex_m.rb', line 106



def sleep(timeout = nil)
  @_mutex.sleep(timeout)
end