omq 0.23.0 → 0.26.2

data/lib/omq/ffi/libzmq.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require "ffi"
+
+module OMQ
+  module FFI
+    # Minimal libzmq FFI bindings — only what OMQ needs.
+    #
+    module Libzmq
+      extend ::FFI::Library
+      ffi_lib ["libzmq.so.5", "libzmq.5.dylib", "libzmq"]
+
+      # Context
+      attach_function :zmq_ctx_new,  [], :pointer
+      attach_function :zmq_ctx_term,     [:pointer], :int
+      attach_function :zmq_ctx_shutdown, [:pointer], :int
+
+      # Socket
+      attach_function :zmq_socket,     [:pointer, :int], :pointer
+      attach_function :zmq_close,      [:pointer], :int
+      attach_function :zmq_bind,       [:pointer, :string], :int
+      attach_function :zmq_connect,    [:pointer, :string], :int
+      attach_function :zmq_disconnect, [:pointer, :string], :int
+      attach_function :zmq_unbind,     [:pointer, :string], :int
+
+      # Message
+      attach_function :zmq_msg_init,      [:pointer], :int
+      attach_function :zmq_msg_init_size, [:pointer, :size_t], :int
+      attach_function :zmq_msg_data,      [:pointer], :pointer
+      attach_function :zmq_msg_size,      [:pointer], :size_t
+      attach_function :zmq_msg_close,     [:pointer], :int
+      attach_function :zmq_msg_send,      [:pointer, :pointer, :int], :int
+      attach_function :zmq_msg_recv,      [:pointer, :pointer, :int], :int
+
+      # Socket options
+      attach_function :zmq_setsockopt, [:pointer, :int, :pointer, :size_t], :int
+      attach_function :zmq_getsockopt, [:pointer, :int, :pointer, :pointer], :int
+
+      # Group membership (RADIO/DISH) — draft API, may not be available
+      begin
+        attach_function :zmq_join,  [:pointer, :string], :int
+        attach_function :zmq_leave, [:pointer, :string], :int
+      rescue ::FFI::NotFoundError
+        # libzmq built without ZMQ_BUILD_DRAFT_API
+      end
+
+
+      # Error
+      attach_function :zmq_errno,    [], :int
+      attach_function :zmq_strerror, [:int], :string
+
+      # Socket types
+      ZMQ_PAIR    = 0
+      ZMQ_PUB     = 1
+      ZMQ_SUB     = 2
+      ZMQ_REQ     = 3
+      ZMQ_REP     = 4
+      ZMQ_DEALER  = 5
+      ZMQ_ROUTER  = 6
+      ZMQ_PULL    = 7
+      ZMQ_PUSH    = 8
+      ZMQ_XPUB    = 9
+      ZMQ_XSUB    = 10
+      ZMQ_SERVER  = 12
+      ZMQ_CLIENT  = 13
+      ZMQ_RADIO   = 14
+      ZMQ_DISH    = 15
+      ZMQ_GATHER  = 16
+      ZMQ_SCATTER = 17
+      ZMQ_PEER    = 19
+      ZMQ_CHANNEL = 20
+
+
+      # Socket type name → constant
+      SOCKET_TYPES = {
+        PAIR: ZMQ_PAIR, PUB: ZMQ_PUB, SUB: ZMQ_SUB,
+        REQ: ZMQ_REQ, REP: ZMQ_REP,
+        DEALER: ZMQ_DEALER, ROUTER: ZMQ_ROUTER,
+        PULL: ZMQ_PULL, PUSH: ZMQ_PUSH,
+        XPUB: ZMQ_XPUB, XSUB: ZMQ_XSUB,
+        SERVER: ZMQ_SERVER, CLIENT: ZMQ_CLIENT,
+        RADIO: ZMQ_RADIO, DISH: ZMQ_DISH,
+        GATHER: ZMQ_GATHER, SCATTER: ZMQ_SCATTER,
+        PEER: ZMQ_PEER, CHANNEL: ZMQ_CHANNEL,
+      }.freeze
+
+      # Send/recv flags
+      ZMQ_DONTWAIT = 1
+      ZMQ_SNDMORE  = 2
+
+
+      # Socket options
+      ZMQ_IDENTITY     = 5
+      ZMQ_SUBSCRIBE    = 6
+      ZMQ_UNSUBSCRIBE  = 7
+      ZMQ_RCVMORE      = 13
+      ZMQ_FD           = 14
+      ZMQ_EVENTS       = 15
+      ZMQ_LINGER       = 17
+      ZMQ_SNDHWM       = 23
+      ZMQ_RCVHWM       = 24
+      ZMQ_RCVTIMEO     = 27
+      ZMQ_SNDTIMEO     = 28
+      ZMQ_MAXMSGSIZE   = 22
+      ZMQ_LAST_ENDPOINT = 32
+      ZMQ_ROUTER_MANDATORY = 33
+      ZMQ_RECONNECT_IVL     = 18
+      ZMQ_RECONNECT_IVL_MAX = 21
+      ZMQ_CONFLATE     = 54
+
+
+      # zmq_msg_t is 64 bytes on all platforms
+      MSG_T_SIZE = 64
+
+
+      # Allocates a zmq_msg_t on the heap.
+      #
+      # @return [FFI::MemoryPointer]
+      #
+      def self.alloc_msg
+        ::FFI::MemoryPointer.new(MSG_T_SIZE)
+      end
+
+
+      # Raises an error with the current zmq_errno message.
+      #
+      def self.check!(rc, label = "zmq")
+        return rc if rc >= 0
+        errno = zmq_errno
+        raise "#{label}: #{zmq_strerror(errno)} (errno #{errno})"
+      end
+    end
+  end
+end

data/lib/omq/ffi.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Load the FFI backend for OMQ.
+#
+# Usage:
+#   require "omq/ffi"
+#   push = OMQ::PUSH.new(backend: :ffi)
+#
+# Raises LoadError if libzmq is not installed.
+
+require_relative "ffi/libzmq"
+require_relative "ffi/engine"

data/lib/omq/peer.rb

@@ -38,7 +38,7 @@ module OMQ
     # @return [self]
     #
     def send_to(routing_id, message)
-      parts = [routing_id.b.freeze, message.b.freeze]
+      parts = [routing_id, message]
       Reactor.run(timeout: @options.write_timeout) { @engine.enqueue_send(parts) }
       self
     end

data/lib/omq/radio_dish.rb

@@ -42,7 +42,7 @@ module OMQ
     # @return [self]
     #
     def publish(group, body)
-      parts = [group.b.freeze, body.b.freeze]
+      parts = [group, body]
       Reactor.run timeout: @options.write_timeout do
         @engine.enqueue_send(parts)
       end

data/lib/omq/readable.rb

@@ -14,7 +14,11 @@ module OMQ
     # @raise [IO::TimeoutError] if read_timeout exceeded
     #
     def receive
-      Reactor.run timeout: @options.read_timeout do |task|
+      if @engine.on_io_thread?
+        Reactor.run(timeout: @options.read_timeout) { @engine.dequeue_recv }
+      elsif (timeout = @options.read_timeout)
+        Async::Task.current.with_timeout(timeout, IO::TimeoutError) { @engine.dequeue_recv }
+      else
         @engine.dequeue_recv
       end
     end

data/lib/omq/routing/channel.rb

@@ -39,7 +39,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       # @raise [RuntimeError] if a connection already exists
       #
       def connection_added(connection)
@@ -48,7 +48,7 @@ module OMQ
 
         @engine.start_recv_pump(connection, @recv_queue)
 
-        unless connection.is_a?(Transport::Inproc::DirectPipe)
+        unless connection.is_a?(Transport::Inproc::Pipe)
           @send_queue = Routing.build_queue(@engine.options.send_hwm, :block)
           while (msg = @staging_queue.dequeue(timeout: 0))
             @send_queue.enqueue(msg)
@@ -58,7 +58,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         if @connection == connection
@@ -72,7 +72,7 @@ module OMQ
       #
       def enqueue(parts)
         conn = @connection
-        if conn.is_a?(Transport::Inproc::DirectPipe) && conn.direct_recv_queue
+        if conn.is_a?(Transport::Inproc::Pipe) && conn.direct_recv_queue
           conn.send_message(parts)
         elsif @send_queue
           @send_queue.enqueue(parts)

data/lib/omq/routing/client.rb

@@ -42,7 +42,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
         @connections << connection
@@ -51,7 +51,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         @connections.delete(connection)

data/lib/omq/routing/conn_send_pump.rb

@@ -12,7 +12,7 @@ module OMQ
       # is torn down with the rest of the connection's pumps.
       #
       # @param engine [Engine]
-      # @param conn [Connection]
+      # @param conn [Protocol::ZMTP::Connection]
       # @param q [Async::LimitedQueue]
       # @return [Async::Task]
       #

data/lib/omq/routing/dealer.rb

@@ -42,7 +42,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
         @engine.start_recv_pump(connection, @recv_queue)
@@ -50,7 +50,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         @connections.delete(connection)

data/lib/omq/routing/dish.rb

@@ -41,7 +41,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
         @connections << connection
@@ -52,7 +52,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         @connections.delete(connection)

data/lib/omq/routing/fan_out.rb

@@ -61,7 +61,7 @@ module OMQ
       # Override in subclasses to expose subscriptions to the
       # application (e.g. XPUB enqueues to recv_queue).
       #
-      # @param conn [Connection]
+      # @param conn [Protocol::ZMTP::Connection]
       # @param prefix [String]
       #
       def on_subscribe(conn, prefix)
@@ -74,7 +74,7 @@ module OMQ
       # Called when a cancel command is received from a peer.
       # Override in subclasses (e.g. XPUB enqueues to recv_queue).
       #
-      # @param conn [Connection]
+      # @param conn [Protocol::ZMTP::Connection]
       # @param prefix [String]
       #
       def on_cancel(conn, prefix)
@@ -86,7 +86,7 @@ module OMQ
       # Creates a per-connection send queue and starts its send pump.
       # Call from #connection_added.
       #
-      # @param conn [Connection]
+      # @param conn [Protocol::ZMTP::Connection]
       #
       def add_fan_out_send_connection(conn)
         q = Routing.build_queue(@engine.options.send_hwm, @engine.options.on_mute)
@@ -99,7 +99,7 @@ module OMQ
       # down by the per-connection lifecycle barrier.
       # Call from #connection_removed.
       #
-      # @param conn [Connection]
+      # @param conn [Protocol::ZMTP::Connection]
       #
       def remove_fan_out_send_connection(conn)
         @subscribe_all.delete(conn)
@@ -152,7 +152,7 @@ module OMQ
       # In conflate mode, drains the batch and keeps only the latest
       # message per topic before writing.
       #
-      # @param conn [Connection]
+      # @param conn [Protocol::ZMTP::Connection]
       # @param q [Async::LimitedQueue, DropQueue]
       #
       def start_conn_send_pump(conn, q)
@@ -169,7 +169,7 @@ module OMQ
       # Send pump variant for non-conflate fan-out: dequeues, batch-drains,
       # writes each subscribed message, then flushes once.
       #
-      # @param conn [Connection]
+      # @param conn [Protocol::ZMTP::Connection]
       # @param q [Async::LimitedQueue, DropQueue]
       # @param use_wire [Boolean] true iff the encoded wire bytes can
       #   be shared across peers (unencrypted ZMTP)
@@ -219,7 +219,7 @@ module OMQ
       # Send pump variant for conflate mode: keeps only the latest
       # subscribed message per batch. Stale duplicates are dropped.
       #
-      # @param conn [Connection]
+      # @param conn [Protocol::ZMTP::Connection]
       # @param q [Async::LimitedQueue, DropQueue]
       # @return [Async::Task]
       #

data/lib/omq/routing/gather.rb

@@ -36,14 +36,14 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
         @engine.start_recv_pump(connection, @recv_queue)
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
       end

data/lib/omq/routing/pair.rb

@@ -43,7 +43,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       # @raise [RuntimeError] if a connection already exists
       #
       def connection_added(connection)
@@ -52,13 +52,13 @@ module OMQ
 
         @engine.start_recv_pump(connection, @recv_queue)
 
-        unless connection.is_a?(Transport::Inproc::DirectPipe)
+        unless connection.is_a?(Transport::Inproc::Pipe)
           start_send_pump(connection)
         end
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         @connection = nil if @connection == connection
@@ -69,7 +69,7 @@ module OMQ
       #
       def enqueue(parts)
         conn = @connection
-        if conn.is_a?(Transport::Inproc::DirectPipe) && conn.direct_recv_queue
+        if conn.is_a?(Transport::Inproc::Pipe) && conn.direct_recv_queue
           conn.send_message(parts)
         else
           @send_queue.enqueue(parts)

data/lib/omq/routing/peer.rb

@@ -50,7 +50,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
         routing_id = SecureRandom.bytes(4)
@@ -65,7 +65,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         routing_id = @routing_id_by_connection.delete(connection)

data/lib/omq/routing/pub.rb

@@ -36,7 +36,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
         @connections << connection
@@ -46,7 +46,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         @connections.delete(connection)

data/lib/omq/routing/pull.rb

@@ -38,14 +38,14 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
         @engine.start_recv_pump(connection, @recv_queue)
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         # recv pump stops on EOFError via its connection barrier

data/lib/omq/routing/push.rb

@@ -33,7 +33,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
         add_round_robin_send_connection(connection)
@@ -41,7 +41,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         @connections.delete(connection)
@@ -64,7 +64,7 @@ module OMQ
       # may succeed if the kernel send buffer absorbs the data.
       #
       def start_reaper(conn)
-        return if conn.is_a?(Transport::Inproc::DirectPipe)
+        return if conn.is_a?(Transport::Inproc::Pipe)
         @engine.spawn_conn_pump_task(conn, annotation: "reaper") do
           conn.receive_message # blocks until peer disconnects; then exits
         end

data/lib/omq/routing/radio.rb

@@ -50,7 +50,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
         @connections << connection
@@ -64,7 +64,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         @connections.delete(connection)

data/lib/omq/routing/rep.rb

@@ -45,7 +45,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
         @engine.start_recv_pump(connection, @recv_queue) do |msg|
@@ -63,7 +63,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         @pending_replies.reject! { |r| r[0] == connection }

data/lib/omq/routing/req.rb

@@ -46,7 +46,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
         @engine.start_recv_pump(connection, @recv_queue) do |msg|
@@ -58,7 +58,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         @connections.delete(connection)

data/lib/omq/routing/round_robin.rb

@@ -48,7 +48,7 @@ module OMQ
       # Registers a connection and starts its send pump.
       # Call from #connection_added.
       #
-      # @param conn [Connection]
+      # @param conn [Protocol::ZMTP::Connection]
       #
       def add_round_robin_send_connection(conn)
         @connections << conn
@@ -63,7 +63,7 @@ module OMQ
       # guarantee, so this is safe. The pump itself is torn down by
       # the per-connection lifecycle barrier.
       #
-      # @param conn [Connection]
+      # @param conn [Protocol::ZMTP::Connection]
       #
       def remove_round_robin_send_connection(conn)
         update_direct_pipe
@@ -73,7 +73,7 @@ module OMQ
       # Updates the direct-pipe shortcut for inproc single-peer bypass.
       #
       def update_direct_pipe
-        if @connections.size == 1 && @connections.first.is_a?(Transport::Inproc::DirectPipe)
+        if @connections.size == 1 && @connections.first.is_a?(Transport::Inproc::Pipe)
           @direct_pipe = @connections.first
         else
           @direct_pipe = nil
@@ -128,7 +128,7 @@ module OMQ
       # run. The yield is effectively free when the scheduler has no
       # other work.
       #
-      # @param conn [Connection]
+      # @param conn [Protocol::ZMTP::Connection]
       #
       def start_conn_send_pump(conn)
         @engine.spawn_conn_pump_task(conn, annotation: "send pump") do

data/lib/omq/routing/router.rb

@@ -45,7 +45,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
         identity = connection.peer_identity
@@ -61,7 +61,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         identity = @identity_by_connection.delete(connection)

data/lib/omq/routing/scatter.rb

@@ -33,16 +33,15 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
-        @connections << connection
         add_round_robin_send_connection(connection)
         start_reaper(connection)
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         @connections.delete(connection)
@@ -63,10 +62,10 @@ module OMQ
       # Detects peer disconnection on write-only sockets by
       # blocking on a receive that only returns on disconnect.
       #
-      # @param conn [Connection]
+      # @param conn [Protocol::ZMTP::Connection]
       #
       def start_reaper(conn)
-        return if conn.is_a?(Transport::Inproc::DirectPipe)
+        return if conn.is_a?(Transport::Inproc::Pipe)
         @engine.spawn_conn_pump_task(conn, annotation: "reaper") do
           conn.receive_message # blocks until peer disconnects; then exits
         end

data/lib/omq/routing/server.rb

@@ -45,7 +45,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
         routing_id = SecureRandom.bytes(4)
@@ -60,7 +60,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         routing_id = @routing_id_by_connection.delete(connection)

data/lib/omq/routing/sub.rb

@@ -41,7 +41,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
         @connections << connection
@@ -54,7 +54,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         @connections.delete(connection)

data/lib/omq/routing/xpub.rb

@@ -41,7 +41,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_added(connection)
         @connections << connection
@@ -51,7 +51,7 @@ module OMQ
       end
 
 
-      # @param connection [Connection]
+      # @param connection [Protocol::ZMTP::Connection]
       #
       def connection_removed(connection)
         @connections.delete(connection)