brb 0.2.0 → 0.2.1

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+0.2.1 (Apr 16, 2010)
+
+* Automatically start EM if not started
+* Deprecate the usage of BrB::Service.instance => use BrB::Service instead
+
 0.2.0 (Apr 16, 2010)
 
 * Releasing gem and wiki

data/README.rdoc

@@ -1,6 +1,6 @@
 = BrB - Easy and Fast distributed ruby
 
-BrB is a simple and extremely fast interface for doing simple distributed ruby.
+BrB is a simple, fully transparent and extremely fast interface for doing simple distributed ruby.
 The main power of the architecture is provided by EventMachine (Fast and reliable IO event library).
 
 BrB was build in order to achieve these 4 main goals :

data/examples/simple_client.rb

@@ -1,37 +1,32 @@
-require 'lib/brb'
+require File.join(File.dirname(__FILE__), '../init.rb')
 
 port = 5555
 host = 'localhost'
 
-EM::run do
-  EM::set_quantum(20)
-  # Connecting to the core server, retrieving its interface object : core
-  # We do not want to expose an object, so the first parameter is nil
-  core = BrB::Tunnel.create(nil, "brb://#{host}:#{port}", :silent => false)
-
-  # Create thread here, as you can not block the EventMachine::run block
-  Thread.new do
-
-    # Calling 10 times an non blocking method on the distant core server
-    10.times do
-      core.simple_api_method # Do not wait for response
-    end
-    
-    # Calling 10 times again long treatment time distant methods
-    10.times do
-      core.simple_long_api_method # Do not wait for response
-    end
-
-    # Calling a blocking method with _block on the distant core server :
-    puts " >> Calling 1s call, and wait for response..."
-    r = core.simple_api_method_block
-    puts " > Api response : #{r}"
-    
-    puts " >> Calling long call, and wait for response..."
-    r = core.simple_long_api_method_block
-    puts " > Api long response : #{r}"
-
-    # Our job is over, close
-    EM.stop
-  end
+# Connecting to the core server, retrieving its interface object : core
+# We do not want to expose an object, so the first parameter is nil
+core = BrB::Tunnel.create(nil, "brb://#{host}:#{port}", :silent => false)
+
+# Calling 10 times an non blocking method on the distant core server
+10.times do
+  core.simple_api_method # Do not wait for response
+end
+
+# Calling 10 times again long treatment time distant methods
+10.times do
+  core.simple_long_api_method # Do not wait for response
 end
+
+# Calling a blocking method with _block on the distant core server :
+puts " >> Calling 1s call, and wait for response..."
+r = core.simple_api_method_block
+puts " > Api response : #{r}"
+
+puts " >> Calling long call, and wait for response..."
+r = core.simple_long_api_method_block
+puts " > Api long response : #{r}"
+
+core.stop_service
+
+# Our job is over, close event machine :
+EM.stop

data/examples/simple_core.rb

@@ -1,4 +1,4 @@
-require 'lib/brb'
+require File.join(File.dirname(__FILE__), '../init.rb')
 
 class ExposedCoreObject
   
@@ -23,9 +23,6 @@ Thread.abort_on_exception = true
 port = 5555
 host = 'localhost'
 
-EM::run do
-  EM::set_quantum(20)
-
-  puts " > Starting the core on brb://#{host}:#{port}"
-  BrB::Service.instance.start_service(:object => ExposedCoreObject.new, :silent => false, :host => host, :port => port)
-end
+puts " > Starting the core on brb://#{host}:#{port}"
+BrB::Service.start_service(:object => ExposedCoreObject.new, :silent => false, :host => host, :port => port)
+EM.reactor_thread.join

data/lib/brb.rb

@@ -1,48 +1,4 @@
 require File.join(File.dirname(__FILE__), 'brb', 'exception.rb')
 require File.join(File.dirname(__FILE__), 'brb', 'event_machine.rb')
+require File.join(File.dirname(__FILE__), 'brb', 'service.rb')
 require File.join(File.dirname(__FILE__), 'brb', 'tunnel.rb')
-require 'singleton'
-
-#
-# Brb Main class used to do basic distributed ruby, Simple but fast
-# Use two distinct canal, one for the command reception, and the other one for send return value
-#
-module BrB
-  class Service
-    attr_reader :silent
-    attr_reader :uri
-
-    include Singleton
-
-    # Start a server hosted on the object given,
-    # If an uri is given, automatcilay connect to the distant brb object
-    def start_service(opts = {}, &block)
-      return if @em_signature
-      
-      @silent = opts[:silent]
-
-      addr = "brb://#{opts[:host] || 'localhost'}:#{opts[:port] || 6200}"
-
-      tputs " [BrB] Start service on #{addr} ..."
-      @uri, @em_signature = BrBProtocol.open_server(addr, BrB::Tunnel::Handler, opts.merge(:block => block))
-      tputs " [BrB] Service started on #{@uri}"
-    end
-
-private
-    def tputs(s)
-      puts s if !@silent
-    end
-
-public
-    # Stop the Brb Service
-    def stop_service
-      return if !@em_signature
-      
-      tputs ' [BrB] Stop service'
-      EM::stop_server(@em_signature)
-      @em_signature = nil
-      @uri = nil
-    end
-
-  end
-end

data/lib/brb/event_machine.rb

@@ -1,44 +1,91 @@
+# Define a BrB::Protocol using event machine
 require 'eventmachine'
 
-# Define a BrBProtocol using event machine
-class BrBEventMachine
+module BrB
+  class EventMachine
 
-  def self.parse_uri(uri)
-    if /^brb:\/\/(.+):([0-9]+)$/ =~ uri 
-      [$1, $2.to_i]
-    else
-      raise "Bad tcp BrB url: '#{uri}'"
-    end
-  end
+    class << self
+
+    private
+      # If EM::run has not been called yet, start the EM reactor in another thread.
+      def ensure_em_is_started!
+        if !EM::reactor_running?
+          # Launch event machine reactor
+          q = Queue.new
+          Thread.new do
+            EM::run do
+              q << true # Set to the calling thread that the reactor is running
+              #EM::set_quantum(20)
+              #EventMachine::epoll
+            end
+          end
+          # Wait for event machine running :
+          q.pop
+        end
+
+      end
+
+    public
+      def open(uri, klass, opts = {})
+        host, port = parse_uri(uri)
+        begin
+          ensure_em_is_started!
+      
+          q = Queue.new
+          EM.schedule do
+            q << EM::connect(host, port, klass, opts.merge(:uri => "brb://#{host}:#{port}"))
+          end
+          
+          # Wait for socket connection with the q.pop
+          return q.pop
+
+        rescue Exception => e
+          puts e.backtrace.join("\n")
+          raise "#{e} - #{uri}"
+        end
+      end
 
-  def self.open(uri, klass, opts = {})
-    host, port = parse_uri(uri)
-    begin
-      socket = EventMachine::connect host, port, klass, opts.merge(:uri => "brb://#{host}:#{port}")
+      def open_server(uri, klass, opts = {})
+        host, port = parse_uri(uri)
+        max = 80 # Nb try before giving up
+        begin
+          uri = "brb://#{host}:#{port}"
+          ensure_em_is_started!
 
-    rescue Exception => e
-      puts e.backtrace.join("\n")
-      raise "#{e} - #{uri}"
+          # Schedule server creation for thread safety
+          q = Queue.new
+          EM.schedule do
+            q << EM::start_server(host, port, klass, opts.merge(:uri => uri))
+          end
+
+          # Wait for server creation with the q.pop
+          return uri, q.pop
+
+        rescue Exception => e
+          max -= 1
+          port += 1
+          retry if max > 0
+          puts e.backtrace.join("\n")
+          raise "#{e} - BrB Tcp Event machine Can not bind on #{host}:#{port}"
+        end
+
+      end
     end
-    return socket
   end
+  
+  class Protocol < EventMachine
+
+    class << self
+
+      def parse_uri(uri)
+        if /^brb:\/\/(.+):([0-9]+)$/ =~ uri 
+          [$1, $2.to_i]
+        else
+          raise "Bad tcp BrB url: '#{uri}'"
+        end
+      end
 
-  def self.open_server(uri, klass, opts = {})
-    host, port = parse_uri(uri)
-    max = 80
-    begin
-      #EventMachine::epoll
-      uri = "brb://#{host}:#{port}"
-      return uri, EventMachine::start_server(host, port, klass, opts.merge(:uri => uri))
-    rescue Exception => e
-      max -= 1
-      port += 1
-      retry if max > 0
-      puts e.backtrace.join("\n")
-      raise "#{e} - BrB Tcp Event machine Can not bind on #{host}:#{port}"
     end
   end
 end
 
-class BrBProtocol < BrBEventMachine
-end

data/lib/brb/exception.rb

@@ -0,0 +1 @@
+# Future BrB custom exceptions will come here

data/lib/brb/service.rb

@@ -0,0 +1,60 @@
+#
+# Brb Main class used to do basic distributed ruby, Simple but fast
+# Use two distinct canal, one for the command reception, and the other one for send return value
+#
+module BrB
+  class Service
+    @@uri = nil
+    @@em_signature = nil
+    @@silent = true
+
+    class << self
+
+    private
+      def tputs(s)
+        puts s if !@@silent
+      end
+
+    public
+
+      # Start a server hosted on the object given,
+      # If an uri is given, automatcilay connect to the distant brb object
+      def start_service(opts = {}, &block)
+        return if @@em_signature
+  
+        @@silent = opts[:silent]
+  
+        addr = "brb://#{opts[:host] || 'localhost'}:#{opts[:port] || 6200}"
+  
+        tputs " [BrB] Start service on #{addr} ..."
+        @@uri, @@em_signature = BrB::Protocol::open_server(addr, BrB::Tunnel::Handler, opts.merge(:block => block))
+        tputs " [BrB] Service started on #{@@uri}"
+      end
+
+      def uri
+        @@uri
+      end
+
+      # Stop the Brb Service
+      def stop_service
+        return if !@@em_signature or !EM::reactor_running?
+      
+        tputs " [BrB] Stop service on #{@@uri}"
+        sign = @@em_signature
+        q = Queue.new # Creation of a Queue for waiting server to stop
+        EM::schedule do
+          q << EM::stop_server(sign)
+        end
+        q.pop
+        @@em_signature = nil
+        @@uri = nil
+      end
+      
+      # Deprecated old method
+      def instance
+        puts "DEPRECATION WARNING: BrB::Service::instance is deprecated => Just use BrB::Service"
+        self
+      end
+    end
+  end
+end

data/lib/brb/tunnel.rb

@@ -7,11 +7,11 @@ module BrB
   module Tunnel
 
     def self.create(object, uri = nil, opts = {}, &block)
-      BrBProtocol.open(uri, BrB::Tunnel::Handler, opts.merge(:object => object, :block => block))
+      BrB::Protocol.open(uri, BrB::Tunnel::Handler, opts.merge(:object => object, :block => block))
     end
 
     # Brb interface Handler for Tunnel over Event machine
-    class Handler < EventMachine::Connection
+    class Handler < ::EventMachine::Connection
       attr_reader :uri
 
       include BrB::Request
@@ -38,12 +38,12 @@ module BrB
         tputs " [BrB] Tunnel initialized on #{@uri}"
         @active = true
         if @block
-          EventMachine.defer do
+          EM.defer do
             @block.call(:register, self)
           end
         end
       end
-      
+
       def close_connection(after_writing = false)
         @active = false
         super
@@ -53,7 +53,7 @@ module BrB
         tputs ' [BrB] Tunnel service closed'
         @active = false
         if @block
-          EventMachine.defer do
+          EM.defer do
             @block.call(:unregister, self)
           end
         end

data/lib/brb/tunnel/shared.rb

@@ -63,7 +63,7 @@ module BrB
 
             @queue << obj
 
-            EventMachine.defer do
+            EM.defer do
               treat_request(@queue.pop)
             end
             

data/spec/brb/brb_massive_usage_spec.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/../spec_helper'
 
 describe :brb_service do
   before(:all) do
-    @brb = BrB::Service.instance
+    @brb = BrB::Service
     @brb.stop_service
     @brb_test = BrBTest.new
     open_service(@brb_test)

data/spec/brb/brb_service_spec.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/../spec_helper'
 
 describe :brb_service do
   before(:all) do
-    @brb = BrB::Service.instance
+    @brb = BrB::Service
     @brb.stop_service
     @brb_test = BrBTest.new
     open_service(self)

data/spec/brb/brb_tunnel_spec.rb

@@ -5,7 +5,7 @@ $last_registered = nil
 
 describe :brb_service do
   before(:all) do
-    @brb = BrB::Service.instance
+    @brb = BrB::Service
     @brb.stop_service
     @brb_test = BrBTest.new
     open_service(@brb_test)

data/spec/spec_helper.rb

@@ -6,30 +6,11 @@ Thread.abort_on_exception = true
 require File.dirname(__FILE__) + '/../init.rb'
 
 def open_service(object, host = 'localhost', port = 6200)
-  if !EM::reactor_running?
-    # Launch event machine reactor
-    Thread.new do
-      EM::run do
-        EM::set_quantum(20)
-      end
-    end
-    sleep 0.05
-  end
-  r = nil
-  EM.schedule do
-    r = BrB::Service.instance.start_service(:object => object, :silent => true, :host => host, :port => port)
-  end
-  sleep 0.1
-  return r
+  BrB::Service.start_service(:object => object, :silent => true, :host => host, :port => port)
 end
 
 def connect_to_the_service(object_exposed, uri, &block)
-  r = nil
-  EM.schedule do
-    r = BrB::Tunnel.create(object_exposed, uri, :silent => true, &block)
-  end
-  sleep 0.1
-  return r
+  BrB::Tunnel.create(object_exposed, uri, :silent => true, &block)
 end
 
 class BrBTest

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Guillaume Luccisano
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-16 00:00:00 +02:00
+date: 2010-04-19 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -29,7 +29,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-description: BrB is a simple and extremely fast interface for doing simple distributed ruby and message passing
+description: BrB is a simple, fully transparent and extremely fast interface for doing simple distributed ruby and message passing
 email: guillaume.luccisano@gmail.com
 executables: []
 
@@ -43,6 +43,7 @@ files:
 - lib/brb/event_machine.rb
 - lib/brb/exception.rb
 - lib/brb/request.rb
+- lib/brb/service.rb
 - lib/brb/tunnel/shared.rb
 - lib/brb/tunnel.rb
 - lib/brb.rb
@@ -86,6 +87,6 @@ rubyforge_project: brb
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: BrB is a simple and extremely fast interface for doing simple distributed ruby
+summary: BrB is a simple, fully transparent and extremely fast interface for doing simple distributed ruby
 test_files: []