rxio 0.13.5 → 0.13.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2483582cc33b26a5a390939ea4982d3c65d2875
-  data.tar.gz: f8ed5185e48b2f1bd2a83b5e11cb7b7c5be65b36
+  metadata.gz: b1b13f7c2a5d6f073bbc1faca1e077ca3a5586e8
+  data.tar.gz: fb55abf384c23c250df0141443251392e0dd10fc
 SHA512:
-  metadata.gz: f7bf6ab91a394e2f5b89266e9f991c558aff97dd693cb6dd62cee7b63e4f374691e366c124fdf9d5d7f23076c5181db4caa1afd1bb03de250c1608b2edb09f90
-  data.tar.gz: 30f9be8aeb50ec8c440b89c1c684402671038ddf2bdab4787eff5ae186c73f9fc88faa12e64fa472f3cf9313d2137ac0e12ff2ed070a5f10e4f747482976dc99
+  metadata.gz: ff03cb6cba5758bd1e5709848378dbc50098b516eafa069229cc9fd47d84a8286e4944d24924cb660f352da1223fdf05e678758e9fbccc5fc83affd36d4d777f
+  data.tar.gz: 32dd7a9f0da6a006d156ce040714b7630f86e77b66cc46102c394b51cea3b9fcc6e24f35cc6d665c9616fc3f34534ebbac43cd657d2b29bae926a29d98108815

data/README.md

@@ -309,22 +309,25 @@ es.shutdown
 puts 'Client has terminated!'
 ```
 
-### Dealing with Client Errors 
+### Dealing with Peer Errors 
 
-Whenever an error occurs as the result of handling a client's message should can be logged through the *client_error* method in *RxIO::Service*.
-The default implementation of this method simply spits out the error on STDOUT and drops the client.
+Whenever an error occurs as the result of handling a peer's message, it should be notified through the *peer_error* method in *RxIO::IOBase* (included in *RxIO::Service*).
+The default implementation of this method simply spits out the error on STDOUT and drops the peer.
 It can be overloaded to provide custom functionality such as proper logging or more complex logic.
 
 ```ruby
-# Default implementation for 'client_error'
-def client_error c, e
-	puts "[!] ERROR [#{c[:peer][:addr]}:#{c[:peer][:port]}] - #{e}"
-	drop_endpoint c
+# Default implementation for 'peer_error'
+def peer_error p, e
+	puts "[!] ERROR [#{p[:peer][:addr]}:#{p[:peer][:port]}] - #{e}"
+	drop_endpoint p
 end
 ```
 
 Usage:
 
+While the actual 'peer_error' method can be publicly called on any class that includes the *RxIO::IOBase* Module, it is normally not necessary.
+In fact, calls to both the *filter_input* & *handle_msg* callback methods (to be implemented in the Service Handler Module) are wrapped within a *begin* / *rescue* block which will call *peer_error* for any exception raised during either parsing or processing of messages.
+
 ```ruby
 #!/usr/bin/env ruby
 
@@ -344,7 +347,10 @@ class EchoService < RxIO::Service
 		def self.handle_msg client, msg
 		
 			# Everything is an error
-			client[:serv].on_error client, 'Invalid Message Structure'
+			raise 'Invalid Message Structure'
+			
+			# Equivalent to:
+			# return client[:serv].peer_error client, msg
 		end
 	end
 end

data/lib/rxio/io_base.rb

@@ -16,11 +16,21 @@ module RxIO
 		# @param [String] chunk A chunk of data, as received by the socket
 		def process_input endpoint, chunk
 
-			# Pass through Service Handler Module
-			@service_handler.filter_input endpoint, chunk
+			# Begin
+			begin
 
-			# Process Messages
-			@service_handler.handle_msg endpoint, endpoint[:msgs].shift until endpoint[:msgs].empty? || endpoint[:dying]
+				# Pass through Service Handler Module
+				@service_handler.filter_input endpoint, chunk
+
+				# Process Messages
+				@service_handler.handle_msg endpoint, endpoint[:msgs].shift until endpoint[:msgs].empty?
+
+			# Rescue
+			rescue Exception => e
+
+				# Peer Error
+				peer_error endpoint, e
+			end
 		end
 
 		# Read Socket
@@ -69,14 +79,20 @@ module RxIO
 		# @param [Hash] endpoint
 		def drop_endpoint endpoint
 
-			# Mark as Dying
-			endpoint[:dying] = true
-
 			# Notify Service Handler
 			@service_handler.on_drop endpoint if @service_handler.respond_to? :on_drop
 
 			# Drop Endpoint
 			on_drop endpoint
 		end
+
+		# Peer Error
+		# Handles an Error from a Peer
+		# @param [Hash] p Endpoint Hash
+		# @param [String] e Error String
+		def peer_error p, e
+			puts "[!] ERROR [#{p[:peer][:addr]}:#{p[:peer][:port]}] - #{e}"
+			drop_endpoint p
+		end
 	end
 end

data/lib/rxio/service.rb

@@ -86,15 +86,6 @@ module RxIO
 			@stop = true
 		end
 
-		# Client Error
-		# Handles an Error from a Client
-		# @param [Hash] c Client Hash
-		# @param [String] e Error String
-		def client_error c, e
-			puts "[!] ERROR [#{c[:peer][:addr]}:#{c[:peer][:port]}] - #{e}"
-			drop_endpoint c
-		end
-
 		# Privates
 		private
 

data/lib/rxio/version.rb

@@ -5,5 +5,5 @@
 module RxIO
 
 	# Version
-	VERSION = '0.13.5'
+	VERSION = '0.13.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rxio
 version: !ruby/object:Gem::Version
-  version: 0.13.5
+  version: 0.13.6
 platform: ruby
 authors:
 - Eresse