tcp-server 1.1.2-java → 1.1.4-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07e7184d3ca0f9e6db19db9d7de0561690ca2afe3aa17d66c29e4883591938f5
-  data.tar.gz: b70a0d40bddcb3f5fbda8079873612db7f033ce5d9c62c28ab9fd1a1eb9b59de
+  metadata.gz: 33f9e64d109b0bdcc53bfe8cda1c4d113106cc7a9d1f6e423cfb4fd6a9fcff52
+  data.tar.gz: 9663b9e88b11d643b51292a705fbbb0ea8509fc288b175404a76b021c8edc945
 SHA512:
-  metadata.gz: 43b0a8ecb712fa514d73378a08a97dc4320ad7ce7de1420550a2cf4574b8c62ba29e66c1a7e14b4a89d5ff472ca2ef73f434629fc38c2430270b7d58063af25f
-  data.tar.gz: b09fd364b5304ce1ec7dc1c9cf6f3822ec059eeac9c6d5ca263dd657d9c801c378836ab9a71716f645b3eb0ad4d1d55a905e9357ef50b4be357ad5d71ff82be4
+  metadata.gz: dadc64a13e62cf4981b28d1d1b1d8c90748c30ff9164a646ac5cea2a294efca2916389e608b8510733333a1f66add302e43d3a537eab7f665eba2acac45ccf96
+  data.tar.gz: 72ff75a438437b1005f8d6bc8d8d3b00e3dcc96b3f4d2f17c86db1800e0e22b4ee46a9ac5621e36998741d181c81b01f6b4e1f12beea52c7237da546061bcefa

data/README.md

@@ -26,7 +26,7 @@ docker-compose down
 Building the image or running the container:
 
 ```sh
-docker build --squash --tag tcp-server-jruby .
+docker build --tag tcp-server-jruby .
 docker run --detach --publish 4000:4000 --name tcp-server-jruby tcp-server-jruby
 ```
 
@@ -43,35 +43,32 @@ The [mise] CLI tool used to manage multiple runtime versions.
 See: https://mise.jdx.dev/getting-started.html
 
 ```sh
-git clone https://github.com/asdf-vm/asdf.git "${HOME}/.asdf" --branch release-v0.10.0
-pushd "${HOME}/.asdf"; git fetch origin; popd
-source "${HOME}/.asdf/asdf.sh"; source "${HOME}/.asdf/completions/asdf.bash"
+curl https://mise.jdx.dev/install.sh | sh
+~/.local/bin/mise --version
+mise 2024.x.x
 ```
 
-
-### Install required runtime software
-
-Download and install the latest version of the [Java JDK].
+Enable mise activation in future zsh sessions.
 
 ```sh
-asdf plugin add java
-asdf install java openjdk-17.0.2
+echo 'eval "$(~/.local/bin/mise activate zsh)"' >> ~/.zshrc
 ```
 
 
-Download and install the latest version of [JRuby].
+## Install required runtime software
+
+Use mise to install the runtime software defined as requirements
+in the .tool-versions file.
 
 ```sh
-asdf plugin add ruby
-asdf plugin update --all
-asdf list all ruby
-asdf install ruby jruby-9.3.4.0
+mise install
 ```
 
 
 Install the project dependencies.
 
 ```sh
+gem install bundler
 bundle install
 ```
 
@@ -211,7 +208,7 @@ curl --silent --show-error --location --request POST "https://gitlab.com/api/v4/
 ```
 
 [license]: https://gitlab.com/nelsnelson/tcp-server-jruby/blob/master/LICENSE
-[asdf]: https://mise.jdx.dev/
+[mise]: https://mise.jdx.dev/
 [colima]: https://github.com/abiosoft/colima
 [Netty project]: https://github.com/netty/netty
 [Java JDK]: https://www.java.com/en/download/

data/lib/logging.rb

@@ -156,7 +156,7 @@ module Logging
   java_import Java::org.apache.logging.log4j.LogManager
   end
 
-  FORWARD_SLASH_PATTERN = %r{/}
+  FORWARD_SLASH_PATTERN = %r{/} unless defined?(FORWARD_SLASH_PATTERN)
 
   def init_logger(level = :info, logger_name = nil)
     return init_java_logger(level, logger_name, caller[2]) if defined?(Java)

data/lib/server/argument_parser.rb

@@ -33,11 +33,11 @@ module Server
       @parser.separator 'Options:'
     end
 
-    def validated_port(val, integer_pattern = /^\d+$/)
-      raise OptionParser::InvalidArgument, "Invalid port: #{v}" unless \
-        integer_pattern.match?(val.to_s) && val.positive? && val < 65_536
+    def validated_port(value, integer_pattern = /^\d+$/)
+      raise OptionParser::InvalidArgument, "Invalid port: #{value}" unless \
+        integer_pattern.match?(value.to_s) && value.positive? && value < 65_536
 
-      val
+      value
     end
 
     def port
@@ -97,7 +97,8 @@ module Server
   def parse_arguments(arguments_parser = ::Server::ArgumentsParser.new)
     arguments_parser.parser.parse!(ARGV)
     arguments_parser.options
-  rescue OptionParser::InvalidOption, OptionParser::AmbiguousOption => e
+  rescue OptionParser::InvalidArgument, OptionParser::InvalidOption,
+         OptionParser::AmbiguousOption => e
     abort e.message
   end
 end

data/lib/server/config.rb

@@ -10,6 +10,7 @@
 #
 # =end
 
+require 'java'
 require 'netty'
 
 require 'logger'
@@ -20,14 +21,16 @@ module Server
   def server_config
     @server_config ||= {
       host: '0.0.0.0',
-      port: 8080,
+      port: Server::DEFAULT_PORT,
       ssl: false,
       idle_reading: 5 * 60, # seconds
       idle_writing: 30, # seconds
+      max_queued_incoming_connections: Server::DEFAULT_MAX_QUEUED_INCOMING_CONNECTIONS,
       log_requests: false,
       log_level: Logger::INFO,
       quit_commands: %i[bye cease desist exit leave quit stop terminate],
       max_frame_length: 8192,
+      keep_alive: Server::DEFAULT_KEEP_ALIVE,
       delimiter: Java::io.netty.handler.codec.Delimiters.lineDelimiter
     }.freeze
   end

data/lib/server/instance_methods.rb

@@ -28,19 +28,26 @@ module Server
 
   # The InstanceMethods module
   module InstanceMethods
+    # rubocop: disable Metrics/AbcSize
+    def bootstrap
+      @bootstrap = ServerBootstrap.new
+      @bootstrap.group(boss_group, worker_group)
+      @bootstrap.channel(channel_type)
+      @bootstrap.option(ChannelOption::SO_BACKLOG, max_queued_incoming_connections)
+      @bootstrap.childOption(ChannelOption::SO_KEEPALIVE, keep_alive) if keep_alive
+      @bootstrap.handler(logging_handler) if options.fetch(:log_requests, false)
+      @bootstrap.childHandler(channel_initializer)
+    end
+    # rubocop: enable Metrics/AbcSize
+
     def configure_handlers(*handlers, &block)
       add_listener(self)
       channel_initializer << block if block_given?
       add_listener(*handlers)
     end
 
-    def bootstrap
-      @bootstrap = ServerBootstrap.new
-      @bootstrap.group(boss_group, worker_group)
-      @bootstrap.channel(Server::CHANNEL_TYPE)
-      @bootstrap.option(ChannelOption::SO_BACKLOG, 100.to_java(java.lang.Integer))
-      @bootstrap.handler(logging_handler) if options[:log_requests]
-      @bootstrap.childHandler(channel_initializer)
+    def channel_type
+      @channel_type ||= Server::CHANNEL_TYPE
     end
 
     def channel_initializer
@@ -65,7 +72,7 @@ module Server
 
     # rubocop: disable Metrics/AbcSize
     # rubocop: disable Metrics/MethodLength
-    def run(port = @options[:port])
+    def run(port = self.port)
       channel = bootstrap.bind(port).sync().channel()
       channel_group.add(channel)
       ::Server::ShutdownHook.new(self)
@@ -83,6 +90,14 @@ module Server
     # rubocop: enable Metrics/AbcSize
     # rubocop: enable Metrics/MethodLength
 
+    def port
+      @port ||= begin
+        value = @options[:port]
+        value = DEFAULT_PORT if value.nil?
+        value.to_i
+      end
+    end
+
     def shutdown
       channel_group.disconnect().awaitUninterruptibly()
       channel_group.close().awaitUninterruptibly()
@@ -104,6 +119,22 @@ module Server
     def replace_listeners(*listener)
       channel_initializer.replace_listeners(*listener)
     end
+
+    def keep_alive
+      @keep_alive ||= begin
+        value = @options[:keep_alive]
+        value = DEFAULT_KEEP_ALIVE if value.nil?
+        value
+      end
+    end
+
+    def max_queued_incoming_connections
+      @max_queued_incoming_connections ||= begin
+        value = @options[:max_queued_incoming_connections]
+        value = DEFAULT_MAX_QUEUED_INCOMING_CONNECTIONS if value.nil?
+        value.to_java(java.lang.Integer)
+      end
+    end
   end
   # module ServerInstanceMethods
 end

data/lib/server/server.rb

@@ -21,6 +21,9 @@ module Server
   # The Server class sets up the netty server.
   class Server
     CHANNEL_TYPE = Java::io.netty.channel.socket.nio.NioServerSocketChannel.java_class
+    DEFAULT_MAX_QUEUED_INCOMING_CONNECTIONS = 100
+    DEFAULT_KEEP_ALIVE = false
+    DEFAULT_PORT = 8080
     include ::Server::InstanceMethods
     attr_reader :options
 
@@ -32,9 +35,10 @@ module Server
 
     # rubocop: disable Metrics/AbcSize
     def message_received(ctx, msg)
+      return if msg.nil?
+      msg.chomp! if msg.respond_to?(:chomp!)
+      return if msg.respond_to?(:empty?) && msg.empty?
       log.trace "##{__method__} channel: #{ctx.channel}, message: #{msg.inspect}"
-      msg&.chomp!
-      return if msg.nil? || msg.empty?
       return ctx.close() if @options[:quit_commands].include?(msg.downcase.to_sym)
       response = msg.upcase
       log.debug "Sending response: #{response.inspect}"

data/lib/server/shutdown_hook.rb

@@ -29,7 +29,7 @@ module Server
       $stdout.write "\r\e[0K"
       $stdout.flush
       ::Server.log.info 'Shutting down'
-      @server.shutdown if server.respond_to?(:shutdown)
+      server.shutdown if server.respond_to?(:shutdown)
     end
   end
 end

data/lib/server/version.rb

@@ -12,5 +12,5 @@
 
 # The Server module
 module Server
-  VERSION = '1.1.2'.freeze
+  VERSION = '1.1.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcp-server
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.4
 platform: java
 authors:
 - Nels Nelson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement