tiny_tcp_service 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 807a9c4df229014efd5376a0ab636806fe82399999ab99ca367a6f2d057d0bdb
-  data.tar.gz: e30fd27d92a5f8a6ffd64b4183765050777f933c80a970256c2dc72804ec98bd
+  metadata.gz: d0b5f209ab23524835fe2cc63b60e2189b26ad34662ee3af78c6c28b9fa8c721
+  data.tar.gz: 87f8e1c4b84b09d1ee34afdae890a4886b7f9878631f7d86e8e74fa300611b2e
 SHA512:
-  metadata.gz: 9412c4a198ad73b150cef0f4f9e98da281cda3fe6dbfbd17eb1caae8b7632cb8e73f24eb2e40bc3dcb20fd6734f1c2f324a91c1230e4edb71e9ed36cc7786e47
-  data.tar.gz: e57e65acae41614f17650ce7c7c64b9a3a302be645ed2cedd5a33b2f310252bc06077bbfeeb209ab8333920b5bf0a9021c1e150857951a166f05704874a07723
+  metadata.gz: c1a76e05e856e23bb33890c9f2fc9c46af0c82b8185501252fa1c1d73f22c1e01115443cebaa97c225c5e1bbd1fcf336bfd6aabb2014bdfa3eb01ae6028b02f0
+  data.tar.gz: 279da0f3265028f3f528587d3b1783ba9f148c1d228b0f871a5ba4b889c3f4092c4f8bece422fb484c32873d4e7a2587fdf9eaf2cc228c5706159600ee7c41e1

data/lib/tiny_tcp_service.rb

@@ -9,21 +9,35 @@ require 'socket'
 #  s.start!     # everything runs in background threads
 #  s.stop!      # gracefully shutdown the server
 #
-# NOTE: the msg_handler does not need to be a proc/lambda, it just needs to be
-# an object that responds_to?(:call), and accepts a single message object.
-# however, if your msg_handler is simple enough to fit into something as tiny as
-# a proc then more power to you.
+# TinyTCPService implements a line-based, call and response protocol, where
+# every incoming message must be a newline-terminated ("\n") String, and for
+# every received message the service responds with a newline-terminated String.
+# been set).
+#
+# If you need more complex objects to be sent over the wire, consider something
+# like JSON.
+#
+# NOTE: if you're running a TinyTCPService and a client of your system violates
+# your communication protocol, you should raise an instance of
+# TinyTCPService::BadClient, and the TinyTCPService instance will take care of
+# safely removing the client.
 class TinyTCPService
-  def initialize(port, msg_handler)
+  def initialize(port)
     @port = port
-    @msg_handler = msg_handler
 
     @server = TCPServer.new(port)
     @clients = []
     @running = false
+
+    @msg_handler = nil
     @error_handlers = {}
   end
 
+  # h - some object that responds to #call
+  def msg_handler=(h)
+    @msg_handler = h
+  end
+
   # returns true if the server is running
   # false otherwise
   def running?
@@ -47,6 +61,11 @@ class TinyTCPService
     @clients.length
   end
 
+  def _remove_client!(c)
+    @clients.delete(c)
+    c.close if c && !c.closed?
+  end
+
   # starts the server
   def start!
     return if running?
@@ -59,7 +78,7 @@ class TinyTCPService
         @clients << @server.accept
       end
 
-      @clients.each{|c| c.close if c && !c.closed? }
+      @clients.each{|c| _remove_client!(c) if c && !c.closed? }
       @server.close
     end
 
@@ -69,9 +88,11 @@ class TinyTCPService
         break unless running?
 
         readable, _, errored = IO.select(@clients, nil, @clients, 1)
-        readable&.each do |client|
+        readable&.each do |c|
           begin
-            @msg_handler.call(client.gets.chomp)
+            @msg_handler&.call(c.gets.chomp)
+          rescue TinyTCPService::BadClient => e
+            _remove_client!(c)
           rescue => e
             handler = @error_handlers[e.class]
 
@@ -79,14 +100,13 @@ class TinyTCPService
               handler.call(e)
             else
               stop!
-              raise e unless handler
+              raise e
             end
           end
         end
 
-        errored&.each do |client|
-          @clients.delete(client)
-          client.close if client && !client.closed?
+        errored&.each do |c|
+          _remove_client!(c)
         end
       end
     end
@@ -97,3 +117,5 @@ class TinyTCPService
     @running = false
   end
 end
+
+class TinyTCPService::BadClient < RuntimeError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_tcp_service
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Jeff Lunt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2023-11-04 00:00:00.000000000 Z
 dependencies: []
 description: a tiny TCP service with automated client lifecycle
 email: jefflunt@gmail.com