omq-rfc-p2p 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15ad54bfc9669cc2110eab224a4ed6fdcd4027dbf433f36714833c407762bae1
+  data.tar.gz: 91d6a39b4023ad98bfa5c55c727640ea6a1a513694908bf0d1f08c21aa81ed45
+SHA512:
+  metadata.gz: 75284f283dfb5180ac99d36a246126ea1cf935e15c3f48fed2bed6ba6a1bedebf99f11efc5b2e228d85128609e7a5a96e644eceb55d53965c79ce64853e60a11
+  data.tar.gz: c2829e5c3ddc37e9fc6afb9d3035e728d30f7252374c8ee536061943d8ed31219842876b30c04340b199ebf6899b80aa941956bfe8d3f43d2a61901ed65312fc

data/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2025-2026, Patrik Wenger
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# OMQ::PEER
+
+[![CI](https://github.com/paddor/omq-rfc-p2p/actions/workflows/ci.yml/badge.svg)](https://github.com/paddor/omq-rfc-p2p/actions/workflows/ci.yml)
+[![Gem Version](https://img.shields.io/gem/v/omq-rfc-p2p?color=e9573f)](https://rubygems.org/gems/omq-rfc-p2p)
+[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](LICENSE)
+[![Ruby](https://img.shields.io/badge/Ruby-%3E%3D%203.3-CC342D?logo=ruby&logoColor=white)](https://www.ruby-lang.org)
+
+PEER socket type ([RFC 51](https://rfc.zeromq.org/spec/51/)) for
+[OMQ](https://github.com/paddor/omq).
+
+True peer-to-peer messaging. Each PEER can both bind and connect,
+routing by 4-byte connection ID.
+
+## Usage
+
+```ruby
+require "omq"
+require "omq/rfc/p2p"
+
+peer1 = OMQ::PEER.bind("tcp://127.0.0.1:5555")
+peer2 = OMQ::PEER.connect("tcp://127.0.0.1:5555")
+
+peer2 << "hello from peer2"
+msg, routing_id = peer1.receive_with_routing_id
+peer1.send_to(routing_id, "hello back")
+```
+
+## Installation
+
+```ruby
+gem "omq-rfc-p2p"
+```
+
+Requires `omq >= 0.12`.
+
+## License
+
+[ISC](LICENSE)

data/lib/omq/peer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module OMQ
+  # Bidirectional multi-peer socket with routing IDs (ZeroMQ RFC 51).
+  #
+  # Each connected peer is assigned a 4-byte routing ID. Supports
+  # directed sends via #send_to and fair-queued receives.
+  class PEER < Socket
+    include Readable
+    include Writable
+    include SingleFrame
+
+    # Creates a new PEER socket.
+    #
+    # @param endpoints [String, Array<String>, nil] endpoint(s) to connect to
+    # @param linger [Integer] linger period in milliseconds
+    # @param backend [Object, nil] optional transport backend
+    def initialize(endpoints = nil, linger: 0, backend: nil)
+      _init_engine(:PEER, linger: linger, backend: backend)
+      _attach(endpoints, default: :connect)
+    end
+
+
+    # Sends a message to a specific peer by routing ID.
+    #
+    # @param routing_id [String] 4-byte routing ID
+    # @param message [String] message body
+    # @return [self]
+    #
+    def send_to(routing_id, message)
+      parts = [routing_id.b.freeze, message.b.freeze]
+      with_timeout(@options.write_timeout) { @engine.enqueue_send(parts) }
+      self
+    end
+  end
+end

data/lib/omq/rfc/p2p/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module OMQ
+  module RFC
+    # PEER socket type extension (ZeroMQ RFC 51).
+    module P2P
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/omq/rfc/p2p.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# OMQ PEER socket type (ZeroMQ RFC 51).
+#
+# Usage:
+#   require "omq/rfc/p2p"
+#
+#   a = OMQ::PEER.bind("tcp://127.0.0.1:5555")
+#   b = OMQ::PEER.connect("tcp://127.0.0.1:5555")
+
+require "omq"
+
+require_relative "p2p/version"
+require_relative "../single_frame"
+require_relative "../routing/peer"
+require_relative "../peer"
+
+OMQ::Routing.register(:PEER, OMQ::Routing::Peer)

data/lib/omq/routing/peer.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+module OMQ
+  module Routing
+    # PEER socket routing: bidirectional multi-peer with auto-generated
+    # 4-byte routing IDs.
+    #
+    # Prepends routing ID on receive. Strips routing ID on send and
+    # routes to the identified connection.
+    #
+    class Peer
+      include FairRecv
+
+      # @param engine [Engine]
+      #
+      def initialize(engine)
+        @engine                     = engine
+        @recv_queue                 = FairQueue.new
+        @connections_by_routing_id  = {}
+        @routing_id_by_connection   = {}
+        @conn_queues                = {}
+        @conn_send_tasks            = {}
+        @tasks                      = []
+      end
+
+
+      # @return [FairQueue]
+      #
+      attr_reader :recv_queue
+
+      # @param connection [Connection]
+      #
+      def connection_added(connection)
+        routing_id = SecureRandom.bytes(4)
+        @connections_by_routing_id[routing_id] = connection
+        @routing_id_by_connection[connection]  = routing_id
+
+        add_fair_recv_connection(connection) { |msg| [routing_id, *msg] }
+
+        q = Routing.build_queue(@engine.options.send_hwm, :block)
+        @conn_queues[connection] = q
+        @conn_send_tasks[connection] = ConnSendPump.start(@engine, connection, q, @tasks)
+      end
+
+
+      # @param connection [Connection]
+      #
+      def connection_removed(connection)
+        routing_id = @routing_id_by_connection.delete(connection)
+        @connections_by_routing_id.delete(routing_id) if routing_id
+        @recv_queue.remove_queue(connection)
+        @conn_queues.delete(connection)
+        @conn_send_tasks.delete(connection)&.stop
+      end
+
+
+      # @param parts [Array<String>]
+      #
+      def enqueue(parts)
+        routing_id = parts.first
+        conn = @connections_by_routing_id[routing_id]
+        return unless conn
+        @conn_queues[conn]&.enqueue(parts[1..])
+      end
+
+
+      # Stops all background tasks (send pumps).
+      def stop
+        @tasks.each(&:stop)
+        @tasks.clear
+      end
+
+
+      # True when all per-connection send queues are empty.
+      #
+      def send_queues_drained?
+        @conn_queues.values.all?(&:empty?)
+      end
+    end
+  end
+end

data/lib/omq/single_frame.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OMQ
+  # Mixin that rejects multipart messages.
+  #
+  # All draft socket types (CLIENT, SERVER, RADIO, DISH, SCATTER,
+  # GATHER, PEER, CHANNEL) require single-frame messages for
+  # thread-safe atomic operations.
+  #
+  module SingleFrame
+    # Sends a message, rejecting multipart messages.
+    #
+    # @param message [String, Array<String>] message to send (must be single-frame)
+    # @raise [ArgumentError] if a multipart message is provided
+    # @return [void]
+    def send(message)
+      if message.is_a?(Array) && message.size > 1
+        raise ArgumentError, "#{self.class} does not support multipart messages"
+      end
+      super
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: omq-rfc-p2p
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Patrik Wenger
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: PEER socket type implementing ZeroMQ RFC 51 for the OMQ pure-Ruby ZeroMQ
+  library.
+email:
+- paddor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/omq/peer.rb
+- lib/omq/rfc/p2p.rb
+- lib/omq/rfc/p2p/version.rb
+- lib/omq/routing/peer.rb
+- lib/omq/single_frame.rb
+homepage: https://github.com/paddor/omq-rfc-p2p
+licenses:
+- ISC
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: ZMQ PEER socket type (RFC 51) for OMQ
+test_files: []