ffi-rzmq 1.0.3 → 2.0.1

data/lib/ffi-rzmq/socket.rb

@@ -1,8 +1,7 @@
 
 module ZMQ
 
-  module CommonSocketBehavior
-
+  class Socket
     attr_reader :socket, :name
 
     # Allocates a socket of type +type+ for sending and receiving data.
@@ -70,15 +69,15 @@ module ZMQ
 
       context_ptr = context_ptr.pointer if context_ptr.kind_of?(ZMQ::Context)
 
-      unless context_ptr.null?
+      if context_ptr.nil? || context_ptr.null?
+        raise ContextError.new 'zmq_socket', 0, ETERM, "Context pointer was null"
+      else
         @socket = LibZMQ.zmq_socket context_ptr, type
         if @socket && !@socket.null?
           @name = SocketTypeNameMap[type]
         else
           raise ContextError.new 'zmq_socket', 0, ETERM, "Socket pointer was null"
         end
-      else
-        raise ContextError.new 'zmq_socket', 0, ETERM, "Context pointer was null"
       end
 
       @longlong_cache = @int_cache = nil
@@ -118,7 +117,7 @@ module ZMQ
     # Returns 0 when the operation completed successfully.
     # Returns -1 when this operation failed.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     #  rc = socket.setsockopt(ZMQ::LINGER, 1_000)
@@ -136,15 +135,14 @@ module ZMQ
         pointer.write_int value
 
       elsif 2 == @option_lookup[name]
+        # Strings are treated as pointers by FFI so we'll just pass it through
         length ||= value.size
+        pointer = value
 
-        # note: not checking errno for failed memory allocations :(
-        pointer = LibC.malloc length
-        pointer.write_string value
       end
 
       rc = LibZMQ.zmq_setsockopt @socket, name, pointer, length
-      LibC.free(pointer) unless pointer.nil? || pointer.null?
+      LibC.free(pointer) unless pointer.is_a?(String) || pointer.nil? || pointer.null?
       rc
     end
 
@@ -193,7 +191,7 @@ module ZMQ
     # depending upon the value of the socket option ZMQ::LINGER.
     #
     # Returns 0 upon success *or* when the socket has already been closed.
-    # Returns -1 when the operation fails. Check ZMQ.errno for the error code.
+    # Returns -1 when the operation fails. Check ZMQ::Util.errno for the error code.
     #
     #  rc = socket.close
     #  puts("Given socket was invalid!") unless 0 == rc
@@ -215,15 +213,15 @@ module ZMQ
     #
     # +flags+ may take two values:
     # * 0 (default) - blocking operation
-    # * ZMQ::NonBlocking - non-blocking operation
+    # * ZMQ::DONTWAIT - non-blocking operation
     # * ZMQ::SNDMORE - this message is part of a multi-part message
     #
     # Returns 0 when the message was successfully enqueued.
     # Returns -1 under two conditions.
     # 1. The message could not be enqueued
-    # 2. When +flags+ is set with ZMQ::NonBlocking and the socket returned EAGAIN.
+    # 2. When +flags+ is set with ZMQ::DONTWAIT and the socket returned EAGAIN.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     def sendmsg message, flags = 0
@@ -233,14 +231,14 @@ module ZMQ
     # Helper method to make a new #Message instance out of the +string+ passed
     # in for transmission.
     #
-    # +flags+ may be ZMQ::NonBlocking and ZMQ::SNDMORE.
+    # +flags+ may be ZMQ::DONTWAIT and ZMQ::SNDMORE.
     #
     # Returns 0 when the message was successfully enqueued.
     # Returns -1 under two conditions.
     # 1. The message could not be enqueued
-    # 2. When +flags+ is set with ZMQ::NonBlocking and the socket returned EAGAIN.
+    # 2. When +flags+ is set with ZMQ::DONTWAIT and the socket returned EAGAIN.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     def send_string string, flags = 0
@@ -252,14 +250,14 @@ module ZMQ
     # passed in for transmission. Every element of +parts+ should be
     # a String.
     #
-    # +flags+ may be ZMQ::NonBlocking.
+    # +flags+ may be ZMQ::DONTWAIT.
     #
     # Returns 0 when the messages were successfully enqueued.
     # Returns -1 under two conditions.
     # 1. A message could not be enqueued
-    # 2. When +flags+ is set with ZMQ::NonBlocking and the socket returned EAGAIN.
+    # 2. When +flags+ is set with ZMQ::DONTWAIT and the socket returned EAGAIN.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     def send_strings parts, flags = 0
@@ -270,14 +268,14 @@ module ZMQ
     # passed in for transmission. Every element of +parts+ should be
     # a Message (or subclass).
     #
-    # +flags+ may be ZMQ::NonBlocking.
+    # +flags+ may be ZMQ::DONTWAIT.
     #
     # Returns 0 when the messages were successfully enqueued.
     # Returns -1 under two conditions.
     # 1. A message could not be enqueued
-    # 2. When +flags+ is set with ZMQ::NonBlocking and the socket returned EAGAIN.
+    # 2. When +flags+ is set with ZMQ::DONTWAIT and the socket returned EAGAIN.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     def sendmsgs parts, flags = 0
@@ -290,9 +288,9 @@ module ZMQ
     # Returns 0 when the message was successfully enqueued.
     # Returns -1 under two conditions.
     # 1. The message could not be enqueued
-    # 2. When +flags+ is set with ZMQ::NonBlocking and the socket returned EAGAIN.
+    # 2. When +flags+ is set with ZMQ::DONTWAIT and the socket returned EAGAIN.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     def send_and_close message, flags = 0
@@ -305,14 +303,14 @@ module ZMQ
     #
     # +flags+ may take two values:
     #  0 (default) - blocking operation
-    #  ZMQ::NonBlocking - non-blocking operation
+    #  ZMQ::DONTWAIT - non-blocking operation
     #
     # Returns 0 when the message was successfully dequeued.
     # Returns -1 under two conditions.
     # 1. The message could not be dequeued
-    # 2. When +flags+ is set with ZMQ::NonBlocking and the socket returned EAGAIN.
+    # 2. When +flags+ is set with ZMQ::DONTWAIT and the socket returned EAGAIN.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     # The application code is responsible for handling the +message+ object lifecycle
@@ -326,14 +324,14 @@ module ZMQ
     # Helper method to make a new #Message instance and convert its payload
     # to a string.
     #
-    # +flags+ may be ZMQ::NonBlocking.
+    # +flags+ may be ZMQ::DONTWAIT.
     #
     # Returns 0 when the message was successfully dequeued.
     # Returns -1 under two conditions.
     # 1. The message could not be dequeued
-    # 2. When +flags+ is set with ZMQ::NonBlocking and the socket returned EAGAIN.
+    # 2. When +flags+ is set with ZMQ::DONTWAIT and the socket returned EAGAIN.
     #
-    # With a -1 return code, the user must check ZMQ.errno to determine the
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
     # cause.
     #
     # The application code is responsible for handling the +message+ object lifecycle
@@ -349,7 +347,7 @@ module ZMQ
 
     # Receive a multipart message as a list of strings.
     #
-    # +flag+ may be ZMQ::NonBlocking. Any other flag will be
+    # +flag+ may be ZMQ::DONTWAIT. Any other flag will be
     # removed.
     #
     def recv_strings list, flag = 0
@@ -369,11 +367,11 @@ module ZMQ
     # Receive a multipart message as an array of objects
     # (by default these are instances of Message).
     #
-    # +flag+ may be ZMQ::NonBlocking. Any other flag will be
+    # +flag+ may be ZMQ::DONTWAIT. Any other flag will be
     # removed.
     #
     def recvmsgs list, flag = 0
-      flag = NonBlocking if dontwait?(flag)
+      flag = DONTWAIT if dontwait?(flag)
 
       message = @receiver_klass.new
       rc = recvmsg message, flag
@@ -426,24 +424,96 @@ module ZMQ
       rc
     end
 
+    # Get the options set on this socket.
+    #
+    # +name+ determines the socket option to request
+    # +array+ should be an empty array; a result of the proper type
+    # (numeric, string, boolean) will be inserted into
+    # the first position.
+    #
+    # Valid +option_name+ values:
+    #  ZMQ::RCVMORE - true or false
+    #  ZMQ::HWM - integer
+    #  ZMQ::SWAP - integer
+    #  ZMQ::AFFINITY - bitmap in an integer
+    #  ZMQ::IDENTITY - string
+    #  ZMQ::RATE - integer
+    #  ZMQ::RECOVERY_IVL - integer
+    #  ZMQ::SNDBUF - integer
+    #  ZMQ::RCVBUF - integer
+    #  ZMQ::FD     - fd in an integer
+    #  ZMQ::EVENTS - bitmap integer
+    #  ZMQ::LINGER - integer measured in milliseconds
+    #  ZMQ::RECONNECT_IVL - integer measured in milliseconds
+    #  ZMQ::BACKLOG - integer
+    #  ZMQ::RECOVER_IVL_MSEC - integer measured in milliseconds
+    #  ZMQ::IPV4ONLY - integer
+    #
+    # Returns 0 when the operation completed successfully.
+    # Returns -1 when this operation failed.
+    #
+    # With a -1 return code, the user must check ZMQ::Util.errno to determine the
+    # cause.
+    #
+    #  # retrieve high water mark
+    #  array = []
+    #  rc = socket.getsockopt(ZMQ::HWM, array)
+    #  hwm = array.first if ZMQ::Util.resultcode_ok?(rc)
+    #
+    def getsockopt name, array
+      rc = __getsockopt__ name, array
+
+      if Util.resultcode_ok?(rc) && (RCVMORE == name)
+        # convert to boolean
+        array[0] = 1 == array[0]
+      end
+
+      rc
+    end
+
+    # Convenience method for getting the value of the socket IDENTITY.
+    #
+    def identity
+      array = []
+      getsockopt IDENTITY, array
+      array.at(0)
+    end
+
+    # Convenience method for setting the value of the socket IDENTITY.
+    #
+    def identity=(value)
+      setsockopt IDENTITY, value.to_s
+    end
+
+    # Disconnect the socket from the given +endpoint+.
+    #
+    def disconnect(endpoint)
+      LibZMQ.zmq_disconnect(socket, endpoint)
+    end
+
+    # Unbind the socket from the given +endpoint+.
+    #
+    def unbind(endpoint)
+      LibZMQ.zmq_unbind(socket, endpoint)
+    end
+
 
     private
-    
+
     def send_multiple(parts, flags, method_name)
       if !parts || parts.empty?
         -1
       else
-        flags = NonBlocking if dontwait?(flags)
+        flags = DONTWAIT if dontwait?(flags)
         rc = 0
-        
+
         parts[0..-2].each do |part|
           rc = send(method_name, part, (flags | ZMQ::SNDMORE))
           break unless Util.resultcode_ok?(rc)
         end
-        
+
         Util.resultcode_ok?(rc) ? send(method_name, parts[-1], flags) : rc
       end
-      
     end
 
     def __getsockopt__ name, array
@@ -485,277 +555,57 @@ module ZMQ
         alloc_pointer(255, 255)
 
       else
-        # uh oh, someone passed in an unknown option; use a slop buffer
+        # uh oh, someone passed in an unknown option; return nil
         @int_cache ||= alloc_pointer(:int32, 4)
       end
     end
 
-    def populate_option_lookup
-      # integer options
-      [EVENTS, LINGER, RCVTIMEO, SNDTIMEO, RECONNECT_IVL, FD, TYPE, BACKLOG].each { |option| @option_lookup[option] = 0 }
-
-      # long long options
-      [RCVMORE, AFFINITY].each { |option| @option_lookup[option] = 1 }
-
-      # string options
-      [SUBSCRIBE, UNSUBSCRIBE].each { |option| @option_lookup[option] = 2 }
-    end
-
     def release_cache
       @longlong_cache = nil
       @int_cache = nil
     end
 
     def dontwait?(flags)
-      (NonBlocking & flags) == NonBlocking
+      (DONTWAIT & flags) == DONTWAIT
     end
     alias :noblock? :dontwait?
-    
+
     def alloc_pointer(kind, length)
       pointer = FFI::MemoryPointer.new :size_t
       pointer.write_int(length)
       [FFI::MemoryPointer.new(kind), pointer]
     end
-  end # module CommonSocketBehavior
 
-
-  module IdentitySupport
-
-    # Convenience method for getting the value of the socket IDENTITY.
-    #
-    def identity
-      array = []
-      getsockopt IDENTITY, array
-      array.at(0)
+    def __sendmsg__(socket, address, flags)
+      LibZMQ.zmq_sendmsg(socket, address, flags)
     end
 
-    # Convenience method for setting the value of the socket IDENTITY.
-    #
-    def identity=(value)
-      setsockopt IDENTITY, value.to_s
+    def __recvmsg__(socket, address, flags)
+      LibZMQ.zmq_recvmsg(socket, address, flags)
     end
 
-
-    private
-
     def populate_option_lookup
-      super()
-
-      # string options
-      [IDENTITY].each { |option| @option_lookup[option] = 2 }
-    end
-
-  end # module IdentitySupport
-
-
-  if LibZMQ.version2?
-
-    class Socket
-      # Inclusion order is *important* since later modules may have a call
-      # to #super. We want those calls to go up the chain in a particular
-      # order
-      include CommonSocketBehavior
-      include IdentitySupport
-
-      # Get the options set on this socket.
-      #
-      # +name+ determines the socket option to request
-      # +array+ should be an empty array; a result of the proper type
-      # (numeric, string, boolean) will be inserted into
-      # the first position.
-      #
-      # Valid +option_name+ values:
-      #  ZMQ::RCVMORE - true or false
-      #  ZMQ::HWM - integer
-      #  ZMQ::SWAP - integer
-      #  ZMQ::AFFINITY - bitmap in an integer
-      #  ZMQ::IDENTITY - string
-      #  ZMQ::RATE - integer
-      #  ZMQ::RECOVERY_IVL - integer
-      #  ZMQ::MCAST_LOOP - true or false
-      #  ZMQ::SNDBUF - integer
-      #  ZMQ::RCVBUF - integer
-      #  ZMQ::FD     - fd in an integer
-      #  ZMQ::EVENTS - bitmap integer
-      #  ZMQ::LINGER - integer measured in milliseconds
-      #  ZMQ::RECONNECT_IVL - integer measured in milliseconds
-      #  ZMQ::BACKLOG - integer
-      #  ZMQ::RECOVER_IVL_MSEC - integer measured in milliseconds
-      #
-      # Returns 0 when the operation completed successfully.
-      # Returns -1 when this operation failed.
-      #
-      # With a -1 return code, the user must check ZMQ.errno to determine the
-      # cause.
-      #
-      #  # retrieve high water mark
-      #  array = []
-      #  rc = socket.getsockopt(ZMQ::HWM, array)
-      #  hwm = array.first if ZMQ::Util.resultcode_ok?(rc)
-      #
-      def getsockopt name, array
-        rc = __getsockopt__ name, array
-
-        if Util.resultcode_ok?(rc) && (RCVMORE == name || MCAST_LOOP == name)
-          # convert to boolean
-          array[0] = 1 == array[0]
-        end
-
-        rc
-      end
-
+      IntegerSocketOptions.each { |option| @option_lookup[option] = 0 }
 
-      private
-
-      def __sendmsg__(socket, address, flags)
-        LibZMQ.zmq_send(socket, address, flags)
-      end
-
-      def __recvmsg__(socket, address, flags)
-        LibZMQ.zmq_recv(socket, address, flags)
-      end
-
-      def populate_option_lookup
-        super()
-
-        # integer options
-        [RECONNECT_IVL_MAX].each { |option| @option_lookup[option] = 0 }
-
-        # long long options
-        [HWM, SWAP, RATE, RECOVERY_IVL, RECOVERY_IVL_MSEC, MCAST_LOOP, SNDBUF, RCVBUF].each { |option| @option_lookup[option] = 1 }
-      end
-
-      # these finalizer-related methods cannot live in the CommonSocketBehavior
-      # module; they *must* be in the class definition directly
-
-      def define_finalizer
-        ObjectSpace.define_finalizer(self, self.class.close(@socket, Process.pid))
-      end
-
-      def remove_finalizer
-        ObjectSpace.undefine_finalizer self
-      end
+      LongLongSocketOptions.each { |option| @option_lookup[option] = 1 }
 
-      def self.close socket, pid
-        Proc.new do
-          LibZMQ.zmq_close(socket) if socket && !socket.nil? && Process.pid == pid
-        end
-      end
-    end # class Socket for version2
-
-  end # LibZMQ.version2?
-
-
-  if LibZMQ.version3?
-    class Socket
-      include CommonSocketBehavior
-      include IdentitySupport
-
-      # Get the options set on this socket.
-      #
-      # +name+ determines the socket option to request
-      # +array+ should be an empty array; a result of the proper type
-      # (numeric, string, boolean) will be inserted into
-      # the first position.
-      #
-      # Valid +option_name+ values:
-      #  ZMQ::RCVMORE - true or false
-      #  ZMQ::HWM - integer
-      #  ZMQ::SWAP - integer
-      #  ZMQ::AFFINITY - bitmap in an integer
-      #  ZMQ::IDENTITY - string
-      #  ZMQ::RATE - integer
-      #  ZMQ::RECOVERY_IVL - integer
-      #  ZMQ::SNDBUF - integer
-      #  ZMQ::RCVBUF - integer
-      #  ZMQ::FD     - fd in an integer
-      #  ZMQ::EVENTS - bitmap integer
-      #  ZMQ::LINGER - integer measured in milliseconds
-      #  ZMQ::RECONNECT_IVL - integer measured in milliseconds
-      #  ZMQ::BACKLOG - integer
-      #  ZMQ::RECOVER_IVL_MSEC - integer measured in milliseconds
-      #  ZMQ::IPV4ONLY - integer
-      #
-      # Returns 0 when the operation completed successfully.
-      # Returns -1 when this operation failed.
-      #
-      # With a -1 return code, the user must check ZMQ.errno to determine the
-      # cause.
-      #
-      #  # retrieve high water mark
-      #  array = []
-      #  rc = socket.getsockopt(ZMQ::HWM, array)
-      #  hwm = array.first if ZMQ::Util.resultcode_ok?(rc)
-      #
-      def getsockopt name, array
-        rc = __getsockopt__ name, array
-
-        if Util.resultcode_ok?(rc) && (RCVMORE == name)
-          # convert to boolean
-          array[0] = 1 == array[0]
-        end
-
-        rc
-      end
-      
-      # Version3 only
-      #
-      # Disconnect the socket from the given +endpoint+.
-      #
-      def disconnect(endpoint)
-        LibZMQ.zmq_disconnect(socket, endpoint)
-      end
-      
-      # Version3 only
-      #
-      # Unbind the socket from the given +endpoint+.
-      #
-      def unbind(endpoint)
-        LibZMQ.zmq_unbind(socket, endpoint)
-      end
-
-
-      private
-
-      def __sendmsg__(socket, address, flags)
-        LibZMQ.zmq_sendmsg(socket, address, flags)
-      end
-
-      def __recvmsg__(socket, address, flags)
-        LibZMQ.zmq_recvmsg(socket, address, flags)
-      end
-
-      def populate_option_lookup
-        super()
-
-        # integer options
-        [RECONNECT_IVL_MAX, RCVHWM, SNDHWM, RATE, RECOVERY_IVL, SNDBUF, RCVBUF, IPV4ONLY,
-          ROUTER_BEHAVIOR, TCP_KEEPALIVE, TCP_KEEPALIVE_CNT,
-          TCP_KEEPALIVE_IDLE, TCP_KEEPALIVE_INTVL, TCP_ACCEPT_FILTER, MULTICAST_HOPS
-        ].each { |option| @option_lookup[option] = 0 }
-
-        # long long options
-        [MAXMSGSIZE].each { |option| @option_lookup[option] = 1 }
-
-        # string options
-        [LAST_ENDPOINT].each { |option| @option_lookup[option] = 2 }
-      end
+      StringSocketOptions.each { |option| @option_lookup[option] = 2 }
+    end
 
-      # these finalizer-related methods cannot live in the CommonSocketBehavior
-      # module; they *must* be in the class definition directly
+    # these finalizer-related methods cannot live in the CommonSocketBehavior
+    # module; they *must* be in the class definition directly
 
-      def define_finalizer
-        ObjectSpace.define_finalizer(self, self.class.close(@socket, Process.pid))
-      end
+    def define_finalizer
+      ObjectSpace.define_finalizer(self, self.class.close(@socket, Process.pid))
+    end
 
-      def remove_finalizer
-        ObjectSpace.undefine_finalizer self
-      end
+    def remove_finalizer
+      ObjectSpace.undefine_finalizer self
+    end
 
-      def self.close socket, pid
-        Proc.new { LibZMQ.zmq_close socket if Process.pid == pid }
-      end
-    end # Socket for version3
-  end # LibZMQ.version3?
+    def self.close socket, pid
+      Proc.new { LibZMQ.zmq_close socket if Process.pid == pid }
+    end
+  end # Socket
 
 end # module ZMQ