Docs4dev
Docs
ruby / 2.6 / monitormixin.html

module MonitorMixin

In concurrent programming, a monitor is an object or module intended to be used safely by more than one thread. The defining characteristic of a monitor is that its methods are executed with mutual exclusion. That is, at each point in time, at most one thread may be executing any of its methods. This mutual exclusion greatly simplifies reasoning about the implementation of monitors compared to reasoning about parallel code that updates a data structure.

You can read more about the general principles on the Wikipedia page for Monitors

Examples

Simple object.extend

require 'monitor.rb'

buf = []
buf.extend(MonitorMixin)
empty_cond = buf.new_cond

# consumer
Thread.start do
  loop do
    buf.synchronize do
      empty_cond.wait_while { buf.empty? }
      print buf.shift
    end
  end
end

# producer
while line = ARGF.gets
  buf.synchronize do
    buf.push(line)
    empty_cond.signal
  end
end

The consumer thread waits for the producer thread to push a line to buf while buf.empty?. The producer thread (main thread) reads a line from ARGF and pushes it into buf then calls empty_cond.signal to notify the consumer thread of new data.

Simple Class include

require 'monitor'

class SynchronizedArray < Array

  include MonitorMixin

  def initialize(*args)
    super(*args)
  end

  alias :old_shift :shift
  alias :old_unshift :unshift

  def shift(n=1)
    self.synchronize do
      self.old_shift(n)
    end
  end

  def unshift(item)
    self.synchronize do
      self.old_unshift(item)
    end
  end

  # other methods ...
end

SynchronizedArray implements an Array with synchronized access to items. This Class is implemented as subclass of Array which includes the MonitorMixin module.

Public Class Methods

extend_object(obj) Show source 
# File lib/monitor.rb, line 162
def self.extend_object(obj)
  super(obj)
  obj.__send__(:mon_initialize)
end
Calls superclass method
new(*args) Show source 
# File lib/monitor.rb, line 250
def initialize(*args)
  super
  mon_initialize
end

Use extend MonitorMixin or include MonitorMixin instead of this constructor. Have look at the examples above to understand how to use this module.

Calls superclass method

Public Instance Methods

mon_enter() Show source 
# File lib/monitor.rb, line 187
def mon_enter
  if @mon_owner != Thread.current
    @mon_mutex.lock
    @mon_owner = Thread.current
    @mon_count = 0
  end
  @mon_count += 1
end

Enters exclusive section.

mon_exit() Show source 
# File lib/monitor.rb, line 199
def mon_exit
  mon_check_owner
  @mon_count -=1
  if @mon_count == 0
    @mon_owner = nil
    @mon_mutex.unlock
  end
end

Leaves exclusive section.

mon_locked?() Show source 
# File lib/monitor.rb, line 211
def mon_locked?
  @mon_mutex.locked?
end

Returns true if this monitor is locked by any thread

mon_owned?() Show source 
# File lib/monitor.rb, line 218
def mon_owned?
  @mon_mutex.locked? && @mon_owner == Thread.current
end

Returns true if this monitor is locked by current thread.

mon_synchronize() { || ... } Show source 
# File lib/monitor.rb, line 227
def mon_synchronize
  mon_enter
  begin
    yield
  ensure
    mon_exit
  end
end

Enters exclusive section and executes the block. Leaves the exclusive section automatically when the block exits. See example under MonitorMixin.

Also aliased as: synchronize
mon_try_enter() Show source 
# File lib/monitor.rb, line 170
def mon_try_enter
  if @mon_owner != Thread.current
    unless @mon_mutex.try_lock
      return false
    end
    @mon_owner = Thread.current
    @mon_count = 0
  end
  @mon_count += 1
  return true
end

Attempts to enter exclusive section. Returns false if lock fails.

Also aliased as: try_mon_enter
new_cond() Show source 
# File lib/monitor.rb, line 241
def new_cond
  return ConditionVariable.new(self)
end

Creates a new MonitorMixin::ConditionVariable associated with the receiver.

synchronize()
Alias for: mon_synchronize
try_mon_enter()

For backward compatibility

Alias for: mon_try_enter

Private Instance Methods

mon_check_owner() Show source 
# File lib/monitor.rb, line 267
def mon_check_owner
  if @mon_owner != Thread.current
    raise ThreadError, "current thread not owner"
  end
end
mon_enter_for_cond(count) Show source 
# File lib/monitor.rb, line 273
def mon_enter_for_cond(count)
  @mon_owner = Thread.current
  @mon_count = count
end
mon_exit_for_cond() Show source 
# File lib/monitor.rb, line 278
def mon_exit_for_cond
  count = @mon_count
  @mon_owner = nil
  @mon_count = 0
  return count
end
mon_initialize() Show source 
# File lib/monitor.rb, line 257
def mon_initialize
  if defined?(@mon_mutex) && @mon_mutex_owner_object_id == object_id
    raise ThreadError, "already initialized"
  end
  @mon_mutex = Thread::Mutex.new
  @mon_mutex_owner_object_id = object_id
  @mon_owner = nil
  @mon_count = 0
end

Initializes the MonitorMixin after being included in a class or when an object has been extended with the MonitorMixin

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.