Gecko [ beacons-mine.com ]

Name	Size	Permission	Date
bigdecimal	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
cgi	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
date	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
digest	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
dl	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
drb	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
io	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
irb	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
net	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
openssl	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
optparse	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
racc	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
rdoc	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
rexml	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
rinda	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
rss	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
runit	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
shell	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
soap	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
test	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
uri	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
webrick	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
wsdl	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
x86_64-linux	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
xmlrpc	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
xsd	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
yaml	[ DIR ]	drwxr-xr-x	2026-02-18 15:11
English.rb	5.6 KB	-rw-r--r--	2007-02-13 04:31
Env.rb	274 B	-rw-r--r--	2007-02-13 04:31
abbrev.rb	2.5 KB	-rw-r--r--	2007-02-13 04:31
base64.rb	3.37 KB	-rw-r--r--	2007-07-16 21:17
benchmark.rb	17.73 KB	-rw-r--r--	2008-02-10 20:54
cgi-lib.rb	6.89 KB	-rw-r--r--	2007-02-13 04:31
cgi.rb	73.74 KB	-rw-r--r--	2009-12-14 08:10
complex.rb	12.84 KB	-rw-r--r--	2009-08-03 11:29
csv.rb	24.46 KB	-rw-r--r--	2007-02-13 04:31
date.rb	53.02 KB	-rw-r--r--	2010-06-08 10:15
date2.rb	128 B	-rw-r--r--	2007-02-13 04:31
debug.rb	20.61 KB	-rw-r--r--	2007-02-13 04:31
delegate.rb	8.81 KB	-rw-r--r--	2009-07-16 06:05
digest.rb	1.12 KB	-rw-r--r--	2007-07-28 06:10
drb.rb	19 B	-rw-r--r--	2007-02-13 04:31
e2mmap.rb	4.04 KB	-rw-r--r--	2007-02-13 04:31
erb.rb	21.38 KB	-rw-r--r--	2009-02-23 23:14
eregex.rb	487 B	-rw-r--r--	2007-02-13 04:31
expect.rb	633 B	-rw-r--r--	2008-02-18 06:47
fileutils.rb	42.23 KB	-rw-r--r--	2011-05-21 03:59
finalize.rb	5.38 KB	-rw-r--r--	2007-02-13 04:31
find.rb	1.84 KB	-rw-r--r--	2007-02-13 04:31
forwardable.rb	6.16 KB	-rw-r--r--	2008-06-06 13:35
ftools.rb	6.17 KB	-rw-r--r--	2007-02-13 04:31
generator.rb	8.1 KB	-rw-r--r--	2008-04-10 16:22
getoptlong.rb	14.88 KB	-rw-r--r--	2007-02-13 04:31
getopts.rb	2.25 KB	-rw-r--r--	2007-02-13 04:31
gserver.rb	6.43 KB	-rw-r--r--	2007-02-13 04:31
importenv.rb	590 B	-rw-r--r--	2007-02-13 04:31
ipaddr.rb	21.96 KB	-rw-r--r--	2008-07-12 20:38
irb.rb	7.43 KB	-rw-r--r--	2009-08-09 14:14
jcode.rb	4.3 KB	-rw-r--r--	2007-02-13 04:31
kconv.rb	8.12 KB	-rw-r--r--	2007-02-13 04:31
logger.rb	17.59 KB	-rw-r--r--	2011-05-30 07:38
mailread.rb	1.28 KB	-rw-r--r--	2007-02-13 04:31
mathn.rb	5.42 KB	-rw-r--r--	2007-02-13 04:31
matrix.rb	27.21 KB	-rw-r--r--	2009-01-24 20:32
md5.rb	411 B	-rw-r--r--	2007-03-06 15:39
mkmf.rb	50.65 KB	-rw-r--r--	2010-12-04 12:04
monitor.rb	7.93 KB	-rw-r--r--	2009-11-25 13:15
mutex_m.rb	2.07 KB	-rw-r--r--	2007-02-13 04:31
observer.rb	5.15 KB	-rw-r--r--	2007-02-13 04:31
open-uri.rb	20.49 KB	-rw-r--r--	2007-10-08 16:46
open3.rb	2.1 KB	-rw-r--r--	2009-12-14 09:58
openssl.rb	575 B	-rw-r--r--	2010-11-22 12:51
optparse.rb	47.12 KB	-rw-r--r--	2009-02-20 17:13
ostruct.rb	3.35 KB	-rw-r--r--	2009-05-26 17:36
parsearg.rb	1.55 KB	-rw-r--r--	2007-02-13 04:31
parsedate.rb	1.33 KB	-rw-r--r--	2007-02-13 04:31
pathname.rb	29.39 KB	-rw-r--r--	2010-11-23 13:51
ping.rb	1.48 KB	-rw-r--r--	2007-02-13 04:31
pp.rb	15.97 KB	-rw-r--r--	2007-06-07 15:36
prettyprint.rb	18.33 KB	-rw-r--r--	2007-02-17 01:23
profile.rb	90 B	-rw-r--r--	2007-02-13 04:31
profiler.rb	1.59 KB	-rw-r--r--	2007-02-13 04:31
pstore.rb	11.15 KB	-rw-r--r--	2008-06-06 13:35
rational.rb	12.05 KB	-rw-r--r--	2010-06-08 10:32
readbytes.rb	835 B	-rw-r--r--	2007-02-13 04:31
resolv-replace.rb	1.55 KB	-rw-r--r--	2008-08-08 07:28
resolv.rb	56.83 KB	-rw-r--r--	2010-12-23 08:52
rss.rb	504 B	-rw-r--r--	2007-10-21 17:49
rubyunit.rb	180 B	-rw-r--r--	2007-02-13 04:31
scanf.rb	20.63 KB	-rw-r--r--	2009-01-20 08:53
securerandom.rb	4.27 KB	-rw-r--r--	2011-12-10 17:47
set.rb	27.08 KB	-rw-r--r--	2008-06-09 14:50
sha1.rb	418 B	-rw-r--r--	2007-03-06 15:39
shell.rb	4.66 KB	-rw-r--r--	2007-02-13 04:31
shellwords.rb	3.99 KB	-rw-r--r--	2008-03-21 17:46
singleton.rb	8.08 KB	-rw-r--r--	2008-07-03 16:44
sync.rb	6.09 KB	-rw-r--r--	2009-02-19 22:11
tempfile.rb	4.86 KB	-rw-r--r--	2008-04-21 15:13
thread.rb	104 B	-rw-r--r--	2007-02-14 01:09
thwait.rb	4.32 KB	-rw-r--r--	2010-06-08 12:38
time.rb	31.58 KB	-rw-r--r--	2008-06-06 13:35
timeout.rb	3 KB	-rw-r--r--	2010-06-08 11:54
tmpdir.rb	3.69 KB	-rw-r--r--	2009-01-26 07:42
tracer.rb	2.73 KB	-rw-r--r--	2007-02-13 04:31
tsort.rb	7.99 KB	-rw-r--r--	2007-02-13 04:31
un.rb	4.54 KB	-rw-r--r--	2007-02-13 04:31
uri.rb	710 B	-rw-r--r--	2008-04-15 15:11
weakref.rb	2.68 KB	-rw-r--r--	2007-02-13 04:31
webrick.rb	811 B	-rw-r--r--	2007-02-13 04:31
yaml.rb	12.36 KB	-rw-r--r--	2008-04-19 17:15

Rename

=begin

= monitor.rb

This library is distributed under the terms of the Ruby license.
You can freely distribute/modify this library.

== example

This is a simple example.

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?, and the producer thread (main thread)
reads a line from ARGF and push it to buf, then call
empty_cond.signal.

=end

#
# Adds monitor functionality to an arbitrary object by mixing the module with
# +include+.  For example:
#
#    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?, and the producer thread (main thread)
# reads a line from ARGF and push it to buf, then call
# empty_cond.signal.
#
module MonitorMixin
  #
  # 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 ConditionVariable
    class Timeout < Exception; end
    
    # Create a new timer with the argument timeout, and add the
    # current thread to the list of waiters.  Then the thread is
    # stopped.  It will be resumed when a corresponding #signal 
    # occurs.
    def wait(timeout = nil)
      @monitor.instance_eval {mon_check_owner()}
      timer = create_timer(timeout)
      
      Thread.critical = true
      count = @monitor.instance_eval {mon_exit_for_cond()}
      @waiters.push(Thread.current)

begin
	Thread.stop
        return true
      rescue Timeout
        return false
      ensure
	Thread.critical = true
	begin
	  if timer && timer.alive?
	    Thread.kill(timer)
	  end
	  if @waiters.include?(Thread.current)  # interrupted?
	    @waiters.delete(Thread.current)
	  end
	  @monitor.instance_eval {mon_enter_for_cond(count)}
	ensure
	  Thread.critical = false
	end
      end
    end

# call #wait while the supplied block returns +true+.
    def wait_while
      while yield
	wait
      end
    end
    
    # call #wait until the supplied block returns +true+.
    def wait_until
      until yield
	wait
      end
    end
    
    # Wake up and run the next waiter
    def signal
      @monitor.instance_eval {mon_check_owner()}
      Thread.critical = true
      t = @waiters.shift
      t.wakeup if t
      Thread.critical = false
      Thread.pass
    end
    
    # Wake up all the waiters.
    def broadcast
      @monitor.instance_eval {mon_check_owner()}
      Thread.critical = true
      for t in @waiters
	t.wakeup
      end
      @waiters.clear
      Thread.critical = false
      Thread.pass
    end
    
    def count_waiters
      return @waiters.length
    end
    
    private

def initialize(monitor)
      @monitor = monitor
      @waiters = []
    end

def create_timer(timeout)
      if timeout
	waiter = Thread.current
	return Thread.start {
	  Thread.pass
	  sleep(timeout)
	  Thread.critical = true
	  waiter.raise(Timeout.new)
	}
      else
        return nil
      end
    end
  end
  
  def self.extend_object(obj)
    super(obj)
    obj.instance_eval {mon_initialize()}
  end
  
  #
  # Attempts to enter exclusive section.  Returns +false+ if lock fails.
  #
  def mon_try_enter
    result = false
    Thread.critical = true
    if @mon_owner.nil?
      @mon_owner = Thread.current
    end
    if @mon_owner == Thread.current
      @mon_count += 1
      result = true
    end
    Thread.critical = false
    return result
  end
  # For backward compatibility
  alias try_mon_enter mon_try_enter

#
  # Enters exclusive section.
  #
  def mon_enter
    Thread.critical = true
    mon_acquire(@mon_entering_queue)
    @mon_count += 1
  ensure
    Thread.critical = false
  end
  
  #
  # Leaves exclusive section.
  #
  def mon_exit
    mon_check_owner
    Thread.critical = true
    @mon_count -= 1
    if @mon_count == 0
      mon_release
    end
    Thread.critical = false
    Thread.pass
  end

#
  # Enters exclusive section and executes the block.  Leaves the exclusive
  # section automatically when the block exits.  See example under
  # +MonitorMixin+.
  #
  def mon_synchronize
    mon_enter
    begin
      yield
    ensure
      mon_exit
    end
  end
  alias synchronize mon_synchronize
  
  #
  # FIXME: This isn't documented in Nutshell.
  # 
  # Create a new condition variable for this monitor.
  # This facilitates control of the monitor with #signal and #wait.
  #
  def new_cond
    return ConditionVariable.new(self)
  end

private

def initialize(*args)
    super
    mon_initialize
  end

# called by initialize method to set defaults for instance variables.
  def mon_initialize
    @mon_owner = nil
    @mon_count = 0
    @mon_entering_queue = []
    @mon_waiting_queue = []
  end

# Throw a ThreadError exception if the current thread
  # does't own the monitor
  def mon_check_owner
    if @mon_owner != Thread.current
      raise ThreadError, "current thread not owner"
    end
  end

def mon_acquire(queue)
    while @mon_owner && @mon_owner != Thread.current
      queue.push(Thread.current)
      Thread.stop
      Thread.critical = true
    end
    @mon_owner = Thread.current
  end

# mon_release requires Thread.critical == true
  def mon_release
    @mon_owner = nil
    while t = @mon_waiting_queue.shift || @mon_entering_queue.shift
      if t.alive?
        t.wakeup
        return
      end
    end
  end

def mon_enter_for_cond(count)
    mon_acquire(@mon_waiting_queue)
    @mon_count = count
  end

def mon_exit_for_cond
    count = @mon_count
    @mon_count = 0
    return count
  ensure
    mon_release
  end
end

# Monitors provide means of mutual exclusion for Thread programming.
# A critical region is created by means of the synchronize method,
# which takes a block.
# The condition variables (created with #new_cond) may be used 
# to control the execution of a monitor with #signal and #wait.
#
# the Monitor class wraps MonitorMixin, and provides aliases
#  alias try_enter try_mon_enter
#  alias enter mon_enter
#  alias exit mon_exit
# to access its methods more concisely.
class Monitor
  include MonitorMixin
  alias try_enter try_mon_enter
  alias enter mon_enter
  alias exit mon_exit
end

# Documentation comments:
#  - All documentation comes from Nutshell.
#  - MonitorMixin.new_cond appears in the example, but is not documented in
#    Nutshell.
#  - All the internals (internal modules Accessible and Initializable, class
#    ConditionVariable) appear in RDoc.  It might be good to hide them, by
#    making them private, or marking them :nodoc:, etc.
#  - The entire example from the RD section at the top is replicated in the RDoc
#    comment for MonitorMixin.  Does the RD section need to remain?
#  - RDoc doesn't recognise aliases, so we have mon_synchronize documented, but
#    not synchronize.
#  - mon_owner is in Nutshell, but appears as an accessor in a separate module
#    here, so is hard/impossible to RDoc.  Some other useful accessors
#    (mon_count and some queue stuff) are also in this module, and don't appear
#    directly in the RDoc output.
#  - in short, it may be worth changing the code layout in this file to make the
#    documentation easier

# Local variables:
# mode: Ruby
# tab-width: 8
# End: