zmqmachine 0.3.0

data/lib/zm/sockets/pair.rb

@@ -0,0 +1,87 @@
+#--
+#
+# 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
+# without limitation the rights to use, copy, modify, merge, publish,
+# 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.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#---------------------------------------------------------------------------
+#
+# 
+
+module ZMQMachine
+
+  module Socket
+
+    class Pair
+      include ZMQMachine::Socket::Base
+
+      def initialize context, handler
+        @poll_options = ZMQ::POLLIN | ZMQ::POLLOUT
+        @kind = :pair
+
+        super
+        @state = :ready
+      end
+
+      # Attach a handler to the PAIR socket.
+      #
+      # A PAIR socket may send and receive messages without
+      # restriction to order or quantity of send/recv
+      # operations.
+      #
+      # This socket expects its +handler+ to
+      # implement the #on_readable and #on_writable methods.
+      # The #on_readable method will be called whenever a
+      # message may be dequeued without blocking. The
+      # #on_writable method will be called whenever a
+      # message may be enqueued without blocking.
+      #
+      # For error handling purposes, the handler must also
+      # implement #on_readable_error and #on_writable_error.
+      #
+      def on_attach handler
+        raise ArgumentError, "Handler must implement an #on_readable method" unless handler.respond_to? :on_readable
+        raise ArgumentError, "Handler must implement an #on_writable method" unless handler.respond_to? :on_writable
+        raise ArgumentError, "Handler must implement an #on_readable_error method" unless handler.respond_to? :on_readable_error
+        raise ArgumentError, "Handler must implement an #on_writable_error method" unless handler.respond_to? :on_writable_error
+        super
+      end
+
+
+      private
+
+      def allocate_socket context
+        sock = ZMQ::Socket.new context.pointer, ZMQ::PAIR
+        sock
+      end
+    end # class Pair
+
+  end # module Socket
+
+end # module ZMQMachine

data/lib/zm/sockets/pub.rb

@@ -0,0 +1,80 @@
+#--
+#
+# 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
+# without limitation the rights to use, copy, modify, merge, publish,
+# 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.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#---------------------------------------------------------------------------
+#
+# 
+
+module ZMQMachine
+
+  module Socket
+
+    class Pub
+      include ZMQMachine::Socket::Base
+
+      def initialize context, handler
+        @poll_options = ZMQ::POLLOUT
+        @kind = :pub
+
+        super
+        @state = :ready
+      end
+
+      # Attach a handler to the PUB socket.
+      #
+      # A PUB socket may *only* send messages.
+      #
+      # This socket expects its +handler+ to
+      # implement the #on_writable methods.
+      # The #on_writable method will be called whenever a
+      # message may be enqueued without blocking.
+      #
+      # For error handling purposes, the handler must also
+      # implement #on_writable_error.
+      #
+      def on_attach handler
+        raise ArgumentError, "Handler must implement an #on_writable method" unless handler.respond_to? :on_writable
+        raise ArgumentError, "Handler must implement an #on_writable_error method" unless handler.respond_to? :on_writable_error
+        super
+      end
+
+      private
+
+      def allocate_socket context
+        sock = ZMQ::Socket.new context.pointer, ZMQ::PUB
+        sock
+      end
+    end # class Pub
+
+  end # module Socket
+
+end # module ZMQMachine

data/lib/zm/sockets/rep.rb

@@ -0,0 +1,96 @@
+#--
+#
+# 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
+# without limitation the rights to use, copy, modify, merge, publish,
+# 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.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#---------------------------------------------------------------------------
+#
+# 
+
+module ZMQMachine
+
+  module Socket
+
+    class Rep
+      include ZMQMachine::Socket::Base
+
+      def initialize context, handler
+        @poll_options = ZMQ::POLLIN
+        @kind = :reply
+
+        super
+        @state = :ready
+      end
+
+      # Attach a handler to the REP socket.
+      #
+      # A REP socket must alternate between recv.send (i.e.
+      # it cannot receive twice in a row without an intervening
+      # send). This socket expects its +handler+ to
+      # implement at least the #on_readable method. This method
+      # will be called whenever a request arrives.
+      #
+      # For error handling purposes, the handler must also
+      # implement #on_readable_error.
+      #
+      def on_attach handler
+        raise ArgumentError, "Handler must implement an #on_readable method" unless handler.respond_to? :on_readable
+        raise ArgumentError, "Handler must implement an #on_readable_error method" unless handler.respond_to? :on_readable_error
+        super
+      end
+
+      # +timeout+ is measured in milliseconds; default is 0 (never timeout)
+      def send_message message
+        unless waiting_for_request?
+          rc = super
+          @state = :waiting_for_request
+        else
+          rc = -1
+        end
+
+        rc
+      end
+
+
+      private
+
+      def waiting_for_request?
+        :waiting_for_request == @state
+      end
+
+      def allocate_socket context
+        sock = ZMQ::Socket.new context.pointer, ZMQ::REP
+        sock
+      end
+    end # class Rep
+
+  end # module Socket
+
+end # module ZMQMachine

data/lib/zm/sockets/req.rb

@@ -0,0 +1,96 @@
+#--
+#
+# 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
+# without limitation the rights to use, copy, modify, merge, publish,
+# 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.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#---------------------------------------------------------------------------
+#
+# 
+
+module ZMQMachine
+
+  module Socket
+
+    class Req
+      include ZMQMachine::Socket::Base
+
+      def initialize context, handler
+        @poll_options = ZMQ::POLLOUT
+        @kind = :request
+
+        super
+        @state = :ready
+      end
+
+      # Attach a handler to the REQ socket.
+      #
+      # A REQ socket must alternate between send/recv (i.e.
+      # it cannot send twice in a row without an intervening
+      # receive). This socket expects its +handler+ to
+      # implement at least the #on_readable method. This method
+      # will be called whenever a reply arrives.
+      #
+      # For error handling purposes, the handler must also
+      # implement #on_readable_error.
+      #
+      def on_attach handler
+        raise ArgumentError, "Handler must implement an #on_readable method" unless handler.respond_to? :on_readable
+        raise ArgumentError, "Handler must implement an #on_readable_error method" unless handler.respond_to? :on_readable_error
+        super
+      end
+
+      # +timeout+ is measured in milliseconds; default is 0 (never timeout)
+      def send_message message
+        unless waiting_for_reply?
+          rc = super
+          @state = :waiting_for_reply
+        else
+          rc = -1
+        end
+
+        rc
+      end
+
+
+      private
+
+      def waiting_for_reply?
+        :waiting_for_reply == @state
+      end
+
+      def allocate_socket context
+        sock = ZMQ::Socket.new context.pointer, ZMQ::REQ
+        sock
+      end
+    end # class Req
+
+  end # module Socket
+
+end # module ZMQMachine

data/lib/zm/sockets/sub.rb

@@ -0,0 +1,83 @@
+#--
+#
+# 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
+# without limitation the rights to use, copy, modify, merge, publish,
+# 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.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#---------------------------------------------------------------------------
+#
+# 
+
+module ZMQMachine
+
+  module Socket
+
+    class Sub
+      include ZMQMachine::Socket::Base
+
+      def initialize context, handler
+        @poll_options = ZMQ::POLLIN
+        @kind = :sub
+
+        super
+        @state = :ready
+      end
+
+      # Attach a handler to the SUB socket.
+      #
+      # A SUB socket may *only*receive messages.
+      #
+      # This socket expects its +handler+ to
+      # implement the #on_readable method.
+      # The #on_readable method will be called whenever a
+      # message may be dequeued without blocking.
+      #
+      # For error handling purposes, the handler must also
+      # implement #on_readable_error.
+      #
+      def on_attach handler
+        raise ArgumentError, "Handler must implement an #on_readable method" unless handler.respond_to? :on_readable
+        raise ArgumentError, "Handler must implement an #on_readable_error method" unless handler.respond_to? :on_readable_error
+        super
+      end
+
+      def subscribe topic
+        @raw_socket.setsockopt ZMQ::SUBSCRIBE, topic
+      end
+
+      private
+
+      def allocate_socket context
+        ZMQ::Socket.new context.pointer, ZMQ::SUB
+      end
+    end # class Sub
+
+  end # module Socket
+
+end # module ZMQMachine

data/lib/zm/sockets/xrep.rb

@@ -0,0 +1,86 @@
+#--
+#
+# 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
+# without limitation the rights to use, copy, modify, merge, publish,
+# 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.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#---------------------------------------------------------------------------
+#
+# 
+
+module ZMQMachine
+
+  module Socket
+
+    class XRep
+      include ZMQMachine::Socket::Base
+
+      def initialize context, handler
+        @poll_options = ZMQ::POLLIN | ZMQ::POLLOUT
+        @kind = :xreply
+
+        super
+        @state = :ready
+      end
+
+      # Attach a handler to the XREP socket.
+      #
+      # A XREP socket has no restrictions on the number of sends and
+      # recieves. Each send will silently prepend a message part to
+      # your outgoing data which the REQ/XREQ socket on the other end
+      # will use for matching up the transaction.
+      #
+      # This socket expects its +handler+ to
+      # implement at least the #on_readable method. This method
+      # will be called whenever a reply arrives. The #on_writable method
+      # will be called continually until the socket HWM is breached.
+      #
+      # For error handling purposes, the handler must also
+      # implement #on_readable_error.
+      #
+      def on_attach handler
+        raise ArgumentError, "Handler must implement an #on_readable method" unless handler.respond_to? :on_readable
+        raise ArgumentError, "Handler must implement an #on_readable_error method" unless handler.respond_to? :on_readable_error
+        raise ArgumentError, "Handler must implement an #on_readable method" unless handler.respond_to? :on_writable
+        raise ArgumentError, "Handler must implement an #on_readable_error method" unless handler.respond_to? :on_writable_error
+        super
+      end
+
+
+      private
+
+      def allocate_socket context
+        sock = ZMQ::Socket.new context.pointer, ZMQ::XREP
+        sock
+      end
+    end # class XRep
+
+  end # module Socket
+
+end # module ZMQMachine

data/lib/zm/sockets/xreq.rb

@@ -0,0 +1,86 @@
+#--
+#
+# 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
+# without limitation the rights to use, copy, modify, merge, publish,
+# 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.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#---------------------------------------------------------------------------
+#
+# 
+
+module ZMQMachine
+
+  module Socket
+
+    class XReq
+      include ZMQMachine::Socket::Base
+
+      def initialize context, handler
+        @poll_options = ZMQ::POLLIN | ZMQ::POLLOUT
+        @kind = :xrequest
+
+        super
+        @state = :ready
+      end
+
+      # Attach a handler to the XREQ socket.
+      #
+      # A XREQ socket has no restrictions on the number of sends and
+      # recieves. Each send will silently prepend a message part to
+      # your outgoing data which the REP/XREP socket on the other end
+      # will use for matching up the transaction.
+      #
+      # This socket expects its +handler+ to
+      # implement at least the #on_readable method. This method
+      # will be called whenever a reply arrives. The #on_writable method
+      # will be called continually until the socket HWM is breached.
+      #
+      # For error handling purposes, the handler must also
+      # implement #on_readable_error.
+      #
+      def on_attach handler
+        raise ArgumentError, "Handler must implement an #on_readable method" unless handler.respond_to? :on_readable
+        raise ArgumentError, "Handler must implement an #on_readable_error method" unless handler.respond_to? :on_readable_error
+        raise ArgumentError, "Handler must implement an #on_readable method" unless handler.respond_to? :on_writable
+        raise ArgumentError, "Handler must implement an #on_readable_error method" unless handler.respond_to? :on_writable_error
+        super
+      end
+
+
+      private
+
+      def allocate_socket context
+        sock = ZMQ::Socket.new context.pointer, ZMQ::XREQ
+        sock
+      end
+    end # class XReq
+
+  end # module Socket
+
+end # module ZMQMachine

data/lib/zm/sockets.rb

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