omq 0.5.1 → 0.6.1

data/lib/omq/socket.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "forwardable"
+
 module OMQ
   # Socket base class.
   #
@@ -8,32 +10,34 @@ module OMQ
     #
     attr_reader :options
 
+
     # @return [Integer, nil] last auto-selected TCP port
     #
     attr_reader :last_tcp_port
 
+
     # Delegate socket option accessors to @options.
     #
-    %i[
-      send_hwm                send_hwm=
-      recv_hwm                recv_hwm=
-      linger                  linger=
-      identity                identity=
-      recv_timeout            recv_timeout=
-      send_timeout            send_timeout=
-      read_timeout            read_timeout=
-      write_timeout           write_timeout=
-      router_mandatory        router_mandatory=
-      router_mandatory?
-      reconnect_interval      reconnect_interval=
-      heartbeat_interval      heartbeat_interval=
-      heartbeat_ttl           heartbeat_ttl=
-      heartbeat_timeout       heartbeat_timeout=
-      max_message_size        max_message_size=
-      mechanism               mechanism=
-    ].each do |method|
-      define_method(method) { |*args| @options.public_send(method, *args) }
-    end
+    extend Forwardable
+
+    def_delegators :@options,
+      :send_hwm,              :send_hwm=,
+      :recv_hwm,              :recv_hwm=,
+      :linger,                :linger=,
+      :identity,              :identity=,
+      :recv_timeout,          :recv_timeout=,
+      :send_timeout,          :send_timeout=,
+      :read_timeout,          :read_timeout=,
+      :write_timeout,         :write_timeout=,
+      :router_mandatory,      :router_mandatory=,
+      :router_mandatory?,
+      :reconnect_interval,    :reconnect_interval=,
+      :heartbeat_interval,    :heartbeat_interval=,
+      :heartbeat_ttl,         :heartbeat_ttl=,
+      :heartbeat_timeout,     :heartbeat_timeout=,
+      :max_message_size,      :max_message_size=,
+      :mechanism,             :mechanism=
+
 
     # Creates a new socket and binds it to the given endpoint.
     #
@@ -45,6 +49,7 @@ module OMQ
       new(nil, **opts).tap { |s| s.bind(endpoint) }
     end
 
+
     # Creates a new socket and connects it to the given endpoint.
     #
     # @param endpoint [String]
@@ -55,8 +60,10 @@ module OMQ
       new(nil, **opts).tap { |s| s.connect(endpoint) }
     end
 
+
     def initialize(endpoints = nil, linger: 0); end
 
+
     # Binds to an endpoint.
     #
     # @param endpoint [String]
@@ -67,6 +74,7 @@ module OMQ
       @last_tcp_port = @engine.last_tcp_port
     end
 
+
     # Connects to an endpoint.
     #
     # @param endpoint [String]
@@ -76,6 +84,7 @@ module OMQ
       @engine.connect(endpoint)
     end
 
+
     # Disconnects from an endpoint.
     #
     # @param endpoint [String]
@@ -85,6 +94,7 @@ module OMQ
       @engine.disconnect(endpoint)
     end
 
+
     # Unbinds from an endpoint.
     #
     # @param endpoint [String]
@@ -94,21 +104,52 @@ module OMQ
       @engine.unbind(endpoint)
     end
 
+
     # @return [String, nil] last bound endpoint
     #
     def last_endpoint
       @engine.last_endpoint
     end
 
-    # Closes the socket.
+
+    # @return [Async::Promise] resolves when first peer completes handshake
+    def peer_connected   = @engine.peer_connected
+
+
+    # @return [Async::Promise] resolves when first subscriber joins (PUB/XPUB only)
+    def subscriber_joined = @engine.routing.subscriber_joined
+
+
+    # @return [Async::Promise] resolves when all peers disconnect (after having had peers)
+    def all_peers_gone   = @engine.all_peers_gone
+
+
+    # @return [Integer] current number of peer connections
+    def connection_count = @engine.connections.size
+
+
+    # Signals end-of-stream on the receive side. A subsequent
+    # +#receive+ call that would otherwise block returns +nil+.
     #
-    # @return [void]
+    def close_read
+      @engine.dequeue_recv_sentinel
+    end
+
+
+    # Disable auto-reconnect for connected endpoints.
+    def reconnect_enabled=(val)
+      @engine.reconnect_enabled = val
+    end
+
+
+    # Closes the socket.
     #
     def close
       @engine.close
       nil
     end
 
+
     # Set socket to use unbounded pipes (HWM=0).
     #
     def set_unbounded
@@ -117,14 +158,17 @@ module OMQ
       nil
     end
 
+
     # @return [String]
     #
     def inspect
       format("#<%s last_endpoint=%p>", self.class, last_endpoint)
     end
 
+
     private
 
+
     # Runs a block with a timeout. Uses Async's with_timeout if inside
     # a reactor, otherwise falls back to Timeout.timeout.
     #
@@ -142,6 +186,7 @@ module OMQ
       raise IO::TimeoutError, "timed out"
     end
 
+
     # Connects or binds based on endpoint prefix convention.
     #
     # @param endpoints [String, nil]
@@ -159,18 +204,20 @@ module OMQ
       end
     end
 
+
     # Initializes engine and options for a socket type.
     #
     # @param socket_type [Symbol]
     # @param linger [Integer]
     #
     def _init_engine(socket_type, linger:, send_hwm: nil, recv_hwm: nil,
-                     send_timeout: nil, recv_timeout: nil)
+                     send_timeout: nil, recv_timeout: nil, conflate: false)
       @options = ZMTP::Options.new(linger: linger)
-      @options.send_hwm     = send_hwm     if send_hwm
-      @options.recv_hwm     = recv_hwm     if recv_hwm
-      @options.send_timeout  = send_timeout if send_timeout
-      @options.recv_timeout  = recv_timeout if recv_timeout
+      @options.send_hwm      = send_hwm     if send_hwm
+      @options.recv_hwm      = recv_hwm     if recv_hwm
+      @options.send_timeout   = send_timeout if send_timeout
+      @options.recv_timeout   = recv_timeout if recv_timeout
+      @options.conflate       = conflate
       @engine  = ZMTP::Engine.new(socket_type, @options)
     end
   end

data/lib/omq/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OMQ
-  VERSION = "0.5.1"
+  VERSION = "0.6.1"
 end

data/lib/omq/zmtp/connection.rb

@@ -13,14 +13,17 @@ module OMQ
       #
       attr_reader :peer_socket_type
 
+
       # @return [String] peer's identity (from READY handshake)
       #
       attr_reader :peer_identity
 
+
       # @return [Object] transport IO (#read, #write, #close)
       #
       attr_reader :io
 
+
       # @param io [#read, #write, #close] transport IO
       # @param socket_type [String] our socket type name (e.g. "REQ")
       # @param identity [String] our identity
@@ -51,6 +54,7 @@ module OMQ
         @max_message_size    = max_message_size
       end
 
+
       # Performs the full ZMTP handshake via the configured mechanism.
       #
       # @return [void]
@@ -77,6 +81,7 @@ module OMQ
         end
       end
 
+
       # Sends a multi-frame message (write + flush).
       #
       # @param parts [Array<String>] message frames
@@ -89,6 +94,7 @@ module OMQ
         end
       end
 
+
       # Writes a multi-frame message to the buffer without flushing.
       # Call {#flush} after batching writes.
       #
@@ -101,6 +107,7 @@ module OMQ
         end
       end
 
+
       # Flushes the write buffer to the underlying IO.
       #
       # @return [void]
@@ -111,6 +118,7 @@ module OMQ
         end
       end
 
+
       # Receives a multi-frame message.
       # PING/PONG commands are handled automatically by #read_frame.
       #
@@ -125,12 +133,13 @@ module OMQ
             yield frame if block_given?
             next
           end
-          frames << frame.body
+          frames << frame.body.freeze
           break unless frame.more?
         end
-        frames
+        frames.freeze
       end
 
+
       # Starts the heartbeat sender task. Call after handshake.
       #
       # @return [#stop, nil] the heartbeat task, or nil if disabled
@@ -138,7 +147,7 @@ module OMQ
       def start_heartbeat
         return nil unless @heartbeat_interval
         @last_received_at = monotonic_now
-        @heartbeat_task = Reactor.spawn_pump do
+        @heartbeat_task = Reactor.spawn_pump(annotation: "heartbeat") do
           loop do
             sleep @heartbeat_interval
             # Send PING with TTL
@@ -160,6 +169,7 @@ module OMQ
         end
       end
 
+
       # Sends a command.
       #
       # @param command [Codec::Command]
@@ -176,6 +186,7 @@ module OMQ
         end
       end
 
+
       # Reads one frame from the wire. Handles PING/PONG automatically.
       # When using an encrypted mechanism, MESSAGE commands are decrypted
       # back to ZMTP frames transparently.
@@ -215,6 +226,7 @@ module OMQ
         end
       end
 
+
       # Closes the connection.
       #
       # @return [void]
@@ -226,8 +238,14 @@ module OMQ
         # already closed
       end
 
+
       private
 
+
+      # Writes message parts as ZMTP frames, encrypting if needed.
+      #
+      # @param parts [Array<String>] message frames
+      #
       def write_frames(parts)
         parts.each_with_index do |part, i|
           more = i < parts.size - 1
@@ -239,14 +257,17 @@ module OMQ
         end
       end
 
+
       def touch_heartbeat
         @last_received_at = monotonic_now if @heartbeat_interval
       end
 
+
       def monotonic_now
         Async::Clock.now
       end
 
+
       # Sends one frame to the wire.
       #
       # @param frame [Codec::Frame]