cod 0.4.3 → 0.4.4

data/HISTORY.txt

@@ -1,3 +1,14 @@
+= 0.4.4 / 7Mar2012
+
+  + Uses IO.select in the server as well, not polling for accept. This should
+    further reduce the CPU time consumed by servers. 
+    
+  ! Fixes a bug where server would hang forever with messages to return in
+    its queue. 
+    
+  + Switching to YARD for documentation, please be patient while the whole 
+    gets a workover. This should be finished by 0.4.6 at the latest.
+
 = 0.4.3 / 28Feb2012
 
   ! Fixes a few bugs when using tcp channels (connection was not made or not

data/README

@@ -34,7 +34,7 @@ Working transports include:
 * tcp (server and client)
 * beanstalk (connects to beanstalkd)
 
-At version 0.4.3
+At version 0.4.4
 
 (c) 2011 Kaspar Schiess
 

data/examples/example_scaffold.rb

@@ -1,11 +1,13 @@
 def server
   fork do
+    $0 = 'server'
     yield
   end
 end
 
 def client
   fork do
+    $0 = 'client'
     yield
   end
 end

data/examples/protocol-buffers/README

@@ -1,3 +1,4 @@
 A demonstration of what it takes to use googles protocol buffers (protobuf) on
-the wire. You will need the ruby-protocol-buffers gem for this to work. 
+the wire. You will need the ruby-protocol-buffers gem and of course the protoc
+compiler for this to work.
 

data/examples/tcp_get_ext.rb

@@ -0,0 +1,38 @@
+$:.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
+$:.unshift File.expand_path(File.dirname(__FILE__))
+require 'cod'
+require 'example_scaffold'
+
+2.times do 
+  client {
+    chan = Cod.tcp('localhost:1234')
+    chan.put :get_client_id
+    p [:client_id, chan.get]
+  }
+end
+
+server {
+  server = Cod.tcp_server('localhost:1234')
+  client_id = 0
+  
+  loop do
+    msg, chan = server.get_ext
+
+    p [:incoming, msg, chan.object_id.to_s(16)]
+    begin
+      case msg 
+        when :get_client_id
+          client_id += 1
+          chan.put client_id
+      end
+          
+    ensure
+      # Closes connections after one request.
+      chan.close 
+    end
+    
+    break if client_id >= 2
+  end
+}
+
+run

data/lib/cod/service.rb

@@ -4,7 +4,7 @@ module Cod
   # answer. It solves problems related to timeouts, getting _your_ answer and
   # not any kind of answer, etc... 
   # 
-  # Synopsis: 
+  # == Synopsis
   #   # On the server end: 
   #   service = server_channel.service
   #   service.one { |request| :answer }
@@ -40,6 +40,8 @@ module Cod
     # Use Cod::Client to perform the service call. This will keep track of 
     # messages sent and answers received and a couple of other things. 
     # 
+    # @yield [Object] request made by the client. The return value of the 
+    #   block will be returned to the client.
     #
     def one
       rq, answer_chan = @channel.get

data/lib/cod/tcp_client.rb

@@ -25,12 +25,15 @@ module Cod
       @serializer = serializer
       @destination = destination
 
+      # TODO remove this soon
+      fail "Deprecated API" if destination.kind_of?(TCPSocket)
+      
       # TcpClient handles two cases: Construction via an url (destination is a
       # string) and construction via a connection that has been
       # preestablished (destination is a socket):
-      if destination.respond_to?(:read)
-        # destination seems to be a socket, wrap it with Connection
-        @connection = Connection.new(destination)
+      if destination.respond_to?(:established?)
+        # Should be a connection already.
+        @connection = destination
       else
         @connection = RobustConnection.new(destination)
       end
@@ -115,6 +118,8 @@ module Cod
     # the other end (the deserializing end). What the deserializing code does
     # with this is his problem. 
     #
+    # @private
+    #
     OtherEnd = Struct.new(:destination) # :nodoc:
 
     def _dump(level) # :nodoc:
@@ -235,9 +240,12 @@ module Cod
     # the TcpServers clients: the tcp server manages the back channels, so
     # the created channel is lent its socket only.
     #
+    # @private
+    #
     class Connection # :nodoc:
-      def initialize(socket)
-        @socket = socket.dup
+      def initialize(socket, owner)
+        @owner = owner
+        @socket = socket
       end
       attr_reader :socket
       def try_connect
@@ -252,7 +260,7 @@ module Cod
         @socket.write(buffer)
       end
       def close
-        @socket.close
+        @owner.request_close(socket)
       end
     end
   end

data/lib/cod/tcp_server.rb

@@ -4,7 +4,7 @@ module Cod
   # A tcp server channel. Messages are read from any of the connected sockets
   # in a round robin fashion. 
   #
-  # Synopsis: 
+  # == Synopsis
   #   server = Cod.tcp_server('localhost:12345') 
   #   server.get  # 'a message'
   #   msg, chan = server.get_ext
@@ -13,13 +13,11 @@ module Cod
   # connected sockets, this is up to you to implement. Instead, you can use
   # one of two ways to obtain a channel for talking back to a specific client:
   # 
-  # Using #get_ext:
   #   msg, chan = server.get_ext 
-  #
+  # 
   # chan is a two way connected channel to the specific client that has opened 
   # its communication with msg. 
   #
-  # Using plain #get: 
   #   # on the client: 
   #   client.put [client, :msg]
   #   # on the server
@@ -37,10 +35,14 @@ module Cod
       @serializer = serializer
     end
     
-    # Receives one object from the channel. 
+    # Receives one object from the channel. This will receive one message from
+    # one of the connected clients in a round-robin fashion. 
     #
-    # Example: 
+    # @example
     #   channel.get # => object
+    #
+    # @param opts [Hash] 
+    # @return [Object] message sent by one of the clients
     #   
     def get(opts={})
       msg, socket = _get(opts)
@@ -54,14 +56,18 @@ module Cod
     # Using this method, the server can communicate back to its clients
     # individually instead of collectively. 
     #
-    # Example: 
+    # @example Answering to the client that sent a specific message
     #   msg, chan = server.get_ext
     #   chan.put :answer
+    #
+    # @param opts [Hash]
+    # @return [Array<Object, TcpClient>] tuple of the message that was sent 
+    #   a channel back to the client that sent the message
     def get_ext(opts={})
       msg, socket = _get(opts)
       return [
         msg, 
-        TcpClient.new(socket, @serializer)]
+        produce_back_channel(socket)]
     end
     
     # Closes the channel. 
@@ -89,37 +95,65 @@ module Cod
     def service
       Service.new(self)
     end
-    # NOTE: It is really more convenient to just construct a Cod.tcp_client 
+    
+    # @note It is really more convenient to just construct a Cod.tcp_client 
     # and ask that for a client object. In the case of TCP, this is enough. 
     #
     def client(answers_to)
       Service::Client.new(answers_to, answers_to)
     end
 
+    # ------------------------------------------------------- connection owner
+    
+    # Notifies the TcpServer that one of its connections needs to be closed. 
+    # This can be triggered by using #get_ext to obtain a handle to connections
+    # and then calling #close on that connection. 
+    #
+    # @param socket [TCPSocket] the socket that needs to be closed
+    # @return [void]
+    #
+    def request_close(socket)
+      @client_sockets.delete(socket)
+      socket.close
+    end
+    
   private
     def _get(opts)
       loop do
-        # Check if there are pending connects
-        accept_new_connections
+        # Return a buffered message if there is one left.
+        return @messages.shift unless @messages.empty?
 
-        # shuffle the socket list around, so we don't always read from the
-        # same client.
+        # Shuffle the socket list around, so we don't always read from the
+        # same client first.
         socket_list = round_robin(@client_sockets)
-
-        # select for readiness
-        rr, rw, re = IO.select(socket_list, nil, nil, 0.1)
+        
+        # Append the server socket to be able to react to new connections
+        # that are made.
+        socket_list << @socket
+      
+        # Sleep until either a new connection is made or data is available on 
+        # one of the old connections. 
+        rr, _, _ = IO.select(socket_list, nil, nil)
         next unless rr
         
-        rr.each do |io|
-          if io.eof?
-            @client_sockets.delete(io)
-            io.close
-          else
-            consume_pending io, opts
-          end
+        # Accept new connections
+        if rr.include?(@socket)
+          accept_new_connections
+          rr.delete(@socket)
         end
         
-        return @messages.shift unless @messages.empty?
+        handle_socket_events(rr, opts)
+      end
+    end
+    
+    def handle_socket_events(sockets, opts)
+      sockets.each do |io|
+        if io.eof?
+          @client_sockets.delete(io)
+          io.close
+        else
+          consume_pending io, opts
+        end
       end
     end
   
@@ -130,14 +164,14 @@ module Cod
           io]
           
         # More messages from this socket? 
-        return unless IO.select([io], nil, nil, 0.01)
+        return unless IO.select([io], nil, nil, 0.0001)
       end
     end
     
     def deserialize(io)
       @serializer.de(io) { |obj|
         obj.kind_of?(TcpClient::OtherEnd) ? 
-          TcpClient.new(io, @serializer) :
+          produce_back_channel(io) : 
           obj
       }
     end
@@ -161,5 +195,11 @@ module Cod
     rescue Errno::EAGAIN
       # This means that there are no sockets to accept. Continue.
     end
+
+    def produce_back_channel(socket)
+      TcpClient.new(
+        TcpClient::Connection.new(socket, self), 
+        @serializer)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cod
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-28 00:00:00.000000000 Z
+date: 2012-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70357075424760 !ruby/object:Gem::Requirement
+  requirement: &70125556634640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70357075424760
+  version_requirements: *70125556634640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70357075424320 !ruby/object:Gem::Requirement
+  requirement: &70125556634180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70357075424320
+  version_requirements: *70125556634180
 - !ruby/object:Gem::Dependency
   name: flexmock
-  requirement: &70357075423900 !ruby/object:Gem::Requirement
+  requirement: &70125556633740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70357075423900
+  version_requirements: *70125556633740
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70357075423480 !ruby/object:Gem::Requirement
+  requirement: &70125556633260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70357075423480
+  version_requirements: *70125556633260
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70357075423060 !ruby/object:Gem::Requirement
+  requirement: &70125556632740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70357075423060
+  version_requirements: *70125556632740
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &70357075422640 !ruby/object:Gem::Requirement
+  requirement: &70125556632280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70357075422640
+  version_requirements: *70125556632280
 description: 
 email: kaspar.schiess@absurd.li
 executables: []
@@ -84,7 +84,6 @@ extensions: []
 extra_rdoc_files:
 - README
 files:
-- Gemfile
 - HISTORY.txt
 - LICENSE
 - Rakefile
@@ -114,16 +113,11 @@ files:
 - examples/master_child.rb
 - examples/netcat/README
 - examples/netcat/server.rb
-- examples/presence/client.rb
-- examples/presence/server.rb
 - examples/protocol-buffers/master_child.rb
 - examples/protocol-buffers/README
-- examples/queue/client.rb
-- examples/queue/queue.rb
-- examples/queue/README
-- examples/queue/send.rb
 - examples/service.rb
 - examples/tcp.rb
+- examples/tcp_get_ext.rb
 homepage: http://kschiess.github.com/cod
 licenses: []
 post_install_message: 
@@ -140,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4089674409401429686
+      hash: -763744089584274604
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -149,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4089674409401429686
+      hash: -763744089584274604
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.16

data/Gemfile

@@ -1,3 +0,0 @@
-source "http://rubygems.org"
-
-gemspec

data/examples/presence/client.rb

@@ -1,15 +0,0 @@
-$:.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
-require 'cod'
-
-
-raise unless ARGV.first
-
-client = Cod.tcp('localhost:12345')
-client.put [client, ARGV.first]
-
-puts "Waiting..."
-$stdin.gets
-client.close
-$stdin.gets
-
-

data/examples/presence/server.rb

@@ -1,30 +0,0 @@
-
-$:.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
-require 'cod'
-
-
-present = {}
-server = Cod.tcpserver('localhost:12345')
-
-loop do
-  # Process connection requests
-  while server.waiting?
-    connection, attributes = server.get
-    
-    present[connection] = attributes
-  end
-
-  # Check if all connections are alive
-  remove = []
-  present.each do |conn, attrs|
-    if conn.connected?
-      puts "Alive: #{attrs.inspect}"
-    else
-      puts "Dead: #{attrs.inspect}"
-      remove << conn
-    end
-  end
-  
-  remove.each { |conn| present.delete(conn) }
-  sleep 1
-end

data/examples/queue/README

@@ -1,9 +0,0 @@
-A small queue like example. 
-
-run ruby send.rb N to send N messages through queue.rb to client.rb. 
-Client will print statistics (calls per second) every 100 messages.
-
-Problems: 
-  - queue.rb seems to always consume 100% CPU
-  - number of messages per second is way low
-  - some exceptions are still not handled correctly 

data/examples/queue/client.rb

@@ -1,31 +0,0 @@
-$:.unshift File.expand_path(File.dirname(__FILE__) + "/../../lib")
-require 'cod'
-
-queue = Cod.tcp('localhost:12345')
-
-queue.put [:join, queue]
-
-class CallCounter
-  attr_reader :n
-  def initialize
-    @n = 0
-    @last_lap = [0, Time.now]
-  end
-  def inc
-    @n += 1
-  end
-  def calls_per_sec
-    ln, ll = @last_lap
-    @last_lap = [@n, Time.now]
-    
-    (@n - ln) / (Time.now - ll)
-  end
-end
-
-cc = CallCounter.new
-loop do
-  wi = queue.get
-  
-  cc.inc
-  puts cc.calls_per_sec if cc.n%100==0 
-end

data/examples/queue/queue.rb

@@ -1,51 +0,0 @@
-$:.unshift File.expand_path(File.dirname(__FILE__) + "/../../lib")
-require 'cod'
-
-class Queue
-  def initialize(url)
-    @url = url
-    connect
-  end
-  
-  def connect
-    @clients = []
-    @server = Cod.tcpserver(@url)
-  end
-  
-  def run
-    loop do
-      handle_commands
-      
-      check_connections
-    end
-  end
-  
-  def handle_commands
-    while @server.waiting?
-      cmd, *rest = @server.get
-      
-      dispatch_command cmd, rest
-    end
-  end
-  
-  def dispatch_command(cmd, rest)
-    self.send("cmd_#{cmd}", *rest)
-  end
-  
-  def cmd_join(connection)
-    puts "Join at #{Time.now}."
-    @clients << connection
-  end
-  
-  def cmd_work_item
-    @clients.each do |client|
-      client.put :work_item
-    end
-  end
-  
-  def check_connections
-    @clients.keep_if { |client| client.connected? }
-  end
-end
-
-Queue.new('localhost:12345').run

data/examples/queue/send.rb

@@ -1,9 +0,0 @@
-$:.unshift File.expand_path(File.dirname(__FILE__) + "/../../lib")
-require 'cod'
-
-queue = Cod.tcp('localhost:12345')
-
-n = Integer(ARGV.first)
-n.times do
-  queue.put :work_item
-end