tribe_em 0.0.2 → 0.0.3

data/README.md

@@ -19,7 +19,42 @@ Or install it yourself as:
 
 ## Usage
 
-Coming soon.
+You can test the below code using a utility such as telnet (telnet localhost 9000), entering some text, and then killing telnet.
+
+    # Create a custom connection actor class.
+    class EchoConnection < Tribe::EM::Connection
+      private
+      
+      def on_post_init(event)
+        puts "Actor (#{identifier}) connected to client using thread (#{Thread.current.object_id})."
+      end
+
+      def on_receive_data(event)
+        puts "Actor (#{identifier}) received data (#{event.data}) using thread (#{Thread.current.object_id})."
+        write(event.data)
+        enqueue(:shutdown)
+      end
+
+      def on_unbind(event)
+        puts "Actor (#{identifier}) disconnected from client using thread (#{Thread.current.object_id})."
+        super
+      end
+    end
+    
+    # Create your server actor.
+    server = Tribe::EM::TcpServer.new('localhost', 9000, EchoConnection)
+
+## Customization
+
+Tribe EM is designed to be easily customized through inheritence of Tribe::EM::Connection.
+Communication between EventMachine and the Tribe actor system is provided by Tribe::EM::ActorProxy.
+
+## TODO - missing features
+
+- Commonly used server protocols such as HTTP.
+- Integration with my [AMF Socket] (https://github.com/chadrem/amf_socket_ruby "AMF Socket") gem.
+- Client side sockets.
+
 
 ## Contributing
 

data/lib/tribe_em/actor_proxy.rb

@@ -0,0 +1,54 @@
+# Attempt to provide thread-safe communication between EventMachine and Tribe:
+# 1. Always use EM.schedule to push work to the reactor thread.
+# 2. Always use @actor.enqueue to push work to the actor's thread pool.
+
+module Tribe
+  module EM
+    class ActorProxy < ::EM::Connection
+      private
+
+      def initialize(actor_class, options = {})
+        @actor_class = actor_class || raise('You must provide an actor class.')
+        @logger = Workers::LogProxy.new(options[:logger])
+
+        @actor = @actor_class.new({ :actor_proxy => self, :logger => @logger })
+      end
+
+      #
+      # EM Callbacks.  Don't call these directly.
+      #
+
+      public
+
+      def post_init
+        @actor.enqueue(:post_init, nil)
+      end
+
+      def receive_data(data)
+        @actor.enqueue(:receive_data, data)
+      end
+
+      def unbind
+        @actor.enqueue(:unbind, nil)
+      end
+
+      #
+      # Public methods.  Call these from the associated actor.
+      #
+
+      public
+
+      def close(after_writing = false)
+        ::EM.schedule { close_connection(after_writing) }
+
+        return nil
+      end
+
+      def write(data)
+        ::EM.schedule { send_data(data) }
+
+        return nil
+      end
+    end
+  end
+end

data/lib/tribe_em/connection.rb

@@ -1,39 +1,43 @@
 module Tribe
   module EM
-    class Connection < ::EM::Connection
-      include Tribe::Actable
-
-      # EM callback.  Don't call directly.
-      def post_init
-        enqueue(:post_init, nil)
-      end
-
-      # EM callback.  Don't call directly.
-      def receive_data(data)
-        enqueue(:receive_data, data)
-      end
-
-      # EM callback.  Don't call directly.
-      def unbind
-        enqueue(:unbind, nil)
+    class Connection < Tribe::Actor
+      # The Proxy class is what cleanly separates the EM connection and Tribe actor.
+      def self.proxy_class
+        return Tribe::EM::ActorProxy
       end
 
       private
 
       def initialize(options = {})
-        init_actable(options)
+        @actor_proxy = options[:actor_proxy] || raise('You must provide an actor proxy.')
+
+        super
       end
 
       def on_post_init(event)
-        puts "Actor (#{identifier}) connected to client using thread (#{Thread.current.object_id})."
       end
 
       def on_receive_data(event)
-        puts "Actor (#{identifier}) received data (#{event.data}) using thread (#{Thread.current.object_id})."
       end
 
       def on_unbind(event)
-        puts "Actor (#{identifier}) disconnected from client using thread (#{Thread.current.object_id})."
+        enqueue(:shutdown)
+      end
+
+      def exception_handler(e)
+        close
+      end
+
+      def shutdown_handler(event)
+        close(true)
+      end
+
+      def write(data)
+        @actor_proxy.write(data)
+      end
+
+      def close(after_writing = false)
+        @actor_proxy.close(after_writing)
       end
     end
   end

data/lib/tribe_em/dedicated_connection.rb

@@ -0,0 +1,13 @@
+module Tribe
+  module EM
+    class DedicatedConnection < Tribe::EM::Connection
+      private
+
+      def initialize(options = {})
+        options[:dedicated] = true
+
+        super(options)
+      end
+    end
+  end
+end

data/lib/tribe_em/tcp_server.rb

@@ -3,12 +3,12 @@ module Tribe
     class TcpServer < Tribe::Actor
       private
 
-      def initialize(ip, port, conn_class, options = {})
+      def initialize(ip, port, actor_class, options = {})
         super(options)
 
-        @ip = ip
-        @port = port
-        @conn_class = conn_class
+        @ip = ip || raise('IP is required.')
+        @port = port || raise('Port is required.')
+        @actor_class = actor_class || raise('Actor class is required.')
 
         start_listener
       end
@@ -21,21 +21,35 @@ module Tribe
         stop_listener
       end
 
+      def on_listener_started(event)
+        @server_sig = event.data
+      end
+
+      def on_listener_stopped(event)
+        @server_sig = nil
+      end
+
       def shutdown_handler(event)
-        stop_server
+        stop_listener if @server_sig
       end
 
       def start_listener
         return if @server_sig
 
-        @server_sig = ::EM.start_server(@ip, @port, @conn_class)
+        ::EM.schedule do
+          sig = ::EM.start_server(@ip, @port, @actor_class.proxy_class, @actor_class, { :logger => @logger })
+          enqueue(:listener_started, sig)
+        end
       end
 
       def stop_listener
         return unless @server_sig
 
-        ::EM.stop_server(@server_sig)
-        @server_sig = nil
+        sig = @server_sig
+        ::EM.schedule do
+          ::EM.stop_server(sig)
+          enqueue(:listener_stopped)
+        end
       end
     end
   end

data/lib/tribe_em/version.rb

@@ -1,5 +1,5 @@
 module Tribe
   module EM
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/lib/tribe_em.rb

@@ -2,7 +2,9 @@ require 'tribe'
 require 'eventmachine'
 
 require 'tribe_em/version'
+require 'tribe_em/actor_proxy'
 require 'tribe_em/connection'
+require 'tribe_em/dedicated_connection'
 require 'tribe_em/tcp_server'
 
 module Tribe
@@ -12,6 +14,10 @@ module Tribe
         ::EM.run do
           ::EM.kqueue = true if ::EM.kqueue?
           ::EM.epoll = true if ::EM.epoll?
+
+          ::EM.error_handler do |e|
+            puts "EXCEPTION: #{e.message}\n#{e.backtrace.join("\n")}--"
+          end
         end
       end
 

data/tribe_em.gemspec

@@ -4,19 +4,19 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'tribe_em/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "tribe_em"
+  gem.name          = 'tribe_em'
   gem.version       = Tribe::EM::VERSION
-  gem.authors       = ["Chad Remesch"]
-  gem.email         = ["chad@remesch.com"]
+  gem.authors       = ['Chad Remesch']
+  gem.email         = ['chad@remesch.com']
   gem.description   = %q{Event driven network IO for the Tribe gem.}
   gem.summary       = %q{Quickly create network servers using EventMachine and Tribe.}
-  gem.homepage      = "https://github.com/chadrem/tribe_em"
+  gem.homepage      = 'https://github.com/chadrem/tribe_em'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
-  gem.add_dependency('tribe', ['0.0.8'])
+  gem.add_dependency('tribe', '0.0.8')
   gem.add_dependency('eventmachine', '>= 1.0.0')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tribe_em
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-27 00:00:00.000000000 Z
+date: 2013-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tribe
@@ -56,7 +56,9 @@ files:
 - README.md
 - Rakefile
 - lib/tribe_em.rb
+- lib/tribe_em/actor_proxy.rb
 - lib/tribe_em/connection.rb
+- lib/tribe_em/dedicated_connection.rb
 - lib/tribe_em/tcp_server.rb
 - lib/tribe_em/version.rb
 - tribe_em.gemspec
@@ -80,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Quickly create network servers using EventMachine and Tribe.