method

synchronize

v2.3.8 - Show latest stable - 0 notes - Class: Module

1.0.0
1.1.6
1.2.6
2.0.3
2.1.0
2.2.1 (0)
2.3.8 (0)
3.0.0 (0)
3.0.9 (-2)
3.1.0 (0)
3.2.1 (0)
3.2.8 (0)
3.2.13 (0)
4.0.2
4.1.8
4.2.1
4.2.7
4.2.9
5.0.0.1
5.1.7
5.2.3
6.0.0
6.1.3.1
6.1.7.7
7.0.0
7.1.3.2
7.1.3.4
What's this?

synchronize(*methods) public

Synchronize access around a method, delegating synchronization to a particular mutex. A mutex (either a Mutex, or any object that responds to #synchronize and yields to a block) must be provided as a final :with option. The :with option should be a symbol or string, and can represent a method, constant, or instance or class variable. Example:

  class SharedCache
    @@lock = Mutex.new
    def expire
      ...
    end
    synchronize :expire, :with => :@@lock
  end

Show source

# File activesupport/lib/active_support/core_ext/module/synchronization.rb, line 15
  def synchronize(*methods)
    options = methods.extract_options!
    unless options.is_a?(Hash) && with = options[:with]
      raise ArgumentError, "Synchronization needs a mutex. Supply an options hash with a :with key as the last argument (e.g. synchronize :hello, :with => :@mutex)."
    end

    methods.each do |method|
      aliased_method, punctuation = method.to_s.sub(/([?!=])$/, ''), $1

      if method_defined?("#{aliased_method}_without_synchronization#{punctuation}")
        raise ArgumentError, "#{method} is already synchronized. Double synchronization is not currently supported."
      end

      module_eval("def \#{aliased_method}_with_synchronization\#{punctuation}(*args, &block)     # def expire_with_synchronization(*args, &block)\n\#{with}.synchronize do                                                    #   @@lock.synchronize do\n\#{aliased_method}_without_synchronization\#{punctuation}(*args, &block)  #     expire_without_synchronization(*args, &block)\nend                                                                       #   end\nend                                                                         # end\n", __FILE__, __LINE__ + 1)

      alias_method_chain method, :synchronization
    end
  end

synchronize

Related methods