omq-ractor 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08afc746c52ec650ff7913ac2c58f164b206c547902539949ae2ac1c3e727e45'
-  data.tar.gz: e3ef4264d010e074fabc0076f3ff8fe5f743e940fd07b389b4ab4f84b8db0e17
+  metadata.gz: 15931abc881035b0cac7d80667168cd3dbdd120226178b76725d2fa40260ac5f
+  data.tar.gz: 82c4e9531bb7afc5e471d435fadb068b0e7cbf92b9a8db70a063c7623a9cb5bc
 SHA512:
-  metadata.gz: 9585c7fc0a48b60f5daf61629ba32850945ee8fd07799b6e09e6f4c35810d13950f67a8c1f08ab7ff42c041c93e6225d176755b91a329c120b1dcba6d461f746
-  data.tar.gz: 8a9295ef54bf9edc729d2e0c47593b8cdf11cc10cfb46bba1f8b004bcd28c89f9b809f3ab9577ef12ef75822773a0db44046a2ed751317278146b3c292ba3194
+  metadata.gz: 41ebd53843bb6e69859a6546bc1d6f7926f8e03894c10de1bffdbd2a6d294e282bc1b8c04d735920178ea4b25bdd509d5822fee1979121dc6b307224150785fb
+  data.tar.gz: 7f490382cb90a176d28a1d67e75f4edd5f53b2e10740366d81d49c0f5e73b21e63284ae084b1eb7616a9f54d609d64cc42b2e3ff39738f57e035293f6e8d6963

data/README.md

@@ -1,5 +1,10 @@
 # OMQ::Ractor -- Networked Ractors
 
+[![CI](https://github.com/paddor/omq-ractor/actions/workflows/ci.yml/badge.svg)](https://github.com/paddor/omq-ractor/actions/workflows/ci.yml)
+[![Gem Version](https://img.shields.io/gem/v/omq-ractor?color=e9573f)](https://rubygems.org/gems/omq-ractor)
+[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](LICENSE)
+[![Ruby](https://img.shields.io/badge/Ruby-%3E%3D%204.0-CC342D?logo=ruby&logoColor=white)](https://www.ruby-lang.org)
+
 Ruby Ractors give you true parallelism -- each Ractor gets its own GVL,
 so CPU-bound work runs on separate cores. But they can only talk to each
 other inside a single process, using `Ractor::Port`. No networking, no
@@ -45,8 +50,7 @@ Async do
   worker = OMQ::Ractor.new(pull, push) do |omq|
     pull_p, push_p = omq.sockets  # handshake (must be first call)
 
-    loop do
-      msg = pull_p.receive
+    while msg = pull_p.receive    # nil on close
       push_p << expensive_transform(msg)
     end
   end
@@ -61,25 +65,36 @@ lightweight wrappers around `Ractor::Port` pairs.
 
 ### Multiplexing with Ractor.select
 
+`Ractor.select` waits on multiple `Ractor::Port` objects and returns
+`[port, value]`. Use `#to_port` to get the underlying port, and
+`#socket_for` to map back to the proxy:
+
 ```ruby
 worker = OMQ::Ractor.new(pull_a, pull_b, push) do |omq|
-  a, b, out = omq.sockets
+  sockets = omq.sockets
+  a, b, out = sockets
 
   loop do
-    source, msg = Ractor.select(a.to_port, b.to_port)
-    out << process(msg)
+    port, msg = Ractor.select(a.to_port, b.to_port)
+    break if msg.nil?  # socket closed
+    source = sockets.socket_for(port)  # => a or b
+    out << process(source, msg)
   end
 end
 ```
 
+Note: `Ractor.select` returns raw port values, bypassing `SocketProxy#receive`.
+For topic-based sockets, `msg` will be the full `[topic, payload]` array --
+use `#receive` or `#receive_with_topic` on a single proxy instead if you
+need topic stripping.
+
 ### Bidirectional (PAIR, REQ/REP, DEALER)
 
 ```ruby
 worker = OMQ::Ractor.new(pair) do |omq|
   p = omq.sockets.first
 
-  loop do
-    msg = p.receive
+  while msg = p.receive
     p << transform(msg)
   end
 end
@@ -122,8 +137,7 @@ Async do
 
     OMQ::Ractor.new(pull, push) do |omq|
       p_in, p_out = omq.sockets
-      loop do
-        msg = p_in.receive
+      while msg = p_in.receive
         p_out << expensive_transform(msg)
       end
     end
@@ -160,8 +174,9 @@ Use `serialize: false` for raw messages (frozen string arrays):
 ```ruby
 worker = OMQ::Ractor.new(pull, push, serialize: false) do |omq|
   p_in, p_out = omq.sockets
-  msg = p_in.receive          # frozen string array, e.g. ["hello"]
-  p_out << [msg.first.upcase] # must send frozen string arrays
+  while msg = p_in.receive          # frozen string array, e.g. ["hello"]
+    p_out << [msg.first.upcase]     # must send frozen string arrays
+  end
 end
 ```
 

data/lib/omq/ractor.rb

@@ -230,6 +230,33 @@ module OMQ
     end
 
 
+    # Array of SocketProxy objects with a port→proxy lookup for
+    # Ractor.select results.
+    #
+    class SocketSet < Array
+      def initialize(proxies)
+        super(proxies)
+        @by_port = {}
+        proxies.each do |proxy|
+          @by_port[proxy.to_port] = proxy if proxy.to_port rescue nil
+        end
+      end
+
+      # Returns the SocketProxy whose input port matches +port+.
+      # Use after Ractor.select to map back to the proxy:
+      #
+      #   port, msg = Ractor.select(a.to_port, b.to_port)
+      #   source = sockets.socket_for(port)
+      #
+      # @param port [Ractor::Port]
+      # @return [SocketProxy, nil]
+      #
+      def socket_for(port)
+        @by_port[port]
+      end
+    end
+
+
     # -- Context -------------------------------------------------------
 
     # Frozen, shareable context passed to the worker Ractor.
@@ -252,9 +279,10 @@ module OMQ
 
         @setup_port.send(input_ports)
 
-        @socket_configs.each_with_index.map do |cfg, i|
+        proxies = @socket_configs.each_with_index.map do |cfg, i|
           SocketProxy.new(input_ports[i], @output_ports[i], cfg[:topic_type])
         end
+        SocketSet.new(proxies)
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omq-ractor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Patrik Wenger