cztop-reactor 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17bf40bedf4749f22ba30e33ea82296f2936267c4fcefc3c01d2e795ad7d741c
-  data.tar.gz: 00063eb4d49d06906fa50e778447816503302b42e8551cc6cb3ccae7b7422e70
+  metadata.gz: c35b32fd4ad494b65ff397c7bc78e0c2f02cffbd9745bc674c6813de209844b1
+  data.tar.gz: a13ddcdbbf60a25b2e06675fb00430502cb1d5808ad65c01c7de531856ed0669
 SHA512:
-  metadata.gz: fdab82704df0e87ac9b742fff14d72dc3c9d0b48d7d9fc5af76160a662ff8fa3b4ec5d3567246ba4c9ea7b0e8c56cf0fde171d2542d8a91f539774f12eb21500
-  data.tar.gz: 202f8a04ccb8bc02653eca063777b1c949fdb6bfe27561c94ed2205af5b4fea1b6d28e27948092ad24eff8c09af4ab143ae8264ba09626b2719eb42de9732538
+  metadata.gz: 356fde892a03e56418ceada7be45cf08e1cb1355f67e6c3ad7cb7aed4cc408dfd029598d81473715c3eaf1c4ab809eed3966d2b1c8bfca3f8ba6c770ea0da151
+  data.tar.gz: 26a7370a6a141b4e0959bbead2b51c9bfa72711c1f5a369bacc61eb7aabb7c9fcea6ee8a4f20341625863d0ba4b370ee70417e5875ea70ec7130bb82810f15cb

data/ChangeLog

@@ -1,8 +1,81 @@
+2018-07-21  Michael Granger  <ged@FaerieMUD.org>
+
+	* Manifest.txt, lib/cztop/reactor/socket_monitoring.rb,
+	spec/cztop/reactor/socket_monitoring_spec.rb:
+	Add a socket monitor mixin
+	[e65cdcbe5f89] [tip]
+
+2018-07-11  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.5.0 for changeset c82d889b3d2e
+	[0338a8ab0f8b]
+
+	* .hgsigs:
+	Added signature for changeset c6276b15f479
+	[c82d889b3d2e] [v0.5.0]
+
+	* History.md, Rakefile, cztop-reactor.gemspec, lib/cztop/reactor.rb:
+	Bump the minor version, cztop dep, and update History.
+	[c6276b15f479]
+
+	* cztop-reactor.gemspec, lib/cztop/reactor.rb,
+	spec/cztop/reactor_spec.rb:
+	Added methods to pause/resume all timers.
+	[67cfabefffd2]
+
+2018-06-27  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.4.0 for changeset 36b814356934
+	[9e371cd81152]
+
+	* .hgsigs:
+	Added signature for changeset 4fa4ea9f2a91
+	[36b814356934] [v0.4.0]
+
+	* History.md, lib/cztop/reactor.rb:
+	Bump the minor version, update history.
+	[4fa4ea9f2a91]
+
+	* .ruby-version, lib/cztop/reactor.rb:
+	Make the reactor threadsafe
+	[c0beb742a2a2]
+
+2018-06-06  Michael Granger  <ged@FaerieMUD.org>
+
+	* Merged with 33bf1ec41017
+	[9ca502f040d3]
+
+	* lib/cztop/reactor/signal_handling.rb:
+	Fix docs and logging in signal handling mixin
+	[0adc6861a172]
+
+	* lib/cztop/reactor.rb:
+	Guard against events with no sockets
+	[749f5de1d5fe]
+
+	* certs/ged.pem:
+	Update my gem-signing cert
+	[26089589e937]
+
+2017-11-07  Michael Granger  <ged@FaerieMUD.org>
+
+	* .ruby-version:
+	Update to Ruby 2.4
+	[33bf1ec41017]
+
+2017-05-19  Michael Granger  <ged@FaerieMUD.org>
+
+	* Rakefile, cztop-reactor.gemspec:
+	Fix the rules for the gemspec.
+	[469956f9635b]
+
 2017-05-16  Michael Granger  <ged@FaerieMUD.org>
 
 	* .hgtags:
 	Added tag v0.3.0 for changeset 93726ed1d11c
-	[4a5ff1ab5370] [tip]
+	[4a5ff1ab5370]
 
 	* .hgsigs:
 	Added signature for changeset b27d8748d922
@@ -67,7 +140,7 @@
 
 	* .hgsigs:
 	Added signature for changeset 8616ee222428
-	[10a0b983e907] [github/master]
+	[10a0b983e907]
 
 	* .hgtags:
 	Added tag v0.1.0.pre20170323172345 for changeset 77db55f567df

data/History.md

@@ -1,3 +1,10 @@
+## v0.6.0 [2018-07-21] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Add a mixin for easy socket monitoring setup.
+
+
 ## v0.5.0 [2018-07-11] Michael Granger <ged@FaerieMUD.org>
 
 Enhancements:

data/Manifest.txt

@@ -10,7 +10,9 @@ Rakefile
 lib/cztop/reactor.rb
 lib/cztop/reactor/event.rb
 lib/cztop/reactor/signal_handling.rb
+lib/cztop/reactor/socket_monitoring.rb
 spec/cztop/reactor/event_spec.rb
 spec/cztop/reactor/signal_handling_spec.rb
+spec/cztop/reactor/socket_monitoring_spec.rb
 spec/cztop/reactor_spec.rb
 spec/spec_helper.rb

data/lib/cztop/reactor.rb

@@ -24,7 +24,7 @@ class CZTop::Reactor
 	include MonitorMixin
 
 	# The version of this library
-	VERSION = '0.5.0'
+	VERSION = '0.6.0'
 
 	# The maximum number of seconds to wait for events when there are no timers
 	# registered.

data/lib/cztop/reactor/socket_monitoring.rb

@@ -0,0 +1,117 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'cztop/reactor' unless defined?( CZTop::Reactor )
+
+# Methods for logging monitor events.
+module CZTop::Reactor::SocketMonitoring
+
+	### Inclusion callback -- add Loggability to including classes.
+	def self::included( mod )
+		super
+		mod.extend( Loggability )
+		mod.log_to( :cztop ) unless Loggability.log_host?( mod )
+	end
+
+
+	### Set up a monitor instance variable on object creation.
+	def initialize( * ) # :notnew:
+		@monitor = nil
+	end
+
+	##
+	# The CZTop::Monitor for the server socket
+	attr_reader :monitor
+
+
+	### Run the block with monitoring for the specified +socket+.
+	def with_socket_monitor( reactor, socket, *events )
+		mon = self.set_up_socket_monitor( reactor, socket )
+
+		return yield
+	ensure
+		self.clean_up_socket_monitor( mon )
+	end
+
+
+	### Create a monitor for the specified +socket+.
+	def set_up_socket_monitor( reactor, socket, *events )
+		return reactor.register_monitor( socket, *events, &self.method(:on_monitor_event) )
+	end
+
+
+	### Tear down the monitor.
+	def clean_up_socket_monitor( mon )
+		mon.terminate if mon
+	end
+
+
+	### Handle monitor events.
+	def on_monitor_event( monitor_event )
+		self.log.debug "Got monitor event: %p" % [ monitor_event ]
+
+		msg = monitor_event.socket.receive
+		type, *payload = *msg
+		callback_name = "on_#{type.downcase}"
+
+		if self.respond_to?( callback_name, true )
+			self.send( callback_name, *payload )
+		else
+			self.log.warn "No handler (#%s) for monitored %s event." % [ callback_name, type ]
+		end
+	end
+	alias_method :handle_monitor_event, :on_monitor_event
+
+
+	#########
+	protected
+	#########
+
+	### Monitor event callback for socket connection events
+	def on_connected( fd, endpoint )
+		self.log.debug "Client socket on FD %d connected" % [ fd ]
+	end
+
+
+	### Monitor event callback for socket accepted events
+	def on_accepted( fd, endpoint )
+		self.log.debug "Client socket on FD %d accepted" % [ fd ]
+	end
+
+
+	### Monitor event callback for successful auth events.
+	def on_handshake_succeeded( fd, endpoint )
+		self.log.debug "Client socket on FD %d handshake succeeded" % [ fd ]
+	end
+
+
+	### Monitor event callback for failed auth events.
+	def on_handshake_failed( fd, endpoint )
+		self.log.debug "Client socket on FD %d handshake failed" % [ fd ]
+	end
+
+
+	### Monitor event callback for failed handshake events.
+	def on_handshake_failed_no_detail( fd, endpoint )
+		self.log.debug "Client socket on FD %d handshake failed; no further details are known" % [ fd ]
+	end
+
+
+	### Monitor event callback for failed handshake events.
+	def on_handshake_failed_protocol( fd, endpoint )
+		self.log.debug "Client socket on FD %d handshake failed: protocol error" % [ fd ]
+	end
+
+
+	### Monitor event callback for socket closed events
+	def on_closed( fd, endpoint )
+		self.log.debug "Client socket on FD %d closed" % [ fd ]
+	end
+
+
+	### Monitor event callback for socket disconnection events
+	def on_disconnected( fd, endpoint )
+		self.log.debug "Client socket on FD %d disconnected" % [ fd ]
+	end
+
+end # module CZTop::Reactor::SocketMonitoring

data/spec/cztop/reactor/socket_monitoring_spec.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../../spec_helper'
+
+require 'cztop/reactor/socket_monitoring'
+
+
+describe CZTop::Reactor::SocketMonitoring do
+
+	it "can add a socket monitor setup to a reactor for a block" do
+		including_class = Class.new do
+
+			def initialize
+				@monitor_events = []
+			end
+
+			attr_reader :monitor_events
+
+			def on_connect_delayed( fd, endpoint )
+				@monitor_events << :connect_delayed
+			end
+
+		end
+
+		including_class.include( described_class )
+
+		obj = including_class.new
+		reactor = CZTop::Reactor.new
+		listener = CZTop::Socket::SERVER.new( '@tcp://127.0.0.1:*' )
+		socket = CZTop::Socket::CLIENT.new
+
+		obj.with_socket_monitor( reactor, socket, :CONNECTED ) do
+			socket.connect( listener.last_endpoint )
+			reactor.poll_once
+		end
+
+		expect( obj.monitor_events ).to include( :connect_delayed )
+	end
+
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cztop-reactor
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Michael Granger
@@ -35,7 +35,7 @@ cert_chain:
   X0qdrKi+2aZZ0NGuFj9AItBsVmAvkBGIpX4TEKQp5haEbPpmaqO5nIIhV26PXmyT
   OMKv6pWsoS81vw5KAGBmfX8nht/Py90DQrbRvakATGI=
   -----END CERTIFICATE-----
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2018-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -218,8 +218,10 @@ files:
 - lib/cztop/reactor.rb
 - lib/cztop/reactor/event.rb
 - lib/cztop/reactor/signal_handling.rb
+- lib/cztop/reactor/socket_monitoring.rb
 - spec/cztop/reactor/event_spec.rb
 - spec/cztop/reactor/signal_handling_spec.rb
+- spec/cztop/reactor/socket_monitoring_spec.rb
 - spec/cztop/reactor_spec.rb
 - spec/spec_helper.rb
 homepage: http://deveiate.org/projects/cztop-reactor
@@ -244,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: This is an implementation of the Reactor pattern described in [Pattern-Oriented