cztop-reactor 0.1.0.pre20170316155217 → 0.1.0.pre20170323172345

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ff9e9366325f56b5134fb0c8b7123c90b259709
-  data.tar.gz: f1effb0b47c1199772305b414d2f31e34bdb7798
+  metadata.gz: 693a140ab57c4d6cd02f56f750474f7b8d2b1da1
+  data.tar.gz: c56488274eece275fab5ec9d5383d3956f6faf4e
 SHA512:
-  metadata.gz: 41e02a93aab2823b3dd3b6d05e2da1a15d873f99cf1efaa4068a7b632ee595b2641d0bda7a5d13b43eb931095235000edfb93a9daadb71d7517187530ffcdda6
-  data.tar.gz: 3e391f785107c50fa41f4a4bb761fc1ad14cef76411cb3bb52dfb61d58a952376294a0d9aa86f0c81487984e8f5d9bfb2e0b48a35d9c2b17dbd2e5a91180a006
+  metadata.gz: 5b1fce6cca68d902057ffd8efd008e14da2cb5ed14adf121f8af406c8f4fb1c9429598085dfb379f2ce357ec0ea51524753576e79ac0fe0aabdf0af92e56d10f
+  data.tar.gz: 26f53aa35c4762e46fc42add8cbe732a6b66c24896df5ddb35d997883a12dc3fcc4521a9b82f623c612fc41039c7b343af6ef7fb46724b800c6cbe0c3be60848

data/ChangeLog

@@ -1,12 +1,29 @@
+2017-03-27  Michael Granger  <ged@FaerieMUD.org>
+
+	* .gems:
+	Fix fivefish gem name in gemset
+	[27fcb613383f] [tip]
+
+2017-03-22  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hoerc, cztop-reactor.gemspec, lib/cztop/reactor.rb,
+	spec/cztop/reactor_spec.rb:
+	Allow a handler object instead of a block.
+	[10904c471caa] [github/master]
+
 2017-03-16  Michael Granger  <ged@FaerieMUD.org>
 
+	* Rakefile, cztop-reactor.gemspec:
+	Add missing dependency on timers.
+	[962f88d917bf]
+
 	* .hgignore:
 	Ignore built gems
-	[594168b03b71] [tip]
+	[594168b03b71]
 
 	* README.md:
 	Fix link in the README
-	[0391133d132d] [github/master]
+	[0391133d132d]
 
 	* .hgignore:
 	Ignore generated docs directory

data/lib/cztop/reactor.rb

@@ -100,7 +100,12 @@ class CZTop::Reactor
 	### event/handler+arguments pairs associated with the handle.
 	###
 	def register( socket, *events, &handler )
-		raise LocalJumpError, "no handler given" unless handler
+		if !events.empty? && !events.last.is_a?( Symbol )
+			handler_obj = events.pop
+			handler = handler_obj.method( :handle_io_event )
+		end
+
+		raise LocalJumpError, "no block or handler given" unless handler
 
 		self.unregister( socket )
 
@@ -235,6 +240,11 @@ class CZTop::Reactor
 	### registered with the reactor for the `:read` event with the specified +callback+,
 	### then returned.
 	def register_monitor( socket, *events, &callback )
+		if !events.empty? && !events.last.is_a?( String )
+			handler = events.pop
+			callback = handler.method( :handle_monitor_event )
+		end
+
 		events.push( 'ALL' ) if events.empty?
 
 		monitor = CZTop::Monitor.new( socket )
@@ -253,33 +263,45 @@ class CZTop::Reactor
 	# Polling
 	#
 
-	### Poll the sockets registered to the reactor for pending events.
-	def start_polling
-		until self.empty?
-			self.log.debug "Polling %d sockets" % [ self.sockets.length ]
-
-			wait_interval = self.timers.wait_interval || DEFAULT_POLL_INTERVAL
-
-			# If there's a timer already due to fire, don't wait at all
-			event = if wait_interval > 0
-					self.log.debug "Waiting for IO for %fms" % [ wait_interval * 1000 ]
-					self.wait( wait_interval * 1000 )
-				else
-					nil
-				end
-
-			self.log.debug "Got event %p" % [ event ]
-			if event
-				# self.log.debug "Got event: %p" % [ event ]
-				handler = self.sockets[ event.socket ][ :handler ]
-				handler.call( event ) if handler
+	### Poll registered sockets and fire timers until they're all unregistered.
+	def start_polling( **opts )
+		self.poll_once( **opts ) until self.empty?
+	end
+
+
+	### Poll registered sockets or fire timers and return.
+	def poll_once( ignore_interrupts: false, ignore_eagain: true )
+		self.log.debug "Polling %d sockets" % [ self.sockets.length ]
+
+		wait_interval = self.timers.wait_interval || DEFAULT_POLL_INTERVAL
+
+		# If there's a timer already due to fire, don't wait at all
+		event = if wait_interval > 0
+				self.log.debug "Waiting for IO for %fms" % [ wait_interval * 1000 ]
+				self.wait( wait_interval * 1000 )
 			else
-				self.log.debug "Expired: firing timers."
-				self.timers.fire
+				nil
 			end
 
-			self.log.debug "%d sockets after polling: %p" % [ self.sockets.length, self.sockets ]
+		self.log.debug "Got event %p" % [ event ]
+		if event
+			# self.log.debug "Got event: %p" % [ event ]
+			handler = self.sockets[ event.socket ][ :handler ]
+			handler.call( event )
+		else
+			self.log.debug "Expired: firing timers."
+			self.timers.fire
 		end
+
+		self.log.debug "%d sockets after polling: %p" % [ self.sockets.length, self.sockets ]
+	rescue Interrupt
+		raise unless ignore_interrupts
+		self.log.debug "Interrupted."
+		return nil
+	rescue Errno::EAGAIN, Errno::EWOULDBLOCK
+		raise unless ignore_eagain
+		self.log.debug "EAGAIN"
+		return nil
 	end
 
 

data/spec/cztop/reactor_spec.rb

@@ -9,6 +9,13 @@ require 'cztop/reactor'
 describe CZTop::Reactor do
 
 	let( :reactor ) { described_class.new }
+	let( :handler_class ) do
+		Class.new do
+			def handle_io_event(ev); end
+			def handle_monitor_event(ev); end
+		end
+	end
+	let( :handler_object ) { handler_class.new }
 
 
 	describe "socket registration" do
@@ -42,10 +49,22 @@ describe CZTop::Reactor do
 		end
 
 
-		it "errors if no block is given when registering a socket" do
+		it "allows a socket to be registered with a handler object instead of a block" do
+			expect( reactor ).to_not be_registered( socket )
+			expect( reactor ).to_not have_event_enabled( socket, :read )
+			expect( reactor ).to_not have_event_enabled( socket, :write )
+
+			reactor.register( socket, :read, :write, handler_object )
+
+			expect( reactor ).to be_registered( socket )
+			expect( reactor ).to have_event_enabled( socket, :read )
+			expect( reactor ).to have_event_enabled( socket, :write )
+		end
+
+		it "errors if no block or handler object is given when registering a socket" do
 			expect {
 				reactor.register( socket, :read )
-			}.to raise_error( LocalJumpError, /no handler/i )
+			}.to raise_error( LocalJumpError, /no block or handler/i )
 		end
 
 
@@ -107,6 +126,64 @@ describe CZTop::Reactor do
 	end
 
 
+	describe "handler registration" do
+
+		let( :reader ) do
+			sock = CZTop::Socket::PAIR.new( '@inproc://callback-test' )
+			sock.options.linger = 0
+			sock
+		end
+		let( :writer ) do
+			sock = CZTop::Socket::PAIR.new( '>inproc://callback-test' )
+			sock.options.linger = 0
+			sock
+		end
+
+		after( :each ) do
+			reader.close
+			writer.close
+		end
+
+
+		it "calls a callback when a registered socket becomes readable" do
+			callback_called = false
+			data = nil
+
+			reactor.register( reader, :read ) do |event|
+				expect( event ).to be_a( CZTop::Reactor::Event )
+				expect( event ).to be_readable
+				expect( event ).to_not be_writable
+				expect( event.socket ).to equal( reader )
+
+				event.socket.receive
+				callback_called = true
+			end
+
+			writer << "stuff"
+
+			reactor.poll_once
+
+			expect( callback_called ).to be_truthy
+		end
+
+
+		it "calls #handle_io_event on a handler object when a socket becomes readable" do
+			handler_object = Object.new
+			expect( handler_object ).to receive( :handle_io_event ) do |event|
+				expect( event ).to be_a( CZTop::Reactor::Event )
+				expect( event ).to be_readable
+				expect( event ).to_not be_writable
+				expect( event.socket ).to equal( reader )
+			end
+
+			reactor.register( reader, :read, handler_object )
+			writer << "stuff"
+			reactor.poll_once
+		end
+
+	end
+
+
 	describe "timer registration" do
 
 		it "allows a callback to be called after a certain amount of time" do
@@ -143,6 +220,26 @@ describe CZTop::Reactor do
 			end
 		end
 
+
+		it "can create and register a monitor with a handler object instead of a block" do
+			socket = CZTop::Socket::REP.new
+			begin
+				monitor = reactor.register_monitor( socket, handler_object ) {}
+				expect( monitor ).to be_a( CZTop::Monitor )
+				expect( reactor ).to be_registered( monitor.actor )
+			ensure
+				monitor.terminate if monitor
+			end
+		end
+
+
+		it "raises an error when registering a monitor with no callback or handler object" do
+			socket = CZTop::Socket::REP.new
+			expect {
+				reactor.register_monitor( socket )
+			}.to raise_error( LocalJumpError, /no block or handler/i )
+		end
+
 	end
 
 
@@ -176,6 +273,41 @@ describe CZTop::Reactor do
 		end
 
 
+		it "doesn't trap interrupts by default" do
+			expect( CZTop::Poller::ZMQ ).to receive( :poller_wait ).
+				and_raise( Interrupt.new )
+
+			expect {
+				reactor.poll_once
+			}.to raise_error( Interrupt )
+		end
+
+
+		it "has an option to ignore interrupts if you're doing your own signal-handling'" do
+			expect( CZTop::Poller::ZMQ ).to receive( :poller_wait ).
+				and_raise( Interrupt.new )
+
+			expect( reactor.poll_once(ignore_interrupts: true) ).to be_nil
+		end
+
+
+		it "ignores EAGAIN/EWOULDBLOCK by default" do
+			expect( CZTop::Poller::ZMQ ).to receive( :poller_wait ).
+				and_raise( Errno::EWOULDBLOCK.new )
+
+			expect( reactor.poll_once ).to be_nil
+		end
+
+
+		it "has an option to propagate EGAIN/EWOULDBLOCK" do
+			expect( CZTop::Poller::ZMQ ).to receive( :poller_wait ).
+				and_raise( Errno::EAGAIN.new )
+
+			expect {
+				reactor.poll_once( ignore_eagain: false )
+			}.to raise_error( Errno::EAGAIN )
+		end
+
 	end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cztop-reactor
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre20170316155217
+  version: 0.1.0.pre20170323172345
 platform: ruby
 authors:
 - Michael Granger
@@ -35,7 +35,7 @@ cert_chain:
   w8aNA5re5+Rt/Vvjxj5AcEnZnZiz5x959NaddQocX32Z1unHw44pzRNUur1GInfW
   p4vpx2kUSFSAGjtCbDGTNV2AH8w9OU4xEmNz8c5lyoA=
   -----END CERTIFICATE-----
-date: 2017-03-16 00:00:00.000000000 Z
+date: 2017-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability