tiny_tcp_service 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a9d89a4cf5f6578a0f606fe0c24cb81495fe2c96cfea70074670f2e9a3fd3ac
-  data.tar.gz: 50b6169a75272e14a07fbd17fc2b6575a3c8010bc580776ad456ee3786eca5bf
+  metadata.gz: 1836cd2d7baa8228f9fbfddfe63718aadc35cf26d59e54cbda26c8bea584c2f1
+  data.tar.gz: 8e5982655d66d8950d8dafd8239b67dc2977d35dcde6efcd53697adbfe519314
 SHA512:
-  metadata.gz: d80e1a3243cb5102bc776d19759c0c5ffed178ccbf7b96aaa895bf18144675be725fc0b7df7f42b877358b980fd9e16d5588a39bc4434bd6f5231c90630d23ae
-  data.tar.gz: 73fc25a0c4b58609a711694840c3227717412aca82a84623884aa3b1f7539f8e318cb1310913f139dd4114c9010804d7df6ed48ede08450d4c4433156fdb9ece
+  metadata.gz: d3f632a782bda92c4f3c83e2ba459a276a073dbd9ea264c54ffd2657428cad420392e76fe5eacff3e80c3f84689aef7a6dbb5167bad98fa24ea76d3389dab401
+  data.tar.gz: fcb2d4b300629ae12417d41f98f1e9a30bda1d2ff25e07c6afa4f8d15898ccb1e40019766d2b94597ca9a4f8707f8b90edcc2278d03bcd66e178dfe951547bb7

data/lib/tiny_tcp_service.rb

@@ -8,17 +8,36 @@ require 'socket'
 #
 #  s.start!     # everything runs in background threads
 #  s.stop!      # gracefully shutdown the server
+#
+# 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 set_msg_handler!(h)
+    @msg_handler = h
+  end
+
   # returns true if the server is running
   # false otherwise
   def running?
@@ -42,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?
@@ -54,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
 
@@ -64,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]
 
@@ -74,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
@@ -92,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.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jeff Lunt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-29 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