zmqmachine 0.3.0 → 0.3.1

data/.gitignore

@@ -0,0 +1,14 @@
+html
+pkg
+doc
+*.gem
+*.rbc
+*.tmproj
+nbproject
+*.bundle
+*.o
+.DS_Store
+examples/work
+benchmark
+*~
+*#*

data/History.txt

@@ -1,3 +1,10 @@
+== 0.3.1 / 2010-08-16
+  * Forgot to load the xreq/xrep files during startup
+  * Added support for resetting a timer's firing schedule. Useful for when
+    the time source has been overridden; let's existing timers 
+    reschedule themselves using the new time source.
+  * Fixed a logic bug with delivery of multi-part messages
+
 == 0.3.0 / 2010-08-15
   * Added XREQ/XREP socket types
   * Moved the time functions for ZM::Timers into a pair of

data/examples/fake_ftp.rb

@@ -81,6 +81,10 @@ class FTPControlClient
   def on_attach socket
     @socket = socket
     rc = socket.connect @address
+    
+    # REQ sockets do not register for read events by default, so we need
+    # to turn that on here
+    @context.register_readable socket
   end
 
   def on_readable socket, messages

data/examples/one_handed_ping_pong.rb

@@ -28,18 +28,25 @@ class PingPongHandler
       rc = socket.bind address
     when :request
       rc = socket.connect address
-      rc = socket.send_message_string "#{'a' * 2048}"
-      @sent_count += 1
+      @context.register_readable socket
     end
   end
 
+  def on_writable socket
+    rc = socket.send_message_string "#{'a' * 2048}"
+    @sent_count += 1
+    
+    # after sending the first message, deregister for future write events
+    @context.deregister_writable socket
+  end
+
   def on_readable socket, messages
     @received_count += 1
 
-    case socket.kind
-    when :reply
-      socket.send_message messages.first
-    when :request
+    if :reply == socket.kind
+      #socket.send_message messages.first
+      rc = socket.send_message_string messages.first.copy_out_string
+    else
       socket.send_message messages.first
     end
 

data/lib/zm/reactor.rb

@@ -3,14 +3,14 @@
 # Author:: Chuck Remes
 # Homepage::  http://github.com/chuckremes/zmqmachine
 # Date:: 20100602
-# 
+#
 #----------------------------------------------------------------------------
 #
 # Copyright (C) 2010 by Chuck Remes. All Rights Reserved.
 # Email: cremes at mac dot com
-# 
+#
 # (The MIT License)
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
 # 'Software'), to deal in the Software without restriction, including
@@ -18,10 +18,10 @@
 # distribute, sublicense, and/or sell copies of the Software, and to
 # permit persons to whom the Software is furnished to do so, subject to
 # the following conditions:
-# 
+#
 # The above copyright notice and this permission notice shall be
 # included in all copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
@@ -32,13 +32,13 @@
 #
 #---------------------------------------------------------------------------
 #
-# 
+#
 
 module ZMQMachine
 
   class Reactor
     attr_reader :name
-    
+
     # +poll_interval+ is the number of milliseconds to block while
     # waiting for new 0mq socket events; default is 0
     #
@@ -61,7 +61,7 @@ module ZMQMachine
     end
 
     # Returns true when the reactor is running OR while it is in the
-    # midst of a shutdown request. 
+    # midst of a shutdown request.
     #
     # Returns false when the reactor thread does not exist.
     #
@@ -124,12 +124,12 @@ module ZMQMachine
         end
       end
     end
-    
+
     # Kills the running reactor instance by terminating its thread.
     #
     # After the thread exits, the reactor attempts to clean up after itself
     # and kill any pending I/O.
-    # 
+    #
     def kill
       @stopping = true
       @thread.kill
@@ -273,7 +273,7 @@ module ZMQMachine
       save_socket sock
       sock
     end
-    
+
     # Registers the +sock+ for POLLOUT events that will cause the
     # reactor to call the handler's on_writable method.
     #
@@ -332,6 +332,15 @@ module ZMQMachine
     def cancel_timer timer
       @timers.cancel timer
     end
+    
+    # Asks all timers to reschedule themselves starting from Timers.now.
+    # Typically called when the underlying time source for the ZM::Timers
+    # class has been replaced; existing timers may not fire as expected, so
+    # we ask them to reset themselves.
+    #
+    def reschedule_timers
+      @timers.reschedule
+    end
 
 
     private

data/lib/zm/sockets/base.rb

@@ -113,8 +113,8 @@ module ZMQMachine
       #
       # May raise a ZMQ::SocketError.
       #
-      def send_message_string message
-        queued = @raw_socket.send_string message, ZMQ::NOBLOCK
+      def send_message_string message, multipart = false
+        queued = @raw_socket.send_string message, ZMQ::NOBLOCK | (multipart ? ZMQ::SNDMORE : 0)
         queued
       end
       
@@ -159,15 +159,19 @@ module ZMQMachine
       def resume_read
         messages = []
         rc = read_message_part messages
+        #puts "resume_read: rc1 [#{rc}], more_parts? [#{@raw_socket.more_parts?}]"
 
         while 0 == rc && @raw_socket.more_parts?
+          #puts "get next part"
           rc = read_message_part messages
+          #puts "resume_read: rc2 [#{rc}]"
         end
+        #puts "no more parts, ready to deliver"
 
         # only deliver the messages when rc is 0; otherwise, we
         # may have gotten EAGAIN and no message was read;
         # don't deliver empty messages
-        deliver messages, rc unless 0 == rc
+        deliver messages, rc if 0 == rc
       end
 
       # Used by the reactor. Never called by user code.
@@ -201,6 +205,7 @@ module ZMQMachine
       end
 
       def deliver messages, rc
+        #puts "deliver: rc [#{rc}], messages #{messages.inspect}"
         if 0 == rc
           @state = :ready
           @handler.on_readable self, messages

data/lib/zm/sockets.rb

@@ -1,4 +1,4 @@
 
-%w( base req rep pair pub sub ).each do |rb_file|
+%w( base req rep pair pub sub xreq xrep ).each do |rb_file|
   require File.join(File.dirname(__FILE__), 'sockets', rb_file)
 end

data/lib/zm/timers.rb

@@ -122,6 +122,19 @@ module ZMQMachine
       save.each { |timer| @timers.add timer }
     end
     
+    # Runs through all timers and asks each one to reschedule itself
+    # from Timers.now + whatever delay was originally recorded.
+    #
+    def reschedule
+      timers = @timers.dup
+      @timers.clear
+      
+      timers.each do |timer|
+        timer.reschedule
+        @timers.add timer
+      end
+    end
+    
     # Returns the current time using the following algo:
     #
     #  (Time.now.to_f * 1000).to_i
@@ -158,6 +171,7 @@ module ZMQMachine
     attr_reader :fire_time
 
     # +time+ is in milliseconds
+    #
     def initialize timers, delay, periodical, timer_proc = nil, &blk
       @timers = timers
       @delay = delay.to_i
@@ -178,6 +192,8 @@ module ZMQMachine
       schedule_firing_time if @periodical
     end
 
+    # Cancels this timer from firing.
+    #
     def cancel
       @timers.cancel self
     end
@@ -186,14 +202,22 @@ module ZMQMachine
       self.fire_time <=> other.fire_time
     end
 
+    # True when the timer should be fired; false otherwise.
+    #
     def expired? time
       time ||= now
       time > @fire_time
     end
 
+    # True when this is a periodical timer; false otherwise.
+    #
     def periodical?
       @periodical
     end
+    
+    def reschedule
+      schedule_firing_time
+    end
 
 
     private
@@ -209,12 +233,11 @@ module ZMQMachine
     # next timer to fire at, 17 + delay 5 = 22
     # had it not been late, it would fire at 20
     def schedule_firing_time
-      @fire_time = now + @delay
+      @initiated = Timers.now
+      
+      @fire_time = @initiated + @delay
     end
 
-    def now
-      Timers.now
-    end
   end # class Timer
 
 end # module ZMQMachine

data/version.txt

@@ -1 +1 @@
-0.3.0
+0.3.1

data/zmqmachine.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{zmqmachine}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chuck Remes"]
-  s.date = %q{2010-08-15}
+  s.date = %q{2010-08-16}
   s.description = %q{ZMQMachine is another Ruby implementation of the reactor pattern but this
 time using 0mq sockets rather than POSIX sockets.
 
@@ -22,7 +22,7 @@ It is possible to extend the 0mq library to "poll" normal file
 descriptors. This isn't on my roadmap but patches are accepted.}
   s.email = %q{cremes@mac.com}
   s.extra_rdoc_files = ["History.txt", "README.rdoc", "version.txt"]
-  s.files = [".bnsignore", "History.txt", "README.rdoc", "Rakefile", "examples/fake_ftp.rb", "examples/one_handed_ping_pong.rb", "examples/ping_pong.rb", "examples/pub_sub.rb", "examples/throttled_ping_pong.rb", "lib/zm/address.rb", "lib/zm/deferrable.rb", "lib/zm/exceptions.rb", "lib/zm/message.rb", "lib/zm/reactor.rb", "lib/zm/sockets.rb", "lib/zm/sockets/base.rb", "lib/zm/sockets/pair.rb", "lib/zm/sockets/pub.rb", "lib/zm/sockets/rep.rb", "lib/zm/sockets/req.rb", "lib/zm/sockets/sub.rb", "lib/zm/sockets/xrep.rb", "lib/zm/sockets/xreq.rb", "lib/zm/timers.rb", "lib/zmqmachine.rb", "spec/spec_helper.rb", "spec/zmqmachine_spec.rb", "version.txt", "zmqmachine.gemspec"]
+  s.files = [".bnsignore", ".gitignore", "History.txt", "README.rdoc", "Rakefile", "examples/fake_ftp.rb", "examples/one_handed_ping_pong.rb", "examples/ping_pong.rb", "examples/pub_sub.rb", "examples/throttled_ping_pong.rb", "lib/zm/address.rb", "lib/zm/deferrable.rb", "lib/zm/exceptions.rb", "lib/zm/message.rb", "lib/zm/reactor.rb", "lib/zm/sockets.rb", "lib/zm/sockets/base.rb", "lib/zm/sockets/pair.rb", "lib/zm/sockets/pub.rb", "lib/zm/sockets/rep.rb", "lib/zm/sockets/req.rb", "lib/zm/sockets/sub.rb", "lib/zm/sockets/xrep.rb", "lib/zm/sockets/xreq.rb", "lib/zm/timers.rb", "lib/zmqmachine.rb", "spec/spec_helper.rb", "spec/zmqmachine_spec.rb", "version.txt", "zmqmachine.gemspec"]
   s.homepage = %q{http://github.com/chuckremes/zmqmachine}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
@@ -36,13 +36,13 @@ descriptors. This isn't on my roadmap but patches are accepted.}
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<ffi-rzmq>, [">= 0.5.0"])
-      s.add_development_dependency(%q<bones>, [">= 3.4.3"])
+      s.add_development_dependency(%q<bones>, [">= 3.4.7"])
     else
       s.add_dependency(%q<ffi-rzmq>, [">= 0.5.0"])
-      s.add_dependency(%q<bones>, [">= 3.4.3"])
+      s.add_dependency(%q<bones>, [">= 3.4.7"])
     end
   else
     s.add_dependency(%q<ffi-rzmq>, [">= 0.5.0"])
-    s.add_dependency(%q<bones>, [">= 3.4.3"])
+    s.add_dependency(%q<bones>, [">= 3.4.7"])
   end
 end

metadata

@@ -3,48 +3,48 @@ name: zmqmachine
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
+    - 0
+    - 3
+    - 1
+  version: 0.3.1
 platform: ruby
 authors: 
-- Chuck Remes
+  - Chuck Remes
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-08-15 00:00:00 -05:00
+date: 2010-08-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: ffi-rzmq
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 5
-        - 0
-        version: 0.5.0
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bones
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 4
-        - 3
-        version: 3.4.3
-  type: :development
-  version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: ffi-rzmq
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+              - 5
+              - 0
+            version: 0.5.0
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: bones
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 3
+              - 4
+              - 7
+            version: 3.4.7
+    type: :development
+    version_requirements: *id002
 description: |-
   ZMQMachine is another Ruby implementation of the reactor pattern but this
   time using 0mq sockets rather than POSIX sockets.
@@ -65,63 +65,64 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- README.rdoc
-- version.txt
+  - History.txt
+  - README.rdoc
+  - version.txt
 files: 
-- .bnsignore
-- History.txt
-- README.rdoc
-- Rakefile
-- examples/fake_ftp.rb
-- examples/one_handed_ping_pong.rb
-- examples/ping_pong.rb
-- examples/pub_sub.rb
-- examples/throttled_ping_pong.rb
-- lib/zm/address.rb
-- lib/zm/deferrable.rb
-- lib/zm/exceptions.rb
-- lib/zm/message.rb
-- lib/zm/reactor.rb
-- lib/zm/sockets.rb
-- lib/zm/sockets/base.rb
-- lib/zm/sockets/pair.rb
-- lib/zm/sockets/pub.rb
-- lib/zm/sockets/rep.rb
-- lib/zm/sockets/req.rb
-- lib/zm/sockets/sub.rb
-- lib/zm/sockets/xrep.rb
-- lib/zm/sockets/xreq.rb
-- lib/zm/timers.rb
-- lib/zmqmachine.rb
-- spec/spec_helper.rb
-- spec/zmqmachine_spec.rb
-- version.txt
-- zmqmachine.gemspec
+  - .bnsignore
+  - .gitignore
+  - History.txt
+  - README.rdoc
+  - Rakefile
+  - examples/fake_ftp.rb
+  - examples/one_handed_ping_pong.rb
+  - examples/ping_pong.rb
+  - examples/pub_sub.rb
+  - examples/throttled_ping_pong.rb
+  - lib/zm/address.rb
+  - lib/zm/deferrable.rb
+  - lib/zm/exceptions.rb
+  - lib/zm/message.rb
+  - lib/zm/reactor.rb
+  - lib/zm/sockets.rb
+  - lib/zm/sockets/base.rb
+  - lib/zm/sockets/pair.rb
+  - lib/zm/sockets/pub.rb
+  - lib/zm/sockets/rep.rb
+  - lib/zm/sockets/req.rb
+  - lib/zm/sockets/sub.rb
+  - lib/zm/sockets/xrep.rb
+  - lib/zm/sockets/xreq.rb
+  - lib/zm/timers.rb
+  - lib/zmqmachine.rb
+  - spec/spec_helper.rb
+  - spec/zmqmachine_spec.rb
+  - version.txt
+  - zmqmachine.gemspec
 has_rdoc: true
 homepage: http://github.com/chuckremes/zmqmachine
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --main
-- README.rdoc
+  - --main
+  - README.rdoc
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
 requirements: []
 
 rubyforge_project: zmqmachine