omq 0.6.5 → 0.8.0

data/lib/omq/zmtp/routing/router.rb

@@ -35,8 +35,9 @@ module OMQ
           identity = SecureRandom.bytes(5) if identity.nil? || identity.empty?
           @connections_by_identity[identity] = connection
 
-          task = @engine.start_recv_pump(connection, @recv_queue,
-                   transform: ->(msg) { [identity, *msg] })
+          task = @engine.start_recv_pump(connection, @recv_queue) do |msg|
+            [identity, *msg]
+          end
           @tasks << task if task
 
           start_send_pump unless @send_pump_started

data/lib/omq/zmtp/routing/server.rb

@@ -34,8 +34,9 @@ module OMQ
           routing_id = SecureRandom.bytes(4)
           @connections_by_routing_id[routing_id] = connection
 
-          task = @engine.start_recv_pump(connection, @recv_queue,
-                   transform: ->(msg) { [routing_id, *msg] })
+          task = @engine.start_recv_pump(connection, @recv_queue) do |msg|
+            [routing_id, *msg]
+          end
           @tasks << task if task
 
           start_send_pump unless @send_pump_started

data/lib/omq/zmtp.rb

@@ -1,13 +1,26 @@
 # frozen_string_literal: true
 
+require "protocol/zmtp"
+require "io/stream"
+
 module OMQ
   # ZMTP 3.1 protocol internals.
   #
-  # These classes implement the wire protocol, transports, and routing
-  # strategies. They are not part of the public API.
+  # The wire protocol (codec, connection, mechanisms) lives in the
+  # protocol-zmtp gem. This module re-exports those classes under the
+  # OMQ::ZMTP namespace and adds the transport/routing/engine layers.
   #
   module ZMTP
-    require "io/stream"
+    # Re-export protocol-zmtp classes
+    Codec         = Protocol::ZMTP::Codec
+    Connection    = Protocol::ZMTP::Connection
+    ProtocolError = Protocol::ZMTP::Error
+    VALID_PEERS   = Protocol::ZMTP::VALID_PEERS
+
+    module Mechanism
+      Null  = Protocol::ZMTP::Mechanism::Null
+      Curve = Protocol::ZMTP::Mechanism::Curve if defined?(Protocol::ZMTP::Mechanism::Curve)
+    end
 
     # Errors raised when a peer disconnects or resets the connection.
     CONNECTION_LOST = [
@@ -32,24 +45,14 @@ module OMQ
   end
 end
 
-# Constants
-require_relative "zmtp/valid_peers"
-
-# Codec
-require_relative "zmtp/codec"
-
 # Transport
 require_relative "zmtp/transport/inproc"
 require_relative "zmtp/transport/tcp"
 require_relative "zmtp/transport/ipc"
 
-# Mechanisms
-require_relative "zmtp/mechanism/null"
-
 # Core
 require_relative "zmtp/reactor"
 require_relative "zmtp/options"
-require_relative "zmtp/connection"
 require_relative "zmtp/routing"
 require_relative "zmtp/routing/round_robin"
 require_relative "zmtp/routing/fan_out"

data/lib/omq.rb

@@ -17,6 +17,7 @@ module OMQ
   #
   class SocketDeadError < RuntimeError; end
 end
+
 require_relative "omq/zmtp"
 require_relative "omq/socket"
 require_relative "omq/req_rep"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omq
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.8.0
 platform: ruby
 authors:
 - Patrik Wenger
@@ -9,6 +9,20 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: protocol-zmtp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: async
   requirement: !ruby/object:Gem::Requirement
@@ -83,13 +97,7 @@ files:
 - lib/omq/socket.rb
 - lib/omq/version.rb
 - lib/omq/zmtp.rb
-- lib/omq/zmtp/codec.rb
-- lib/omq/zmtp/codec/command.rb
-- lib/omq/zmtp/codec/frame.rb
-- lib/omq/zmtp/codec/greeting.rb
-- lib/omq/zmtp/connection.rb
 - lib/omq/zmtp/engine.rb
-- lib/omq/zmtp/mechanism/null.rb
 - lib/omq/zmtp/options.rb
 - lib/omq/zmtp/reactor.rb
 - lib/omq/zmtp/readable.rb
@@ -119,7 +127,6 @@ files:
 - lib/omq/zmtp/transport/inproc.rb
 - lib/omq/zmtp/transport/ipc.rb
 - lib/omq/zmtp/transport/tcp.rb
-- lib/omq/zmtp/valid_peers.rb
 - lib/omq/zmtp/writable.rb
 homepage: https://github.com/zeromq/omq
 licenses:

data/lib/omq/zmtp/codec/command.rb

@@ -1,210 +0,0 @@
-# frozen_string_literal: true
-
-module OMQ
-  module ZMTP
-    module Codec
-      # ZMTP command encode/decode.
-      #
-      # Command frame body format:
-      #   1 byte:    command name length
-      #   N bytes:   command name
-      #   remaining: command data
-      #
-      # READY command data = property list:
-      #   1 byte:  property name length
-      #   N bytes: property name
-      #   4 bytes: property value length (big-endian)
-      #   N bytes: property value
-      #
-      class Command
-        # @return [String] command name (e.g. "READY", "SUBSCRIBE")
-        #
-        attr_reader :name
-
-        # @return [String] command data (binary)
-        #
-        attr_reader :data
-
-        # @param name [String] command name
-        # @param data [String] command data
-        #
-        def initialize(name, data = "".b)
-          @name = name
-          @data = data.b
-        end
-
-        # Encodes as a command frame body.
-        #
-        # @return [String] binary body (name-length + name + data)
-        #
-        def to_body
-          name_bytes = @name.b
-          name_bytes.bytesize.chr.b + name_bytes + @data
-        end
-
-        # Encodes as a complete command Frame.
-        #
-        # @return [Frame]
-        #
-        def to_frame
-          Frame.new(to_body, command: true)
-        end
-
-        # Decodes a command from a frame body.
-        #
-        # @param body [String] binary frame body
-        # @return [Command]
-        # @raise [ProtocolError] on malformed command
-        #
-        def self.from_body(body)
-          body = body.b
-          raise ProtocolError, "command body too short" if body.bytesize < 1
-
-          name_len = body.getbyte(0)
-
-          raise ProtocolError, "command name truncated" if body.bytesize < 1 + name_len
-
-          name = body.byteslice(1, name_len)
-          data = body.byteslice(1 + name_len..)
-          new(name, data)
-        end
-
-        # Builds a READY command with Socket-Type and Identity properties.
-        #
-        # @param socket_type [String] e.g. "REQ", "REP", "PAIR"
-        # @param identity [String] peer identity (can be empty)
-        # @return [Command]
-        #
-        def self.ready(socket_type:, identity: "")
-          props = encode_properties(
-            "Socket-Type" => socket_type,
-            "Identity"    => identity,
-          )
-          new("READY", props)
-        end
-
-        # Builds a SUBSCRIBE command.
-        #
-        # @param prefix [String] subscription prefix
-        # @return [Command]
-        #
-        def self.subscribe(prefix)
-          new("SUBSCRIBE", prefix.b)
-        end
-
-        # Builds a CANCEL command (unsubscribe).
-        #
-        # @param prefix [String] subscription prefix to cancel
-        # @return [Command]
-        #
-        def self.cancel(prefix)
-          new("CANCEL", prefix.b)
-        end
-
-        # Builds a JOIN command (RADIO/DISH group subscription).
-        #
-        # @param group [String] group name
-        # @return [Command]
-        #
-        def self.join(group)
-          new("JOIN", group.b)
-        end
-
-        # Builds a LEAVE command (RADIO/DISH group unsubscription).
-        #
-        # @param group [String] group name
-        # @return [Command]
-        #
-        def self.leave(group)
-          new("LEAVE", group.b)
-        end
-
-        # Builds a PING command.
-        #
-        # @param ttl [Numeric] time-to-live in seconds (sent as deciseconds)
-        # @param context [String] optional context bytes (up to 16 bytes)
-        # @return [Command]
-        #
-        def self.ping(ttl: 0, context: "".b)
-          ttl_ds = (ttl * 10).to_i
-          new("PING", [ttl_ds].pack("n") + context.b)
-        end
-
-        # Builds a PONG command.
-        #
-        # @param context [String] context bytes from the PING
-        # @return [Command]
-        #
-        def self.pong(context: "".b)
-          new("PONG", context.b)
-        end
-
-        # Extracts TTL (in seconds) and context from a PING command's data.
-        #
-        # @return [Array(Numeric, String)] [ttl_seconds, context_bytes]
-        #
-        def ping_ttl_and_context
-          ttl_ds  = @data.unpack1("n")
-          context = @data.bytesize > 2 ? @data.byteslice(2..) : "".b
-          [ttl_ds / 10.0, context]
-        end
-
-        # Parses READY command data as a property list.
-        #
-        # @return [Hash<String, String>] property name => value
-        # @raise [ProtocolError] on malformed properties
-        #
-        def properties
-          self.class.decode_properties(@data)
-        end
-
-        # Encodes a hash of properties into ZMTP property list format.
-        #
-        # @param props [Hash<String, String>]
-        # @return [String] binary property list
-        #
-        def self.encode_properties(props)
-          parts = props.map do |name, value|
-            name_bytes  = name.b
-            value_bytes = value.b
-            name_bytes.bytesize.chr.b + name_bytes + [value_bytes.bytesize].pack("N") + value_bytes
-          end
-          parts.join
-        end
-
-        # Decodes a ZMTP property list from binary data.
-        #
-        # @param data [String] binary property list
-        # @return [Hash<String, String>] property name => value
-        # @raise [ProtocolError] on malformed properties
-        #
-        def self.decode_properties(data)
-          result = {}
-          offset = 0
-
-          while offset < data.bytesize
-            raise ProtocolError, "property name truncated" if offset + 1 > data.bytesize
-            name_len = data.getbyte(offset)
-            offset += 1
-
-            raise ProtocolError, "property name truncated" if offset + name_len > data.bytesize
-            name = data.byteslice(offset, name_len)
-            offset += name_len
-
-            raise ProtocolError, "property value length truncated" if offset + 4 > data.bytesize
-            value_len = data.byteslice(offset, 4).unpack1("N")
-            offset += 4
-
-            raise ProtocolError, "property value truncated" if offset + value_len > data.bytesize
-            value = data.byteslice(offset, value_len)
-            offset += value_len
-
-            result[name] = value
-          end
-
-          result
-        end
-      end
-    end
-  end
-end

data/lib/omq/zmtp/codec/frame.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-module OMQ
-  module ZMTP
-    module Codec
-      # ZMTP frame encode/decode.
-      #
-      # Wire format:
-      #   Byte 0:   flags (bit 0=MORE, bit 1=LONG, bit 2=COMMAND)
-      #   Next 1-8: size (1-byte if short, 8-byte big-endian if LONG)
-      #   Next N:   body
-      #
-      class Frame
-        FLAGS_MORE    = 0x01
-        FLAGS_LONG    = 0x02
-        FLAGS_COMMAND = 0x04
-
-        # Short frame: 1-byte size, max body 255 bytes.
-        #
-        SHORT_MAX = 255
-
-        # @return [String] frame body (binary)
-        #
-        attr_reader :body
-
-        # @param body [String] frame body
-        # @param more [Boolean] more frames follow
-        # @param command [Boolean] this is a command frame
-        #
-        def initialize(body, more: false, command: false)
-          @body    = body.b
-          @more    = more
-          @command = command
-        end
-
-        # @return [Boolean] true if more frames follow in this message
-        #
-        def more?    = @more
-
-        # @return [Boolean] true if this is a command frame
-        #
-        def command? = @command
-
-        # Encodes to wire bytes.
-        #
-        # @return [String] binary wire representation (flags + size + body)
-        #
-        def to_wire
-          size  = @body.bytesize
-          flags = 0
-          flags |= FLAGS_MORE if @more
-          flags |= FLAGS_COMMAND if @command
-
-          if size > SHORT_MAX
-            (flags | FLAGS_LONG).chr.b + [size].pack("Q>") + @body
-          else
-            flags.chr.b + size.chr.b + @body
-          end
-        end
-
-        # Reads one frame from an IO-like object.
-        #
-        # @param io [#read_exactly] must support read_exactly(n)
-        # @return [Frame]
-        # @raise [ProtocolError] on invalid frame
-        # @raise [EOFError] if the connection is closed
-        #
-        def self.read_from(io)
-          flags = io.read_exactly(1).getbyte(0)
-
-          more    = (flags & FLAGS_MORE) != 0
-          long    = (flags & FLAGS_LONG) != 0
-          command = (flags & FLAGS_COMMAND) != 0
-
-          size = if long
-                   io.read_exactly(8).unpack1("Q>")
-                 else
-                   io.read_exactly(1).getbyte(0)
-                 end
-
-          body = size > 0 ? io.read_exactly(size) : "".b
-
-          new(body, more: more, command: command)
-        end
-
-      end
-    end
-  end
-end

data/lib/omq/zmtp/codec/greeting.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-module OMQ
-  module ZMTP
-    module Codec
-      # ZMTP 3.1 greeting encode/decode.
-      #
-      # The greeting is always exactly 64 bytes:
-      #   Offset  Bytes  Field
-      #   0       1      0xFF (signature start)
-      #   1-8     8      0x00 padding
-      #   9       1      0x7F (signature end)
-      #   10      1      major version
-      #   11      1      minor version
-      #   12-31   20     mechanism (null-padded ASCII)
-      #   32      1      as-server flag (0x00 or 0x01)
-      #   33-63   31     filler (0x00)
-      #
-      module Greeting
-        SIZE             = 64
-        SIGNATURE_START  = 0xFF
-        SIGNATURE_END    = 0x7F
-        VERSION_MAJOR    = 3
-        VERSION_MINOR    = 1
-        MECHANISM_OFFSET = 12
-        MECHANISM_LENGTH = 20
-        AS_SERVER_OFFSET = 32
-
-        # Encodes a ZMTP 3.1 greeting.
-        #
-        # @param mechanism [String] security mechanism name (e.g. "NULL")
-        # @param as_server [Boolean] whether this peer is the server
-        # @return [String] 64-byte binary greeting
-        #
-        def self.encode(mechanism: "NULL", as_server: false)
-          buf = "\xFF".b + ("\x00" * 8) + "\x7F".b
-          buf << [VERSION_MAJOR, VERSION_MINOR].pack("CC")
-          buf << mechanism.b.ljust(MECHANISM_LENGTH, "\x00")
-          buf << (as_server ? "\x01" : "\x00")
-          buf << ("\x00" * 31)
-        end
-
-        # Decodes a ZMTP greeting.
-        #
-        # @param data [String] 64-byte binary greeting
-        # @return [Hash] { major:, minor:, mechanism:, as_server: }
-        # @raise [ProtocolError] on invalid greeting
-        #
-        def self.decode(data)
-          raise ProtocolError, "greeting too short (#{data.bytesize} bytes)" if data.bytesize < SIZE
-
-          data = data.b
-
-          unless data.getbyte(0) == SIGNATURE_START && data.getbyte(9) == SIGNATURE_END
-            raise ProtocolError, "invalid greeting signature"
-          end
-
-          major = data.getbyte(10)
-          minor = data.getbyte(11)
-
-          unless major >= 3
-            raise ProtocolError, "unsupported ZMTP version #{major}.#{minor} (need >= 3.0)"
-          end
-
-          mechanism = data.byteslice(MECHANISM_OFFSET, MECHANISM_LENGTH).delete("\x00")
-          as_server = data.getbyte(AS_SERVER_OFFSET) == 1
-
-          {
-            major:     major,
-            minor:     minor,
-            mechanism: mechanism,
-            as_server: as_server,
-          }
-        end
-      end
-    end
-  end
-end

data/lib/omq/zmtp/codec.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module OMQ
-  module ZMTP
-    # ZMTP 3.1 wire protocol codec.
-    #
-    module Codec
-    end
-
-    # Raised on ZMTP protocol violations.
-    #
-    class ProtocolError < RuntimeError; end
-  end
-end
-
-require_relative "codec/greeting"
-require_relative "codec/frame"
-require_relative "codec/command"