rxio 0.13.3 → 0.13.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18ba608c0a8d8d19e8040f77ae85cbc5c2fd0b6d
-  data.tar.gz: 70abef8d3afde6333809944d1e4d0492588c5fb8
+  metadata.gz: 62f06a50cce6b403b28c09502aba950ec863fd16
+  data.tar.gz: a7b84641ff2cde46908d8afc3e4c09d03f6e8c47
 SHA512:
-  metadata.gz: 9a17f7c14d369036c8824acaf8b07106e64795b7e1a132337f833bf56b094965356e46193ffc9916228695f5e6b0c4d76453c5d3380e9636a22f4e03a10e7d74
-  data.tar.gz: 1c57bcd0d701215adbb8ba75096fa9971c0fc4850d7f2800adffadc273394b6c90b452799aab2a80d50383b9b8d29c28cc9a9f7720ae8fa7304f771ee869e148
+  metadata.gz: 673842e6d6b54ba630e1bc0f9c6170c7aec543bf98ac171cf55821c22339a69ada60062b2c9dbbfa4a7486e31fb25ebd88eeed03e80e91bc3cd0a08832838d56
+  data.tar.gz: f661465b2dc21407b63c38068441d1e6148c064b4d15d5233488eb147d832b409e681e03d9b69ea772b17aecb6881432bea957670ee61c6530ba88d66b589c88

data/README.md

@@ -309,6 +309,20 @@ es.shutdown
 puts 'Client has terminated!'
 ```
 
+### Dealing with Client 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.
+It can be overloaded to provide custom functionality upon client errors.
+
+```ruby
+# Default implementation for 'client_error'
+def client_error c, e
+	puts "[!] ERROR [#{c[:peer][:addr]}:#{c[:peer][:name]}] - #{e}"
+	c[:sock].close rescue nil
+end
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/rxio/client.rb

@@ -29,9 +29,9 @@ module RxIO
 
 		# Construct
 		# Builds a *Client* around a given _service_handler_ module, set to connect to _addr_ on _port_.
-		# @param [String] addr
-		# @param [Fixnum] port
-		# @param [Module] service_handler
+		# @param [String] addr Address to which the client should connect
+		# @param [Fixnum] port Port on which the client should connect
+		# @param [Module] service_handler Module implementing service client logic
 		def initialize addr, port, service_handler
 
 			# Set Address & Port

data/lib/rxio/service.rb

@@ -26,9 +26,9 @@ module RxIO
 
 		# Construct
 		# Builds a *Service* around a given _service_handler_ module, set to listen for incoming connections @ _addr_ on _port_.
-		# @param [String] addr
-		# @param [Fixnum] port
-		# @param [Module] service_handler
+		# @param [String] addr Address on which the service should listen
+		# @param [Fixnum] port Port on which the service should listen
+		# @param [Module] service_handler Module implementing the service logic
 		def initialize addr, port, service_handler
 
 			# Set Address & Port
@@ -107,7 +107,7 @@ module RxIO
 		# Register Client
 		# Creates a new Client around a given socket _s_ and registers it.
 		# Also, notifies the Handler Module if the _on_join_ method is available.
-		# @param [TCPSocket] s
+		# @param [TCPSocket] s The new client's network socket
 		def add_client s
 
 			# Register Socket
@@ -148,7 +148,7 @@ module RxIO
 		# Accept Socket
 		# Tries to accept any queued connection request in a non-blocking manner.
 		# Registers a new Client through _add_client_ around the newly-accepted socket if present.
-		# @param [TCPServer] s
+		# @param [TCPServer] s The service's listening socket
 		def acpt_sock s
 
 			# Accept
@@ -160,7 +160,7 @@ module RxIO
 
 		# Get Endpoint for Socket - Callback for IOBase
 		# Finds the Client associated with a given Socket
-		# @param [TCPSocket] s
+		# @param [TCPSocket] s Any socket
 		# @return [Hash] The Endpoint associated with Socket _s_, or nil
 		def get_endpoint_for_sock s
 			@cmap[s]
@@ -168,7 +168,7 @@ module RxIO
 
 		# On Drop - Callback for IOBase
 		# Unregisters a Client and closes the associated socket.
-		# @param [Hash] c
+		# @param [Hash] c Client Hash
 		def on_drop c
 
 			# Drop Client
@@ -179,5 +179,14 @@ module RxIO
 			# Kill Socket
 			c[:sock].close rescue nil
 		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][:name]}] - #{e}"
+			c[:sock].close rescue nil
+		end
 	end
 end

data/lib/rxio/version.rb

@@ -5,5 +5,5 @@
 module RxIO
 
 	# Version
-	VERSION = '0.13.3'
+	VERSION = '0.13.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rxio
 version: !ruby/object:Gem::Version
-  version: 0.13.3
+  version: 0.13.4
 platform: ruby
 authors:
 - Eresse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-24 00:00:00.000000000 Z
+date: 2017-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler