local_bus 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa03fc7b7c1f5e14bff852435b75e343f150ceee9b5f9638ce365918bc39c939
-  data.tar.gz: 1aa8d5ffa9895245ff78f1b00c2d4f3697a1183afe82dc4bcd3d7c420453e924
+  metadata.gz: f435ed1460835bdd4b50311c366c158f4dda0381038368cd325a13c8ceace3b9
+  data.tar.gz: 937b58aa97ed2e9ca2f65eb02b6c401f9e93c4d590aff5966816dd6dd47be8a9
 SHA512:
-  metadata.gz: 6e17c54a44652eac0c7edb7715a1db68507a0b82b4c3acdd9bfbc4e41d5741b5b80965d623be8e369c4080e43a0cb8696431d6464588655ecc863c47d8bf81e6
-  data.tar.gz: 57fbbe8719669a3dbee59252c2d71ce20c1ce232110779ffa9bf8fa4c68e7da1b59cb9fb916d308c7e8d21e499117eb74b4a5e464db2c0eab2866e53855d9c12
+  metadata.gz: 74828920b50a51ae3fc00583dee61657d88cadd62482172fc34c1e54e935a652306716242c9152d6a5f35e9660f6d52930c6840966dc281f158c391666588cf7
+  data.tar.gz: d7c86027a16144325f3ea4cd3e65f41ea55a56ac6b75e309a75a5397cd7042372002783948f64b6e76d3cdbb0200a1cd0b62be3ec8c632b3639c5c33b0a42a76

data/README.md

@@ -30,22 +30,23 @@ LocalBus is a lightweight pub/sub system for Ruby that helps organize and simpli
 
 ## Table of Contents
 
-- [Why LocalBus?](#why-localbus)
-- [Installation](#installation)
-- [Quick Start](#quick-start)
-  - [Interfaces](#interfaces)
-  - [Bus (immediate processing)](#bus-immediate-processing)
-  - [Station (background processing)](#station-background-processing)
-- [Advanced Usage & Considerations](#advanced-usage--considerations)
-  - [Concurrency Controls](#concurrency-controls)
-    - [Bus Interface (Async)](#bus-interface-async)
-    - [Station Interface (Thread Pool)](#station-interface-thread-pool)
-  - [Error Handling & Recovery](#error-handling--recovery)
-  - [Memory Considerations](#memory-considerations)
-  - [Blocking Operations](#blocking-operations)
-  - [Shutdown & Cleanup](#shutdown--cleanup)
-  - [Limitations](#limitations)
-- [Sponsors](#sponsors)
+  - [Why LocalBus?](#why-localbus)
+  - [Installation](#installation)
+  - [Quick Start](#quick-start)
+    - [Interfaces](#interfaces)
+    - [Bus (immediate processing)](#bus-immediate-processing)
+    - [Station (background processing)](#station-background-processing)
+  - [Advanced Usage & Considerations](#advanced-usage--considerations)
+    - [Concurrency Controls](#concurrency-controls)
+      - [Bus Interface (Async)](#bus-interface-async)
+      - [Station Interface (Thread Pool)](#station-interface-thread-pool)
+    - [Error Handling & Recovery](#error-handling--recovery)
+    - [Memory Considerations](#memory-considerations)
+    - [Blocking Operations](#blocking-operations)
+    - [Shutdown & Cleanup](#shutdown--cleanup)
+    - [Limitations](#limitations)
+  - [See Also](#see-also)
+  - [Sponsors](#sponsors)
 
 <!-- Tocer[finish]: Auto-generated, don't remove. -->
 
@@ -184,7 +185,7 @@ The Bus interface uses Async's Semaphore to limit resource consumption:
 
 ```ruby
 # Configure concurrency limits for the Bus
-bus = LocalBus::Bus.new(concurrency_limit: 10)
+bus = LocalBus::Bus.new(max_concurrency: 10)
 
 # The semaphore ensures only N concurrent operations run at once
 bus.subscribe "resource.intensive" do |message|
@@ -193,7 +194,7 @@ bus.subscribe "resource.intensive" do |message|
 end
 ```
 
-When the concurrency limit is reached, new publish operations will wait until a slot becomes available. This prevents memory bloat but means you should be mindful of timeouts in your subscribers.
+When the max concurrency limit is reached, new publish operations will wait until a slot becomes available. This prevents memory bloat but means you should be mindful of timeouts in your subscribers.
 
 #### Station Interface (Thread Pool)
 
@@ -203,7 +204,7 @@ The Station interface uses Concurrent Ruby's fixed thread pool with a fallback p
 # Configure the thread pool size for the Station
 station = LocalBus::Station.new(
   max_queue: 5_000, # Maximum number of queued items
-  threads: 10, # Maximum pool size
+  max_threads: 10, # Maximum pool size
   fallback_policy: :caller_runs # Runs on calling thread
 )
 ```
@@ -275,7 +276,7 @@ For example, idempotency _(i.e. messages that can be re-published without uninte
 
 - The Bus interface is single-threaded - long-running subscribers can impact latency
 - The Station interface may drop messages if configured with `:discard` fallback policy
-- No persistence - pending messages are lost on process restart
+- No persistence - pending messages may be lost on process restart
 - No distributed support - communication limited to single process
 - Large payloads can impact memory usage, especially under high load
 - No built-in retry mechanism for failed subscribers

data/lib/local_bus/bus.rb

@@ -8,27 +8,27 @@ class LocalBus
     include MonitorMixin
 
     # Constructor
-    # @note Creates a new Bus instance with specified concurrency
-    # @rbs concurrency: Integer -- maximum number of concurrent tasks (default: Concurrent.processor_count)
-    def initialize(concurrency: Concurrent.processor_count)
+    # @note Creates a new Bus instance with specified max concurrency (i.e. number of tasks that can run in parallel)
+    # @rbs max_concurrency: Integer -- maximum number of concurrent tasks (default: Concurrent.processor_count)
+    def initialize(max_concurrency: Concurrent.processor_count)
       super()
-      @concurrency = concurrency.to_i
+      @max_concurrency = max_concurrency.to_i
       @subscriptions = Concurrent::Hash.new do |hash, key|
         hash[key] = Concurrent::Set.new
       end
     end
 
     # Maximum number of concurrent tasks that can run in "parallel"
-    # @rbs return: Integer -- current concurrency value
-    def concurrency
-      synchronize { @concurrency }
+    # @rbs return: Integer
+    def max_concurrency
+      synchronize { @max_concurrency }
     end
 
-    # Sets the concurrency
-    # @rbs concurrency: Integer -- max number of concurrent tasks that can run in "parallel"
+    # Sets the max concurrency
+    # @rbs value: Integer -- max number of concurrent tasks that can run in "parallel"
     # @rbs return: Integer -- new concurrency value
-    def concurrency=(value)
-      synchronize { @concurrency = value.to_i }
+    def max_concurrency=(value)
+      synchronize { @max_concurrency = value.to_i }
     end
 
     # Registered topics that have subscribers
@@ -112,7 +112,7 @@ class LocalBus
       if subscribers.any?
         Sync do |task|
           task.with_timeout timeout.to_f do
-            semaphore = Async::Semaphore.new(concurrency, parent: barrier)
+            semaphore = Async::Semaphore.new(max_concurrency, parent: barrier)
 
             subscribers.each do |subscriber|
               semaphore.async do

data/lib/local_bus/station.rb

@@ -33,21 +33,21 @@ class LocalBus
 
     # Constructor
     # @rbs bus: Bus -- local message bus (default: Bus.new)
-    # @rbs threads: Integer -- number of threads (default: Concurrent.processor_count)
+    # @rbs max_threads: Integer -- number of max_threads (default: Concurrent.processor_count)
     # @rbs default_timeout: Float -- seconds to wait for a future to complete
     # @rbs shutdown_timeout: Float -- seconds to wait for all futures to complete on process exit
     # @rbs options: Hash[Symbol, untyped] -- Concurrent::FixedThreadPool options
     # @rbs return: void
     def initialize(
       bus: Bus.new,
-      threads: Concurrent.processor_count,
+      max_threads: Concurrent.processor_count,
       default_timeout: 0,
       shutdown_timeout: 8,
       **options
     )
       super()
       @bus = bus
-      @threads = [2, threads].max.to_i
+      @max_threads = [2, max_threads].max.to_i
       @default_timeout = default_timeout.to_f
       @shutdown_timeout = shutdown_timeout.to_f
       @shutdown = Concurrent::AtomicBoolean.new(false)
@@ -60,7 +60,7 @@ class LocalBus
 
     # Number of threads used to process messages
     # @rbs return: Integer
-    attr_reader :threads
+    attr_reader :max_threads
 
     # Default timeout for message processing (in seconds)
     # @rbs return: Float
@@ -78,7 +78,7 @@ class LocalBus
         return if running?
 
         start_shutdown_handler
-        @pool = Concurrent::FixedThreadPool.new(threads, THREAD_POOL_OPTIONS.merge(options))
+        @pool = Concurrent::FixedThreadPool.new(max_threads, THREAD_POOL_OPTIONS.merge(options))
         enable_safe_shutdown on: ["HUP", "INT", "QUIT", "TERM"]
       end
     end
@@ -99,6 +99,8 @@ class LocalBus
 
           @pool = nil
         end
+      rescue
+        nil # ignore errors during shutdown
       end
 
       # Clean up shutdown handler
@@ -213,9 +215,9 @@ class LocalBus
     # @rbs on: Array[String] -- signals to trap
     # @rbs return: void
     def enable_safe_shutdown(on:)
+      at_exit { stop }
       on.each do |signal|
         trap signal do
-          # Only queue the signal if we haven't started shutdown
           @shutdown_queue.push signal unless @shutdown.true?
         rescue
           nil

data/lib/local_bus/version.rb

@@ -3,5 +3,5 @@
 # rbs_inline: enabled
 
 class LocalBus
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: local_bus
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Nate Hopkins (hopsoft)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-05 00:00:00.000000000 Z
+date: 2024-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async