tcp-server 1.0.1-java

data/lib/server/modular_handler.rb

@@ -0,0 +1,119 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# =begin
+#
+# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+#
+# =end
+
+require 'java'
+require 'netty'
+
+require_relative 'listenable'
+
+# The Server module
+module Server
+  java_import Java::io.netty.channel.SimpleChannelInboundHandler
+  java_import Java::io.netty.channel.group.DefaultChannelGroup
+  java_import Java::io.netty.util.concurrent.GlobalEventExecutor
+
+  # rubocop: disable Style/IfUnlessModifier
+  unless defined?(::Server::Channels)
+    Channels = DefaultChannelGroup.new('channels', GlobalEventExecutor::INSTANCE)
+  end
+  # rubocop: enable Style/IfUnlessModifier
+
+  # The ModularHandler class notifies listeners about events.
+  class ModularHandler < SimpleChannelInboundHandler
+    include ::Server::Listenable
+
+    def isSharable
+      true
+    end
+
+    def channelRegistered(ctx)
+      log.trace "##{__method__} channel: #{ctx.channel}"
+      notify :channel_registered, ctx
+      super(ctx)
+    end
+
+    def channelUnregistered(ctx)
+      log.trace "##{__method__} channel: #{ctx.channel}"
+      notify :channel_unregistered, ctx
+      super(ctx)
+    end
+
+    def channelActive(ctx)
+      log.trace "##{__method__} channel: #{ctx.channel}"
+      ::Server::Channels.add(ctx.channel)
+      notify :channel_active, ctx
+      super(ctx)
+    end
+
+    def channelInactive(ctx)
+      log.trace "##{__method__} channel: #{ctx.channel}"
+      notify :channel_inactive, ctx
+      super(ctx)
+    end
+
+    def channelRead(ctx, msg)
+      log.trace "##{__method__} channel: #{ctx.channel}, message: #{msg.inspect}"
+      notify :channel_read, ctx, msg
+      super(ctx, msg)
+    end
+
+    # Please keep in mind that this method will be renamed to
+    # messageReceived(ChannelHandlerContext, I) in 5.0.
+    #
+    # java_signature 'protected abstract void channelRead0(ChannelHandlerContext ctx, I msg) throws Exception'
+    def channelRead0(ctx, msg)
+      log.trace "##{__method__} channel: #{ctx.channel}, message: #{msg.inspect}"
+      messageReceived(ctx, msg)
+      # super(ctx, msg)
+    end
+
+    def messageReceived(ctx, msg)
+      log.trace "##{__method__} channel: #{ctx.channel}, message: #{msg.inspect}"
+      notify :message_received, ctx, msg
+      # super(ctx, msg)
+    end
+
+    def channelReadComplete(ctx)
+      log.trace "##{__method__} channel: #{ctx.channel}"
+      notify :channel_read_complete, ctx
+      super(ctx)
+    end
+
+    def userEventTriggered(ctx, evt)
+      log.trace "##{__method__} channel: #{ctx.channel}, event: #{evt}"
+      notify :user_event_triggered, ctx, evt
+      super(ctx, evt)
+    end
+
+    def channelWritabilityChanged(ctx)
+      log.trace "##{__method__} channel: #{ctx.channel}"
+      notify :channel_writability_changed, ctx
+      super(ctx)
+    end
+
+    def exceptionCaught(ctx, cause)
+      ::Server.log.warn "##{__method__} channel: #{ctx.channel}, cause: #{cause.message}"
+      cause.backtrace.each { |t| ::Server.log.error t }
+      listeners = notify :exception_caught, ctx, cause
+      super(ctx, cause) if listeners.empty?
+    end
+
+    IdentiferTemplate = '#<%<class>s:0x%<id>s>'.freeze
+
+    def to_s
+      format(IdentiferTemplate, class: self.class.name, id: object_id.to_s(16))
+    end
+    alias inspect to_s
+  end
+  # class ModularHandler
+end
+# module Server

data/lib/server/server.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# =begin
+#
+# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+#
+# =end
+
+require 'java'
+require 'netty'
+
+require_relative 'instance_methods'
+require_relative 'listenable'
+
+# The Server module
+module Server
+  CHANNEL_TYPE = Java::io.netty.channel.socket.nio.NioServerSocketChannel.java_class
+
+  # The Server class sets up the netty server.
+  class Server
+    include ::Server::InstanceMethods
+    attr_reader :options
+
+    def initialize(params = {}, &block)
+      @options = params.fetch(:options, {})
+      configure_handlers(&block)
+    end
+
+    # rubocop: disable Metrics/AbcSize
+    def message_received(ctx, msg)
+      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}"
+      ctx.writeAndFlush("#{response}\n")
+    end
+
+    def add_listener(listener)
+      ::Server::ChannelInitializer::DefaultHandler.add_listener(listener)
+    end
+    # rubocop: enable Metrics/AbcSize
+  end
+  # class Server
+end
+# module Server

data/lib/server/shutdown_hook.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# =begin
+#
+# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+#
+# =end
+
+require 'java'
+
+# The Server module
+module Server
+  # The ShutdownHook class specifies a routine to be invoked when the
+  # java runtime is shutdown.
+  class ShutdownHook < java.lang.Thread
+    attr_reader :server
+
+    def initialize(server)
+      super()
+      @server = server
+      java.lang.Runtime.runtime.add_shutdown_hook(self)
+    end
+
+    def run
+      $stdout.write "\r\e[0K"
+      $stdout.flush
+      Server.log.info 'Shutting down'
+      @server.shutdown if server.respond_to?(:shutdown)
+    end
+  end
+end

data/lib/server/version.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# =begin
+#
+# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+#
+# =end
+
+# The Server module
+module Server
+  VERSION = '1.0.1'.freeze
+end

data/lib/server.rb

@@ -0,0 +1,59 @@
+#! /usr/bin/env jruby
+
+# encoding: utf-8
+# frozen_string_literal: false
+
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# =begin
+#
+# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+#
+# =end
+
+require_relative 'log'
+require_relative 'server/argument_parser'
+require_relative 'server/server'
+
+# The Server module
+module Server
+  InterruptTemplate = "\r%<class>s".freeze
+
+  # The Demo class
+  class Demo
+    def channel_active(ctx)
+      ::Server.log.info "Channel active: #{ctx.channel}"
+      response = 'Hello, world!'
+      log.trace "Sending response: #{response.inspect}"
+      ctx.channel.writeAndFlush("#{response}\n")
+    end
+
+    def exception_caught(_ctx, cause)
+      ::Server.log.error "Exception caught: #{cause}"
+      cause.backtrace.each { |t| ::Server.log.error t }
+      ctx.close()
+    end
+  end
+
+  # rubocop: disable Metrics/AbcSize
+  # rubocop: disable Metrics/MethodLength
+  def main(args = parse_arguments)
+    Logging.log_level = args[:log_level]
+    server = ::Server::Server.new(options: args)
+    server.add_listener(::Server::Demo.new)
+    server.run
+  rescue Interrupt => e
+    warn format(InterruptTemplate, class: e.class)
+    exit
+  rescue StandardError => e
+    ::Server.log.fatal(e)
+    e.backtrace.each { |t| ::Server.log.fatal t }
+    exit 1
+  end
+  # rubocop: enable Metrics/AbcSize
+  # rubocop: enable Metrics/MethodLength
+end
+# module Server
+
+Object.new.extend(::Server).main if $PROGRAM_NAME == __FILE__

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: tcp-server
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: java
+authors:
+- Nels Nelson
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.1
+  name: apache-log4j-2
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.1
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.70.1
+  name: bouncycastle
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.70.1
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.74
+  name: netty-io
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.74
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+  name: rubocop
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+description: TCP Server for JRuby is a tcp server which supports a demo echo server
+  application.
+email: nels@nelsnelson.org
+executables:
+- tcp_server
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- exe/tcp_server
+- lib/client.rb
+- lib/log.rb
+- lib/server.rb
+- lib/server/argument_parser.rb
+- lib/server/channel_initializer.rb
+- lib/server/config.rb
+- lib/server/instance_methods.rb
+- lib/server/listenable.rb
+- lib/server/message_handler.rb
+- lib/server/modular_handler.rb
+- lib/server/server.rb
+- lib/server/shutdown_hook.rb
+- lib/server/version.rb
+homepage: https://rubygems.org/gems/tcp-server-jruby
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://gitlab.com/nelsnelson/tcp-server-jruby
+  bug_tracker_uri: https://gitlab.com/nelsnelson/tcp-server-jruby/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.29
+signing_key:
+specification_version: 4
+summary: Server for JRuby packaged as a gem.
+test_files: []