shoesgem 0.1424.0

data/shoes/ruby/lib/rinda/rinda.rb

@@ -0,0 +1,283 @@
+require 'drb/drb'
+require 'thread'
+
+##
+# A module to implement the Linda distributed computing paradigm in Ruby.
+#
+# Rinda is part of DRb (dRuby).
+#
+# == Example(s)
+#
+# See the sample/drb/ directory in the Ruby distribution, from 1.8.2 onwards.
+#
+#--
+# TODO
+# == Introduction to Linda/rinda?
+#
+# == Why is this library separate from DRb?
+
+module Rinda
+
+  ##
+  # Rinda error base class
+
+  class RindaError < RuntimeError; end
+
+  ##
+  # Raised when a hash-based tuple has an invalid key.
+
+  class InvalidHashTupleKey < RindaError; end
+
+  ##
+  # Raised when trying to use a canceled tuple.
+
+  class RequestCanceledError < ThreadError; end
+
+  ##
+  # Raised when trying to use an expired tuple.
+
+  class RequestExpiredError < ThreadError; end
+
+  ##
+  # A tuple is the elementary object in Rinda programming.
+  # Tuples may be matched against templates if the tuple and
+  # the template are the same size.
+
+  class Tuple
+
+    ##
+    # Creates a new Tuple from +ary_or_hash+ which must be an Array or Hash.
+
+    def initialize(ary_or_hash)
+      if hash?(ary_or_hash)
+        init_with_hash(ary_or_hash)
+      else
+        init_with_ary(ary_or_hash)
+      end
+    end
+
+    ##
+    # The number of elements in the tuple.
+    
+    def size
+      @tuple.size
+    end
+
+    ##
+    # Accessor method for elements of the tuple.
+
+    def [](k)
+      @tuple[k]
+    end
+
+    ##
+    # Fetches item +k+ from the tuple.
+
+    def fetch(k)
+      @tuple.fetch(k)
+    end
+
+    ##
+    # Iterate through the tuple, yielding the index or key, and the
+    # value, thus ensuring arrays are iterated similarly to hashes.
+
+    def each # FIXME
+      if Hash === @tuple
+        @tuple.each { |k, v| yield(k, v) }
+      else
+        @tuple.each_with_index { |v, k| yield(k, v) }
+      end
+    end
+
+    ##
+    # Return the tuple itself
+    def value
+      @tuple
+    end
+
+    private
+
+    def hash?(ary_or_hash)
+      ary_or_hash.respond_to?(:keys)
+    end
+
+    ##
+    # Munges +ary+ into a valid Tuple.
+
+    def init_with_ary(ary)
+      @tuple = Array.new(ary.size)
+      @tuple.size.times do |i|
+        @tuple[i] = ary[i]
+      end
+    end
+
+    ##
+    # Ensures +hash+ is a valid Tuple.
+
+    def init_with_hash(hash)
+      @tuple = Hash.new
+      hash.each do |k, v|
+        raise InvalidHashTupleKey unless String === k
+        @tuple[k] = v
+      end
+    end
+
+  end
+
+  ##
+  # Templates are used to match tuples in Rinda.
+
+  class Template < Tuple
+
+    ##
+    # Matches this template against +tuple+.  The +tuple+ must be the same
+    # size as the template.  An element with a +nil+ value in a template acts
+    # as a wildcard, matching any value in the corresponding position in the
+    # tuple.  Elements of the template match the +tuple+ if the are #== or
+    # #===.
+    #
+    #   Template.new([:foo, 5]).match   Tuple.new([:foo, 5]) # => true
+    #   Template.new([:foo, nil]).match Tuple.new([:foo, 5]) # => true
+    #   Template.new([String]).match    Tuple.new(['hello']) # => true
+    #
+    #   Template.new([:foo]).match      Tuple.new([:foo, 5]) # => false
+    #   Template.new([:foo, 6]).match   Tuple.new([:foo, 5]) # => false
+    #   Template.new([:foo, nil]).match Tuple.new([:foo])    # => false
+    #   Template.new([:foo, 6]).match   Tuple.new([:foo])    # => false
+
+    def match(tuple)
+      return false unless tuple.respond_to?(:size)
+      return false unless tuple.respond_to?(:fetch)
+      return false unless self.size == tuple.size
+      each do |k, v|
+        begin
+          it = tuple.fetch(k)
+        rescue
+          return false
+        end
+        next if v.nil?
+        next if v == it
+        next if v === it
+        return false
+      end
+      return true
+    end
+    
+    ##
+    # Alias for #match.
+
+    def ===(tuple)
+      match(tuple)
+    end
+
+  end
+  
+  ##
+  # <i>Documentation?</i>
+
+  class DRbObjectTemplate
+
+    ##
+    # Creates a new DRbObjectTemplate that will match against +uri+ and +ref+.
+
+    def initialize(uri=nil, ref=nil)
+      @drb_uri = uri
+      @drb_ref = ref
+    end
+    
+    ##
+    # This DRbObjectTemplate matches +ro+ if the remote object's drburi and
+    # drbref are the same.  +nil+ is used as a wildcard.
+
+    def ===(ro)
+      return true if super(ro)
+      unless @drb_uri.nil?
+        return false unless (@drb_uri === ro.__drburi rescue false)
+      end
+      unless @drb_ref.nil?
+        return false unless (@drb_ref === ro.__drbref rescue false)
+      end
+      true
+    end
+
+  end
+
+  ##
+  # TupleSpaceProxy allows a remote Tuplespace to appear as local.
+
+  class TupleSpaceProxy
+
+    ##
+    # Creates a new TupleSpaceProxy to wrap +ts+.
+
+    def initialize(ts)
+      @ts = ts
+    end
+    
+    ##
+    # Adds +tuple+ to the proxied TupleSpace.  See TupleSpace#write.
+
+    def write(tuple, sec=nil)
+      @ts.write(tuple, sec)
+    end
+    
+    ##
+    # Takes +tuple+ from the proxied TupleSpace.  See TupleSpace#take.
+
+    def take(tuple, sec=nil, &block)
+      port = []
+      @ts.move(DRbObject.new(port), tuple, sec, &block)
+      port[0]
+    end
+    
+    ##
+    # Reads +tuple+ from the proxied TupleSpace.  See TupleSpace#read.
+
+    def read(tuple, sec=nil, &block)
+      @ts.read(tuple, sec, &block)
+    end
+    
+    ##
+    # Reads all tuples matching +tuple+ from the proxied TupleSpace.  See
+    # TupleSpace#read_all.
+
+    def read_all(tuple)
+      @ts.read_all(tuple)
+    end
+    
+    ##
+    # Registers for notifications of event +ev+ on the proxied TupleSpace.
+    # See TupleSpace#notify
+
+    def notify(ev, tuple, sec=nil)
+      @ts.notify(ev, tuple, sec)
+    end
+
+  end
+
+  ##
+  # An SimpleRenewer allows a TupleSpace to check if a TupleEntry is still
+  # alive.
+
+  class SimpleRenewer
+
+    include DRbUndumped
+
+    ##
+    # Creates a new SimpleRenewer that keeps an object alive for another +sec+
+    # seconds.
+
+    def initialize(sec=180)
+      @sec = sec
+    end
+
+    ##
+    # Called by the TupleSpace to check if the object is still alive.
+
+    def renew
+      @sec
+    end
+  end
+
+end
+

data/shoes/ruby/lib/rinda/ring.rb

@@ -0,0 +1,271 @@
+#
+# Note: Rinda::Ring API is unstable.
+#
+require 'drb/drb'
+require 'rinda/rinda'
+require 'thread'
+
+module Rinda
+
+  ##
+  # The default port Ring discovery will use.
+
+  Ring_PORT = 7647
+
+  ##
+  # A RingServer allows a Rinda::TupleSpace to be located via UDP broadcasts.
+  # Service location uses the following steps:
+  #
+  # 1. A RingServer begins listening on the broadcast UDP address.
+  # 2. A RingFinger sends a UDP packet containing the DRb URI where it will
+  #    listen for a reply.
+  # 3. The RingServer receives the UDP packet and connects back to the
+  #    provided DRb URI with the DRb service.
+
+  class RingServer
+
+    include DRbUndumped
+
+    ##
+    # Advertises +ts+ on the UDP broadcast address at +port+.
+
+    def initialize(ts, port=Ring_PORT)
+      @ts = ts
+      @soc = UDPSocket.open
+      @soc.bind('', port)
+      @w_service = write_service
+      @r_service = reply_service
+    end
+
+    ##
+    # Creates a thread that picks up UDP packets and passes them to do_write
+    # for decoding.
+
+    def write_service
+      Thread.new do
+	loop do
+	  msg = @soc.recv(1024)
+	  do_write(msg)
+	end
+      end
+    end
+  
+    ##
+    # Extracts the response URI from +msg+ and adds it to TupleSpace where it
+    # will be picked up by +reply_service+ for notification.
+
+    def do_write(msg)
+      Thread.new do
+	begin
+	  tuple, sec = Marshal.load(msg)
+	  @ts.write(tuple, sec)
+	rescue
+	end
+      end
+    end
+
+    ##
+    # Creates a thread that notifies waiting clients from the TupleSpace.
+
+    def reply_service
+      Thread.new do
+	loop do
+	  do_reply
+	end
+      end
+    end
+    
+    ##
+    # Pulls lookup tuples out of the TupleSpace and sends their DRb object the
+    # address of the local TupleSpace.
+
+    def do_reply
+      tuple = @ts.take([:lookup_ring, DRbObject])
+      Thread.new { tuple[1].call(@ts) rescue nil}
+    rescue
+    end
+
+  end
+
+  ##
+  # RingFinger is used by RingServer clients to discover the RingServer's
+  # TupleSpace.  Typically, all a client needs to do is call
+  # RingFinger.primary to retrieve the remote TupleSpace, which it can then
+  # begin using.
+
+  class RingFinger
+
+    @@broadcast_list = ['<broadcast>', 'localhost']
+
+    @@finger = nil
+
+    ##
+    # Creates a singleton RingFinger and looks for a RingServer.  Returns the
+    # created RingFinger.
+
+    def self.finger
+      unless @@finger 
+	@@finger = self.new
+	@@finger.lookup_ring_any
+      end
+      @@finger
+    end
+
+    ##
+    # Returns the first advertised TupleSpace.
+
+    def self.primary
+      finger.primary
+    end
+
+    ##
+    # Contains all discovered TupleSpaces except for the primary.
+
+    def self.to_a
+      finger.to_a
+    end
+
+    ##
+    # The list of addresses where RingFinger will send query packets.
+
+    attr_accessor :broadcast_list
+
+    ##
+    # The port that RingFinger will send query packets to.
+
+    attr_accessor :port
+
+    ##
+    # Contain the first advertised TupleSpace after lookup_ring_any is called.
+
+    attr_accessor :primary
+
+    ##
+    # Creates a new RingFinger that will look for RingServers at +port+ on
+    # the addresses in +broadcast_list+.
+
+    def initialize(broadcast_list=@@broadcast_list, port=Ring_PORT)
+      @broadcast_list = broadcast_list || ['localhost']
+      @port = port
+      @primary = nil
+      @rings = []
+    end
+
+    ##
+    # Contains all discovered TupleSpaces except for the primary.
+
+    def to_a
+      @rings
+    end
+
+    ##
+    # Iterates over all discovered TupleSpaces starting with the primary.
+
+    def each
+      lookup_ring_any unless @primary
+      return unless @primary
+      yield(@primary)
+      @rings.each { |x| yield(x) }
+    end
+
+    ##
+    # Looks up RingServers waiting +timeout+ seconds.  RingServers will be
+    # given +block+ as a callback, which will be called with the remote
+    # TupleSpace.
+
+    def lookup_ring(timeout=5, &block)
+      return lookup_ring_any(timeout) unless block_given?
+
+      msg = Marshal.dump([[:lookup_ring, DRbObject.new(block)], timeout])
+      @broadcast_list.each do |it|
+	soc = UDPSocket.open
+	begin
+	  soc.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
+	  soc.send(msg, 0, it, @port)
+	rescue
+	  nil
+	ensure
+	  soc.close
+	end
+      end
+      sleep(timeout)
+    end
+
+    ##
+    # Returns the first found remote TupleSpace.  Any further recovered
+    # TupleSpaces can be found by calling +to_a+.
+
+    def lookup_ring_any(timeout=5)
+      queue = Queue.new
+
+      th = Thread.new do
+	self.lookup_ring(timeout) do |ts|
+	  queue.push(ts)
+	end
+	queue.push(nil)
+	while it = queue.pop
+	  @rings.push(it)
+	end
+      end
+      
+      @primary = queue.pop
+      raise('RingNotFound') if @primary.nil?
+      @primary
+    end
+
+  end
+
+  ##
+  # RingProvider uses a RingServer advertised TupleSpace as a name service.
+  # TupleSpace clients can register themselves with the remote TupleSpace and
+  # look up other provided services via the remote TupleSpace.
+  #
+  # Services are registered with a tuple of the format [:name, klass,
+  # DRbObject, description].
+
+  class RingProvider
+
+    ##
+    # Creates a RingProvider that will provide a +klass+ service running on
+    # +front+, with a +description+.  +renewer+ is optional.
+
+    def initialize(klass, front, desc, renewer = nil)
+      @tuple = [:name, klass, front, desc]
+      @renewer = renewer || Rinda::SimpleRenewer.new
+    end
+
+    ##
+    # Advertises this service on the primary remote TupleSpace.
+
+    def provide
+      ts = Rinda::RingFinger.primary
+      ts.write(@tuple, @renewer)
+    end
+
+  end
+
+end
+
+if __FILE__ == $0
+  DRb.start_service
+  case ARGV.shift
+  when 's'
+    require 'rinda/tuplespace'
+    ts = Rinda::TupleSpace.new
+    place = Rinda::RingServer.new(ts)
+    $stdin.gets
+  when 'w'
+    finger = Rinda::RingFinger.new(nil)
+    finger.lookup_ring do |ts2|
+      p ts2
+      ts2.write([:hello, :world])
+    end
+  when 'r'
+    finger = Rinda::RingFinger.new(nil)
+    finger.lookup_ring do |ts2|
+      p ts2
+      p ts2.take([nil, nil])
+    end
+  end
+end
+