ori-rb 0.4.7 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 958209a6ea858a765a4f3f642d195cdca3e7bfc9c760d3761403d01fdac6ef33
-  data.tar.gz: bf4787b1c567aa2749ca6e72d572218c7e613751122e8d1440ee5102e7c92b7c
+  metadata.gz: 275fec2a2a0a918b10e34443cd062b7d70bdbedabb55d4b6ecb33de40c4ab20a
+  data.tar.gz: d17b29ea758c370e790feded2cd97000a7d8d2b63f58a4157b2a1cff6b59d3a3
 SHA512:
-  metadata.gz: 64a8f68cfdbccd65ab1d7553f92784ca55f46ab74c9ea3b6d3eadae1e3720b75aecec468a412d47a5f8e448946bf4c270280205b2a9368bb77d62d042a7993b7
-  data.tar.gz: 7c95388c4077a57fe10dd8d474c985703ac551e3daf7806afa3e9de28e5c905cc668d826429b84d186686f84917c77801e2ee678776d96ee61bb94fecaca45ac
+  metadata.gz: 41975ccf93c63dc710021d5fc9823e293af37197ef9d163aa369236c0f4f9948ea8c28aba679cbdcd1176d3caffd00ed662f80f38c32521f7e020e5b390a99f4
+  data.tar.gz: e9000159fddf3054c49096a3e885a16df864e405348c97d4a74f6305ddd25c0a46d01e15fda81bb5026c1e3f288e5b1c5f00bc0a4b552f72aee8c9ad44524451

data/README.md

@@ -19,6 +19,7 @@ Ori provides a set of primitives that allow you to build concurrent applications
     - [`Ori::Mutex`](#orimutex)
     - [`Ori::Semaphore`](#orisemaphore)
     - [`Ori::Timeout`](#oritimeout)
+    - [`Ori::Broadcast`](#oribroadcast)
 - [Releases](#releases)
 - [License](#license)
 
@@ -428,6 +429,67 @@ Timeout!
 
 </details>
 
+#### `Ori::Broadcast`
+
+Broadcast provides fan-out message delivery to multiple subscribers. Unlike a `Channel`, where each message is consumed by a single reader, every subscriber to a `Broadcast` receives every message published after they subscribe:
+
+```ruby
+Ori.sync do |scope|
+  broadcast = Ori::Broadcast.new
+  sub1 = broadcast.subscribe
+  sub2 = broadcast.subscribe
+
+  # Publisher
+  scope.fork do
+    broadcast << "Hello"
+    broadcast << "World"
+  end
+
+  # Both subscribers receive all messages
+  scope.fork do
+    2.times { puts "Sub 1: #{sub1.take}" }
+  end
+
+  scope.fork do
+    2.times { puts "Sub 2: #{sub2.take}" }
+  end
+end
+```
+
+**Output:**
+
+```
+Sub 1: Hello
+Sub 2: Hello
+Sub 1: World
+Sub 2: World
+```
+
+Subscriptions work with `Ori.select` and pattern matching:
+
+```ruby
+Ori.sync do |scope|
+  broadcast = Ori::Broadcast.new
+  sub = broadcast.subscribe
+  timeout = Ori::Timeout.new(0.5)
+
+  scope.fork { broadcast << :event }
+
+  case Ori.select([sub, timeout])
+  in Ori::Broadcast::Subscription(value) then puts "Got: #{value}"
+  in Ori::Timeout then puts "No events"
+  end
+end
+```
+
+Subscribers can unsubscribe at any time to stop receiving future messages:
+
+```ruby
+sub = broadcast.subscribe
+# ...
+sub.unsubscribe
+```
+
 ## Releases
 
 The procedure to publish a new release version is as follows:

data/lib/ori/broadcast.rb

@@ -0,0 +1,79 @@
+# typed: true
+
+module Ori
+  #: [E]
+  class Broadcast
+    def initialize
+      @subscriptions = [] #: Array[Subscription[E]]
+    end
+
+    #: () -> Subscription[E]
+    def subscribe
+      subscription = Subscription.new(self)
+      @subscriptions << subscription
+      subscription
+    end
+
+    #: (Subscription[E] subscription) -> void
+    def unsubscribe(subscription)
+      @subscriptions.delete(subscription)
+    end
+
+    #: (E item) -> void
+    def publish(item)
+      @subscriptions.each { |sub| sub.__send_item(item) }
+    end
+    alias_method(:<<, :publish)
+
+    #: [E]
+    class Subscription
+      include(Ori::Selectable)
+
+      #: (Broadcast[E] broadcast) -> void
+      def initialize(broadcast)
+        @broadcast = broadcast
+        @queue = [] #: Array[E]
+      end
+
+      #: () -> E
+      def take
+        Fiber.yield(self) until value?
+        @queue.shift #: as E
+      end
+
+      #: () -> E
+      def peek
+        Fiber.yield(self) until value?
+        @queue.first #: as E
+      end
+
+      #: () -> bool
+      def value?
+        !@queue.empty?
+      end
+
+      #: () -> Subscription[E]
+      def await
+        peek
+        self
+      end
+
+      #: () -> Array[E]
+      def deconstruct
+        Ori.sync { peek }
+        [take]
+      end
+
+      #: () -> void
+      def unsubscribe
+        @broadcast.unsubscribe(self)
+      end
+
+      # @api private
+      #: (E item) -> void
+      def __send_item(item)
+        @queue << item
+      end
+    end
+  end
+end

data/lib/ori/scope.rb

@@ -457,7 +457,7 @@ module Ori
       # TODO: shuffle blocked before processing?
       blocked.each do |fiber, resource|
         case resource
-        when Ori::Channel
+        when Ori::Channel, Ori::Broadcast::Subscription
           fibers_to_resume << fiber if resource.value?
         when Ori::Promise
           fibers_to_resume << fiber if resource.resolved?
@@ -621,7 +621,7 @@ module Ori
         when CancellationError
           @tracer&.record(id, :cancelled, result.message)
           task_or_fiber.kill
-        when Ori::Channel, Ori::Promise, Ori::Semaphore, Ori::ReentrantSemaphore
+        when Ori::Channel, Ori::Promise, Ori::Semaphore, Ori::ReentrantSemaphore, Ori::Broadcast::Subscription
           @tracer&.record(id, :resource_wait, result.class.name)
           blocked[fiber] = result
         when Task

data/lib/ori/version.rb

@@ -1,5 +1,5 @@
 # typed: strict
 
 module Ori
-  VERSION = "0.4.7"
+  VERSION = "0.4.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ori-rb
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors:
 - Jahfer Husain
@@ -63,6 +63,7 @@ files:
 - docs/images/example_trace.png
 - docs/images/example_trace_tag.png
 - lib/ori.rb
+- lib/ori/broadcast.rb
 - lib/ori/channel.rb
 - lib/ori/lazy.rb
 - lib/ori/mutex.rb