dcell 0.10.0 → 0.12.0.pre

data/CHANGES.md

@@ -1,3 +1,7 @@
+HEAD
+----
+* Switch default port to 7890 (7777 is heavily used by other programs)
+
 0.10.0
 ------
 * DCell::Explorer provides a web UI with Reel

data/Gemfile

@@ -3,7 +3,7 @@ source "http://rubygems.org"
 gem 'celluloid',     :git => 'git://github.com/celluloid/celluloid'
 gem 'celluloid-io',  :git => 'git://github.com/celluloid/celluloid-io'
 gem 'celluloid-zmq', :git => 'git://github.com/celluloid/celluloid-zmq'
-#gem 'reel',          :git => 'git://github.com/celluloid/reel'
+gem 'reel',          :git => 'git://github.com/celluloid/reel'
 
 gem 'jruby-openssl', :platform => :jruby
 

data/README.md

@@ -1,6 +1,6 @@
 ![DCell](https://github.com/celluloid/dcell/raw/master/logo.png)
 =====
-[![Build Status](http://travis-ci.org/celluloid/dcell.png)](http://travis-ci.org/celluloid/dcell)
+[![Build Status](https://secure.travis-ci.org/celluloid/dcell.png?branch=master)](http://travis-ci.org/celluloid/dcell)
 [![Dependency Status](https://gemnasium.com/celluloid/dcell.png)](https://gemnasium.com/celluloid/dcell)
 
 > "Objects can message objects transparently that live on other machines
@@ -41,14 +41,86 @@ Like DCell? [Join the Celluloid Google Group][googlegroup]
 [ffi-rzmq]: https://github.com/chuckremes/ffi-rzmq
 [googlegroup]: http://groups.google.com/group/celluloid-ruby
 
-### Is It Good?
+### Is it any good?
 
-Yes.
+[Yes.](http://news.ycombinator.com/item?id=3067434)
 
 ### Is It "Production Ready™"?
 
 Not entirely, but eager early adopters are welcome!
 
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'dcell'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dcell
+
+Inside of your Ruby program do:
+
+    require 'dcell'
+
+...to pull it in as a dependency.
+
+Example
+-------
+
+Create a ruby script with the following contents:
+
+    # node1.rb
+
+    require 'dcell'
+
+    class Duck
+      include Celluloid
+
+      def quack
+        puts "Quack!"
+      end
+    end
+
+    Duck.supervise_as :duck_actor
+
+    DCell.start :id => "node1", :addr => "tcp://127.0.0.1:4000"
+
+    sleep
+
+Now save and run the script via the command line and open a new shell. In there, create another ruby script:
+
+    # node2.rb
+
+    require 'dcell'
+
+    DCell.start :id => "node2", :addr => "tcp://127.0.0.1:4001", :directory => {:id => "node1", :addr => "tcp://127.0.0.1:4000"}
+
+    loop {
+      node = DCell::Node["node1"]
+      duck = node[:duck_actor]
+      duck.quack
+      sleep 3
+    }
+
+When you run the second script in the second shell, you will see the following output in your first shell:
+
+    $ ruby node1.rb
+    I, [2012-08-30T20:00:00.759342 #26124]  INFO -- : Connected to node1
+    I, [2012-08-30T20:00:04.454006 #26124]  INFO -- : Connected to node2
+    Quack!
+    Quack!
+    Quack!
+
+The loop in the second script looks up the node we registered in the first script, takes the registered Duck actor and calls the `quack` method every three seconds.
+
+This is a basic example how individual DCell::Nodes have registered Celluloid actors which can be accessed remotely by other DCell::Nodes.
+
 Supported Platforms
 -------------------
 
@@ -60,7 +132,16 @@ box on MRI/YARV, and requires the following flags elsewhere:
 * JRuby: --1.9 command line option, or JRUBY_OPTS=--1.9 environment variable
 * rbx: -X19 command line option
 
+Contributing to DCell
+-------------------------
+
+* Fork this repository on github
+* Make your changes and send me a pull request
+* If I like them I'll merge them
+* If I've accepted a patch, feel free to ask for commit access
+
 Copyright
 ---------
 
-Copyright (c) 2012 Tony Arcieri. See LICENSE.txt for further details.
+Copyright (c) 2012 Tony Arcieri. Distributed under the MIT License.
+See LICENSE.txt for further details.

data/benchmarks/messaging.rb

@@ -10,7 +10,7 @@ require 'dcell'
 DCell.setup
 DCell.run!
 
-RECEIVER_PORT = 12345
+RECEIVER_PORT = 2043
 
 $receiver_pid = Process.spawn Gem.ruby, File.expand_path("../receiver.rb", __FILE__)
 STDERR.print "Waiting for test node to start up..."
@@ -52,6 +52,12 @@ class AsyncPerformanceTest
   end
 end
 
+DCell.start :id => "messaging_node", :addr => "tcp://127.0.0.1:2042",
+  :directory => {
+    :id => "benchmark_receiver",
+    :addr => "tcp://127.0.0.1:#{RECEIVER_PORT}"
+  }
+
 receiver = DCell::Node['benchmark_receiver']
 progenator = receiver[:progenator]
 

data/benchmarks/receiver.rb

@@ -3,7 +3,7 @@ require 'bundler'
 Bundler.setup
 
 require 'dcell'
-DCell.setup :id => 'benchmark_receiver', :addr => 'tcp://127.0.0.1:12345'
+DCell.start :id => 'benchmark_receiver', :addr => 'tcp://127.0.0.1:2043'
 
 class AsyncReceiver
   include Celluloid
@@ -29,8 +29,8 @@ class Progenator
   end
 end
 
-class BenchmarkApplication < Celluloid::Group
-  supervise DCell::Group
+class BenchmarkApplication < Celluloid::SupervisionGroup
+  supervise DCell::SupervisionGroup
   supervise Progenator, :as => :progenator
 end
 

data/dcell.gemspec

@@ -16,9 +16,9 @@ Gem::Specification.new do |gem|
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency "celluloid",     "~> 0.10.0"
-  gem.add_runtime_dependency "celluloid-zmq", "~> 0.10.0"
-  gem.add_runtime_dependency "reel", "~> 0.0.1"
+  gem.add_runtime_dependency "celluloid",     "~> 0.12.0"
+  gem.add_runtime_dependency "celluloid-zmq", "~> 0.12.0"
+  gem.add_runtime_dependency "reel"
   gem.add_runtime_dependency "redis"
   gem.add_runtime_dependency "redis-namespace"
   gem.add_runtime_dependency "moneta"

data/explorer/index.html.erb

@@ -89,6 +89,6 @@
     ================================================== -->
     <!-- Placed at the end of the document so the pages load faster -->
     <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
-    <script src="js/bootstrap.min.js"></script>
+    <script src="/js/bootstrap.min.js"></script>
   </body>
 </html>

data/lib/dcell.rb

@@ -21,16 +21,13 @@ require 'dcell/info_service'
 require 'dcell/registries/redis_adapter'
 require 'dcell/registries/moneta_adapter'
 
-require 'dcell/registries/gossip/core'
-require 'dcell/registries/gossip_adapter'
-
 require 'dcell/celluloid_ext'
 
 # Distributed Celluloid
 module DCell
   class NotConfiguredError < RuntimeError; end # Not configured yet
 
-  DEFAULT_PORT  = 7777 # Default DCell port
+  DEFAULT_PORT  = 7890 # Default DCell port
   @config_lock  = Mutex.new
 
   class << self
@@ -39,7 +36,7 @@ module DCell
     # Configure DCell with the following options:
     #
     # * id: to identify the local node, defaults to hostname
-    # * addr: 0MQ address of the local node (e.g. tcp://4.3.2.1:7777)
+    # * addr: 0MQ address of the local node (e.g. tcp://4.3.2.1:7890)
     # *
     def setup(options = {})
       # Stringify keys :/
@@ -54,16 +51,6 @@ module DCell
 
         @me = Node.new @configuration['id'], @configuration['addr']
 
-        # Specify the directory server (defaults to me), and add it
-        # to the local directory.
-        directory = @configuration['directory'] || {}
-        directory = directory.inject({}) { |h,(k,v)| h[k.to_s] = v; h }
-        directory = {
-          'id'   => @configuration['id'],
-          'addr' => @configuration['addr']
-        }.merge(directory)
-        DCell::Directory.set directory['id'], directory['addr']
-
         registry_adapter = @configuration['registry'][:adapter] || @configuration['registry']['adapter']
         raise ArgumentError, "no registry adapter given in config" unless registry_adapter
 
@@ -101,12 +88,12 @@ module DCell
 
     # Run the DCell application
     def run
-      DCell::Group.run
+      DCell::SupervisionGroup.run
     end
 
     # Run the DCell application in the background
     def run!
-      DCell::Group.run!
+      DCell::SupervisionGroup.run!
     end
 
     # Start combines setup and run! into a single step
@@ -117,7 +104,7 @@ module DCell
   end
 
   # DCell's actor dependencies
-  class Group < Celluloid::Group
+  class SupervisionGroup < Celluloid::SupervisionGroup
     supervise NodeManager, :as => :node_manager
     supervise Server,      :as => :dcell_server
     supervise InfoService, :as => :info

data/lib/dcell/actor_proxy.rb

@@ -1,4 +1,29 @@
 module DCell
   # Proxy object for actors that live on remote nodes
   class ActorProxy < Celluloid::ActorProxy; end
-end
+
+  class ThreadHandleProxy
+    def kill
+      raise NotImplementedError, "remote kill not supported"
+    end
+
+    def join
+      raise NotImplementedError, "remote join not supported"
+    end
+  end
+
+  class SubjectProxy
+    def class
+      "[remote]"
+    end
+  end
+
+  class Actor
+    def initialize(mailbox)
+      @mailbox = mailbox
+      @thread  = ThreadHandleProxy.new
+      @subject = SubjectProxy.new
+    end
+    attr_reader :mailbox, :thread, :subject
+  end
+end

data/lib/dcell/celluloid_ext.rb

@@ -28,16 +28,27 @@ module Celluloid
     # Create an actor proxy object which routes messages over DCell's overlay
     # network and back to the original mailbox
     def self._load(string)
-      mailbox = Celluloid::Mailbox._load(string)
+      mailbox = ::Celluloid::Mailbox._load(string)
 
       case mailbox
-      when DCell::MailboxProxy
-        DCell::ActorProxy.new mailbox
-      when Celluloid::Mailbox
-        Celluloid::ActorProxy.new(mailbox)
-      else raise "funny, I did not expect to see a #{mailbox.class} here"
+      when ::DCell::MailboxProxy
+        actor = ::DCell::Actor.new(mailbox)
+        ::DCell::ActorProxy.new actor
+      when ::Celluloid::Mailbox
+        actor = find_actor(mailbox)
+        ::Celluloid::ActorProxy.new(actor)
+      else ::Kernel.raise "funny, I did not expect to see a #{mailbox.class} here"
       end
     end
+
+    def self.find_actor(mailbox)
+      ::Thread.list.each do |t|
+        if actor = t[:actor]
+          return actor if actor.mailbox == mailbox
+        end
+      end
+      ::Kernel.raise "no actor found for mailbox: #{mailbox.inspect}"
+    end
   end
 
   class Mailbox
@@ -45,7 +56,7 @@ module Celluloid
     # be reached remotely.
     def _dump(level)
       mailbox_id = DCell::Router.register self
-      "#{mailbox_id}@#{DCell.id}@#{DCell.addr}"
+      "#{mailbox_id}@#{DCell.id}"
     end
 
     # Create a mailbox proxy object which routes messages over DCell's overlay
@@ -70,7 +81,7 @@ module Celluloid
   class Future
     def _dump(level)
       mailbox_id = DCell::Router.register self
-      "#{mailbox_id}@#{DCell.id}@#{DCell.addr}"
+      "#{mailbox_id}@#{DCell.id}"
     end
 
     def self._load(string)

data/lib/dcell/directory.rb

@@ -3,33 +3,21 @@ module DCell
   module Directory
     extend self
 
-    @@directory = {}
-    @@directory_lock = Mutex.new
-
     # Get the URL for a particular Node ID
     def get(node_id)
-      @@directory_lock.synchronize do
-        @@directory[node_id]
-      end
+      DCell.registry.get_node node_id
     end
     alias_method :[], :get
 
     # Set the address of a particular Node ID
     def set(node_id, addr)
-      @@directory_lock.synchronize do
-        @@directory[node_id] = addr
-      end
+      DCell.registry.set_node node_id, addr
     end
     alias_method :[]=, :set
 
     # List all of the node IDs in the directory
     def all
-      @@directory_lock.synchronize { @@directory.keys }
-    end
-
-    # Clear the directory.
-    def clear
-      @@directory_lock.synchronize { @@directory.clear }
+      DCell.registry.nodes
     end
   end
 end

data/lib/dcell/explorer.rb

@@ -38,7 +38,6 @@ module DCell
 
     def render_resource(connection, path)
       if node_id = path[%r{^nodes/(.*)$}, 1]
-        p node_id
         node = DCell::Node[node_id]
         path = "index.html"
       else

data/lib/dcell/mailbox_proxy.rb

@@ -4,12 +4,13 @@ module DCell
   class MailboxProxy
     class InvalidNodeError < StandardError; end
 
-    def initialize(node_id, node_addr, mailbox_id)
+    def initialize(node_id, mailbox_id)
       raise ArgumentError, "no mailbox_id given" unless mailbox_id
-      
+     
       @node_id = node_id
       @node = Node[node_id]
-      @node = Node.new(node_id, node_addr) unless @node
+      raise ArgumentError, "invalid node_id given" unless @node
+      
       @mailbox_id = mailbox_id
     end
 
@@ -24,12 +25,7 @@ module DCell
 
     # Send a message to the mailbox
     def <<(message)
-      @node.send_message! Message::Relay.new(@mailbox_id, message)
-    end
-
-    # Send a system event
-    def system_event(event)
-      @node.send_message! Message::SystemEvent.new(@mailbox_id, event)
+      @node.send_message! Message::Relay.new(self, message)
     end
 
     # Is the remote mailbox still alive?
@@ -39,12 +35,12 @@ module DCell
 
     # Custom marshaller for compatibility with Celluloid::Mailbox marshalling
     def _dump(level)
-      "#{@mailbox_id}@#{@node_id}@#{@node_addr}"
+      "#{@mailbox_id}@#{@node_id}"
     end
 
     # Loader for custom marshal format
     def self._load(string)
-      mailbox_id, node_id, node_addr = string.split("@")
+      mailbox_id, node_id = string.split("@")
 
       if DCell.id == node_id
         # If we're on the local node, find the real mailbox
@@ -53,7 +49,7 @@ module DCell
         mailbox
       else
         # Create a proxy to the mailbox on the remote node
-        DCell::MailboxProxy.new(node_id, node_addr, mailbox_id)
+        DCell::MailboxProxy.new(node_id, mailbox_id)
       end
     end
   end

data/lib/dcell/messages.rb

@@ -8,14 +8,15 @@ module DCell
       @id = object_id
     end
 
-    # Gossip messages contain health and membership information
-    class Gossip < Message
-      def initialize(peers, data)
-        @peers, @data = peers, data
+    # Heartbeat messages inform other nodes this node is healthy
+    class Heartbeat < Message
+      def initialize
+        @id = DCell.id
       end
 
       def dispatch
-        Node.handle_gossip(@peers, @data)
+        node = DCell::Node[@id]
+        node.handle_heartbeat if node
       end
     end
 
@@ -57,21 +58,7 @@ module DCell
       end
 
       def dispatch
-        DCell::Router.route @recipient, @message
-      end
-    end
-
-    # Send a system event to the given recipient
-    class SystemEvent < Message
-      attr_reader :recipient, :event
-
-      def initialize(recipient, event)
-        super()
-        @recipient, @event = recipient, event
-      end
-
-      def dispatch
-        DCell::Router.route_system_event @recipient, @event
+        @recipient << @message
       end
     end
   end