cztop-reactor 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f70c203f7ad3e56ab62f3a274d7e0bcd6bc0a845
-  data.tar.gz: f7166b3b4c013035f61ea88e4839fdb8cec1517e
+  metadata.gz: 7040196abcd091e72df775bcb4c4dc6ebca8781c
+  data.tar.gz: 3da1c1b5f4ef14d63d2ef16d502c10de3cf8a0e7
 SHA512:
-  metadata.gz: f24b280136af590d7c05685d7db0a31e702f2b013fb9bce3ed3271579ecf917d47faa81d3c0bcb289422b7ed819fc599ee75f5dc5dfc309188b14b2e2159cd16
-  data.tar.gz: f1477bbfb5427e0e62e2309160231f515062e25fdc2ec440361817c0a69d070c9d07adb13e217b51368684f702d30f4b24169b7bcf6e90486a272e9b4a9ddc5f
+  metadata.gz: 2b7ccd0a2736e3cfc0af5408c1ee804ac1163c5f2ea730f9f21a3a6a5c17c71aa46784585d133cc510d3d85e07ad764b397f440bfb98c1f79c55abea6ec5dbf9
+  data.tar.gz: '0845fbba1711499f0bee3caf9c09a893c9e0d4395cdb24f943bcded4113d8dade8c9cdd153ff979a7b4b19fb8ef709d8eef42f03e3320b10deb1c6399196afab'

data/ChangeLog

@@ -1,8 +1,39 @@
+2017-05-15  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgignore, Manifest.txt, lib/cztop/reactor/signal_handling.rb,
+	spec/cztop/reactor/signal_handling_spec.rb:
+	Add a mixin for signal handling.
+	[970a2eb110fb] [tip]
+
+2017-04-30  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgignore:
+	Ignore pkg directory
+	[1c8f915143cf]
+
+2017-04-29  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.2.0 for changeset 05892f4b1e67
+	[188620133448]
+
+	* .hgsigs:
+	Added signature for changeset 94faa8741253
+	[05892f4b1e67] [v0.2.0]
+
+	* History.md, lib/cztop/reactor.rb:
+	Bump the minor version, update history.
+	[94faa8741253]
+
+	* lib/cztop/reactor.rb, spec/cztop/reactor_spec.rb:
+	Allow timers to be resumed after they're removed.
+	[2318715be614]
+
 2017-04-19  Michael Granger  <ged@FaerieMUD.org>
 
 	* Rakefile, cztop-reactor.gemspec:
 	Remove Rakefile guard against public release.
-	[bb56a75ae424] [tip]
+	[bb56a75ae424]
 
 2017-04-12  Michael Granger  <ged@FaerieMUD.org>
 

data/History.md

@@ -1,3 +1,10 @@
+##  v0.3.0 [2017-05-15] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Add a mixin for adding queued signal handling to the polling loop.
+
+
 ##  v0.2.0 [2017-04-29] Michael Granger <ged@FaerieMUD.org>
 
 Enhancements:

data/Manifest.txt

@@ -9,6 +9,8 @@ README.md
 Rakefile
 lib/cztop/reactor.rb
 lib/cztop/reactor/event.rb
+lib/cztop/reactor/signal_handling.rb
 spec/cztop/reactor/event_spec.rb
+spec/cztop/reactor/signal_handling_spec.rb
 spec/cztop/reactor_spec.rb
 spec/spec_helper.rb

data/lib/cztop/reactor.rb

@@ -22,7 +22,7 @@ class CZTop::Reactor
 	extend Loggability
 
 	# The version of this library
-	VERSION = '0.2.0'
+	VERSION = '0.3.0'
 
 	# The maximum number of seconds to wait for events when there are no timers
 	# registered.

data/lib/cztop/reactor/signal_handling.rb

@@ -0,0 +1,164 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+require 'loggability'
+require 'securerandom'
+require 'cztop/reactor' unless defined?( CZTop::Reactor )
+
+
+# A mixin that adds methods for running a process with queued signal handling
+# via a ZMQ PAIR socket.
+#
+#     require 'cztop'
+#     require 'cztop/reactor'
+#     require 'cztop/reactor/signal_handling'
+#
+#     class MyDaemon
+#         include 'cztop/reactor/signal_handling'
+#
+#         def start
+#             @reactor = CZTop::Reactor.new
+#             @reactor.register( @socket, :read, &self.method(:handle_io_event) )
+#             self.with_signal_handler( @reactor, :HUP, :INT, :TERM ) do
+#                 @reactor.start_polling( ignore_interrupts: true )
+#             end
+#         end
+#
+#         def stop
+#             @reactor.stop_polling
+#         end
+#
+#         def handle_signal( signal_name )
+#             case signal_name
+#             when :INT, :TERM, :HUP
+#                 self.stop
+#             else
+#                 super
+#             end
+#         end
+#     end
+#
+# With this mixin included, you can wrap a block with a call to
+# #with_signal_handler, and when a signal arrives, the #handle_signal method
+# will be called with the name of the signal.
+module CZTop::Reactor::SignalHandling
+
+
+	# The name of the thread-local variable that stores pending signals.
+	SIGNAL_QUEUE_KEY = :signal_queue
+
+
+	### 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
+
+
+	### Wrap a block in signal-handling.
+	def with_signal_handler( reactor, *signals )
+		self.set_up_signal_handling( reactor )
+		self.set_signal_traps( *signals )
+
+		return yield
+
+	ensure
+		self.reset_signal_traps( *signals )
+		self.clean_up_signal_handling( reactor )
+	end
+
+
+	### Simulate the receipt of the specified +signal+ (probably only useful
+	### in testing).
+	def simulate_signal( signal )
+		Thread.main[ SIGNAL_QUEUE_KEY ] << signal.to_sym
+		self.wake_up
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Set up data structures for signal handling.
+	def set_up_signal_handling( reactor )
+		Thread.main[ SIGNAL_QUEUE_KEY ] = []
+
+		endpoint = "inproc://signal-handler-%s" % [ SecureRandom.hex(8) ]
+		@self_pipe = {
+			reader: CZTop::Socket::PAIR.new( "@#{endpoint}" ),
+			writer: CZTop::Socket::PAIR.new( ">#{endpoint}" )
+		}
+
+		# :TODO: Consider calling #set_unbounded on the PAIR sockets
+
+		reactor.register( @self_pipe[:reader], :read, &self.method(:handle_queued_signals) )
+	end
+
+
+	### Tear down the data structures for signal handling
+	def clean_up_signal_handling( reactor )
+		reactor.unregister( @self_pipe[:reader] )
+
+		@self_pipe[:writer].options.linger = 0
+		@self_pipe[:writer].close
+		@self_pipe[:reader].options.linger = 0
+		@self_pipe[:reader].close
+
+		Thread.main[ SIGNAL_QUEUE_KEY ].clear
+	end
+
+
+	### Look for any signals that arrived and handle them.
+	def handle_queued_signals( _event )
+		while sig = Thread.main[ SIGNAL_QUEUE_KEY ].shift
+			self.log.debug "  got a queued signal: %p" % [ sig ]
+			self.handle_signal( sig )
+		end
+	end
+
+
+	### Default signal-handler callback -- this raises an exception by default.
+	def handle_signal( signal_name )
+		raise NotImplementedError, "unhandled signal %s" % [ signal_name ]
+	end
+
+
+	### Signal through the self-pipe that one or more signals has been queued.
+	def wake_up
+		@self_pipe[:writer].signal( 1 )
+	end
+
+
+	### Set up signal traps for the specified +signals+.
+	def set_signal_traps( *signals )
+		self.log.debug "Setting up deferred signal handlers."
+		signals.each do |sig|
+			Signal.trap( sig ) do
+				Thread.main[ SIGNAL_QUEUE_KEY ] << sig
+				self.wake_up
+			end
+		end
+	end
+
+
+	### Set the traps for the specified +signals+ to IGNORE.
+	def ignore_signals( *signals )
+		self.log.debug "Ignoring signals."
+		signals.each do |sig|
+			next if sig == :CHLD
+			Signal.trap( sig, :IGNORE )
+		end
+	end
+
+
+	### Set the traps for the specified +signals+ to the default handler.
+	def reset_signal_traps( *signals )
+		self.log.debug "Restoring default signal handlers."
+		signals.each do |sig|
+			Signal.trap( sig, :DEFAULT )
+		end
+	end
+
+end # module CZTop::Reactor::SignalHandling

data/spec/cztop/reactor/signal_handling_spec.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../../spec_helper'
+
+require 'cztop/reactor/signal_handling'
+
+
+describe CZTop::Reactor::SignalHandling do
+
+	it "can add a signal handler setup to a reactor for a block" do
+		including_class = Class.new do
+
+			def initialize
+				@signals = []
+			end
+
+			attr_reader :signals
+
+			def handle_signal( signal_name )
+				self.signals << signal_name
+			end
+
+		end
+
+		including_class.include( described_class )
+
+		obj = including_class.new
+		reactor = CZTop::Reactor.new
+
+		obj.with_signal_handler( reactor, :USR1 ) do
+			obj.log.debug( "Killing with USR1" )
+			Process.kill( :USR1, Process.pid )
+			reactor.poll_once
+		end
+
+		expect( obj.signals ).to eq([ :USR1 ])
+	end
+
+
+	it "raises if the including class doesn't provide a #handle_signal method" do
+		including_class = Class.new
+		including_class.include( described_class )
+
+		obj = including_class.new
+		reactor = CZTop::Reactor.new
+
+		expect {
+			obj.with_signal_handler( reactor, :USR1 ) do
+				obj.log.debug( "Killing with USR1" )
+				Process.kill( :USR1, Process.pid )
+				reactor.poll_once
+			end
+		}.to raise_error( NotImplementedError, /unhandled signal USR1/i )
+	end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cztop-reactor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Granger
@@ -35,7 +35,7 @@ cert_chain:
   w8aNA5re5+Rt/Vvjxj5AcEnZnZiz5x959NaddQocX32Z1unHw44pzRNUur1GInfW
   p4vpx2kUSFSAGjtCbDGTNV2AH8w9OU4xEmNz8c5lyoA=
   -----END CERTIFICATE-----
-date: 2017-04-29 00:00:00.000000000 Z
+date: 2017-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -217,7 +217,9 @@ files:
 - Rakefile
 - lib/cztop/reactor.rb
 - lib/cztop/reactor/event.rb
+- lib/cztop/reactor/signal_handling.rb
 - spec/cztop/reactor/event_spec.rb
+- spec/cztop/reactor/signal_handling_spec.rb
 - spec/cztop/reactor_spec.rb
 - spec/spec_helper.rb
 homepage: http://deveiate.org/projects/cztop-reactor