rxio 0.13.6 → 0.13.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1b13f7c2a5d6f073bbc1faca1e077ca3a5586e8
-  data.tar.gz: fb55abf384c23c250df0141443251392e0dd10fc
+  metadata.gz: 7ba978c3b4a32fa7123729faa8a8ef9b9a349f3d
+  data.tar.gz: ae1ba6d9308798d554e1420a611ba84cebdf0f69
 SHA512:
-  metadata.gz: ff03cb6cba5758bd1e5709848378dbc50098b516eafa069229cc9fd47d84a8286e4944d24924cb660f352da1223fdf05e678758e9fbccc5fc83affd36d4d777f
-  data.tar.gz: 32dd7a9f0da6a006d156ce040714b7630f86e77b66cc46102c394b51cea3b9fcc6e24f35cc6d665c9616fc3f34534ebbac43cd657d2b29bae926a29d98108815
+  metadata.gz: cb4749f998fc6afc4b4919c2944edd1bdc8d105bd2ad4fef25a70fd6e7c603bc56da7cab752a40d3f94a857399c2926bb82b0eaced70f9a5c613ff0f504556f4
+  data.tar.gz: 91f54ed3418905a5704beda6ecdb900b64b84408dcfcd0b9f741003e2fdd85475b54eabe7d2c85ebdaa2f3981b54e2d9bed07fb23ac6a60afd64b9e72c064fbf

data/lib/rxio/client.rb

@@ -27,7 +27,7 @@ module RxIO
 		# Select Timeout (seconds)
 		SELECT_TIMEOUT = 0.1
 
-		# Construct
+		# Construct:
 		# Builds a *Client* around a given _service_handler_ module, set to connect to _addr_ on _port_.
 		# @param [String] addr Address to which the client should connect
 		# @param [Fixnum] port Port on which the client should connect
@@ -54,8 +54,8 @@ module RxIO
 			}
 		end
 
-		# Send Message
-		# Enqueues a Message to be sent to the server
+		# Send Message:
+		# Enqueues a Message to be sent to the server.
 		# @param [String] msg
 		def send_msg msg
 
@@ -66,7 +66,7 @@ module RxIO
 			@service_handler.send_msg @client, msg
 		end
 
-		# Run
+		# Run:
 		# Executes the main client loop, taking care of I/O scheduling and message handling.
 		def run
 
@@ -85,9 +85,9 @@ module RxIO
 			@sock = nil
 		end
 
-		# Stop
+		# Stop:
 		# Requests the client loop to stop executing.
-		# The _run_ method should return shortly after calling _stop_
+		# The _run_ method should return shortly after calling _stop_.
 		def stop
 			@stop = true
 		end
@@ -95,7 +95,7 @@ module RxIO
 		# Privates
 		private
 
-		# Update
+		# Update:
 		# Serves as the client loop main method, performing I/O scheduling and message handling.
 		def update
 
@@ -110,8 +110,8 @@ module RxIO
 			wr.each { |s| write_sock s } if wr
 		end
 
-		# Ensure Socket is available
-		# Re-creates the socket in the event of failure
+		# Ensure Socket is available:
+		# Re-creates the socket in the event of failure.
 		def ensure_sock
 
 			# Check
@@ -146,16 +146,16 @@ module RxIO
 			@sock
 		end
 
-		# Get Endpoint for Socket - Callback for IOBase
-		# Simply returns the Client Hash
+		# Get Endpoint for Socket - Callback for IOBase:
+		# Simply returns the Client Hash.
 		# @param [TCPSocket] _s
 		# @return [Hash] The Client Hash
 		def get_endpoint_for_sock _s
 			@client
 		end
 
-		# On Drop - Callback for IOBase
-		# Kills the socket
+		# On Drop - Callback for IOBase:
+		# Kills the socket.
 		# @param [Hash] _e
 		def on_drop _e
 			@sock.close rescue nil

data/lib/rxio/handler_base.rb

@@ -4,11 +4,11 @@
 # RxIO Module
 module RxIO
 
-	# Handler Base Module
+	# Handler Base Module:
 	# Provides common abstractions to Service Handler implementations.
 	module HandlerBase
 
-		# Write
+		# Write:
 		# Writes one or more chunks of data to the endpoint's output buffer (:obuf).
 		# @param [Hash] endpoint
 		# @param [String] data One or more chunks of data to be written to the ouput buffer
@@ -18,7 +18,7 @@ module RxIO
 			data.each { |c| endpoint[:lock].synchronize { endpoint[:obuf] << c } }
 		end
 
-		# Buffer Input Chunk
+		# Buffer Input Chunk:
 		# Writes a chunk of data to the endpoint's input buffer (:ibuf).
 		# @param [Hash] endpoint
 		# @param [String] chunk

data/lib/rxio/io_base.rb

@@ -10,8 +10,8 @@ module RxIO
 		# Chunk Size
 		CHUNK_SIZE = 1024
 
-		# Process Input
-		# Processes Input for an Endpoint, in the form of a data chunk
+		# Process Input:
+		# Processes Input for an Endpoint, in the form of a data chunk.
 		# @param [Hash] endpoint
 		# @param [String] chunk A chunk of data, as received by the socket
 		def process_input endpoint, chunk
@@ -25,7 +25,10 @@ module RxIO
 				# Process Messages
 				@service_handler.handle_msg endpoint, endpoint[:msgs].shift until endpoint[:msgs].empty?
 
-			# Rescue
+				# Sub-Process Input
+				@service_handler.subprocess_input endpoint if @service_handler.respond_to? :subprocess_input
+
+				# Rescue
 			rescue Exception => e
 
 				# Peer Error
@@ -33,7 +36,7 @@ module RxIO
 			end
 		end
 
-		# Read Socket
+		# Read Socket:
 		# Attempts to read as many bytes as possible (up to CHUNK_SIZE) from a given socket _s_, passing the data chunks to _process_input_.
 		# @param [TCPSocket] s
 		def read_sock s
@@ -54,7 +57,7 @@ module RxIO
 			process_input e, chunk
 		end
 
-		# Write Socket
+		# Write Socket:
 		# Attempts to write as many bytes as possible to a given socket _s_ from the associated client's output buffer.
 		# @param [TCPSocket] s
 		def write_sock s
@@ -74,8 +77,8 @@ module RxIO
 			end
 		end
 
-		# Drop Endpoint
-		# Notifies the Service Handler and Parent Implementation (in that order) of a dropped endpoint
+		# Drop Endpoint:
+		# Notifies the Service Handler and Parent Implementation (in that order) of a dropped endpoint.
 		# @param [Hash] endpoint
 		def drop_endpoint endpoint
 
@@ -86,12 +89,12 @@ module RxIO
 			on_drop endpoint
 		end
 
-		# Peer Error
-		# Handles an Error from a Peer
+		# 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}"
+			puts "[!] ERROR [#{p[:peer][:addr]}:#{p[:peer][:port]}] - #{e} - #{e.backtrace.collect { |b| " * #{b}" }.join "\n"}"
 			drop_endpoint p
 		end
 	end

data/lib/rxio/io_filters/bin_delim.rb

@@ -10,7 +10,7 @@ module RxIO
 	# I/O Filters Module
 	module IOFilters
 
-		# Binary-Delimiter I/O Filter
+		# Binary-Delimiter I/O Filter:
 		# Splits messages according to a given fixed *binary delimiter*, which can be any number of bytes, defined through the _msg_delim_ method.
 		module BinDelim
 
@@ -20,14 +20,14 @@ module RxIO
 				base.extend RxIO::HandlerBase
 			end
 
-			# Set Message Delimiter
+			# Set Message Delimiter:
 			# Used to define the binary string used as message delimiter for this protocol.
 			# @param [String] v The message delimiter string
 			def msg_delim v
 				@msg_delim = v
 			end
 
-			# Filter Input
+			# Filter Input:
 			# Buffers data chunks sent by the endpoint and extracts messages from them, according to the delimiter defined through _msg_delim_.
 			# @param [Hash] endpoint
 			# @param [String] chunk
@@ -59,7 +59,7 @@ module RxIO
 				end
 			end
 
-			# Send Message
+			# Send Message:
 			# Buffers a message to be sent to the endpoint, after wrapping it according to the delimiter defined through _msg_delim_.
 			# @param [Hash] endpoint
 			# @param [String] msg

data/lib/rxio/io_filters/msg_size.rb

@@ -13,7 +13,7 @@ module RxIO
 	# I/O Filters Module
 	module IOFilters
 
-		# Message-Size I/O Filter
+		# Message-Size I/O Filter:
 		# Splits messages according to a _4-byte unsigned big-endian integer_ *size* field, which prefixes every message and indicates its length in bytes.
 		module MsgSize
 
@@ -23,7 +23,7 @@ module RxIO
 				base.extend RxIO::HandlerBase
 			end
 
-			# Filter Input
+			# Filter Input:
 			# Buffers data chunks sent by the endpoint and extracts messages from them, according to the *size* field present at the beginning of each message.
 			# @param [Hash] endpoint
 			# @param [String] chunk
@@ -52,7 +52,7 @@ module RxIO
 				end
 			end
 
-			# Send Message
+			# Send Message:
 			# Buffers a message to be sent to the endpoint, after prefixing it with a _size_ field.
 			# @param [Hash] endpoint
 			# @param [String] msg

data/lib/rxio/io_filters.rb

@@ -8,7 +8,7 @@ require 'rxio/io_filters/msg_size'
 # RxIO Module
 module RxIO
 
-	# I/O Filters Module
+	# I/O Filters Module:
 	# This module provides a set of generic I/O Filters to be used for constructing services.
 	module IOFilters
 	end

data/lib/rxio/service.rb

@@ -24,7 +24,7 @@ module RxIO
 		# Select Timeout (seconds)
 		SELECT_TIMEOUT = 0.1
 
-		# Construct
+		# Construct:
 		# Builds a *Service* around a given _service_handler_ module, set to listen for incoming connections @ _addr_ on _port_.
 		# @param [String] addr Address on which the service should listen
 		# @param [Fixnum] port Port on which the service should listen
@@ -48,9 +48,9 @@ module RxIO
 			@cmap = {}
 		end
 
-		# Run
+		# Run:
 		# Executes the main service loop, taking care of I/O scheduling, client management and message handling.
-		# Note: this method blocks until the service loop terminates.
+		# This method blocks until the service loop terminates.
 		def run
 
 			# Update Loop
@@ -79,9 +79,9 @@ module RxIO
 			@serv = nil
 		end
 
-		# Stop
+		# Stop:
 		# Requests the service loop to stop executing.
-		# The _run_ method should return shortly after calling _stop_
+		# The _run_ method should return shortly after calling _stop_.
 		def stop
 			@stop = true
 		end
@@ -89,7 +89,7 @@ module RxIO
 		# Privates
 		private
 
-		# Update
+		# Update:
 		# Serves as the service loop main method, performing I/O scheduling, client management and message handling.
 		def update
 
@@ -104,7 +104,7 @@ module RxIO
 			wr.each { |s| write_sock s } if wr
 		end
 
-		# Register Client
+		# 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 The new client's network socket
@@ -145,7 +145,7 @@ module RxIO
 			@service_handler.on_join c if @service_handler.respond_to? :on_join
 		end
 
-		# Accept Socket
+		# 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 The service's listening socket
@@ -158,16 +158,16 @@ module RxIO
 			add_client ns if ns
 		end
 
-		# Get Endpoint for Socket - Callback for IOBase
-		# Finds the Client associated with a given Socket
+		# Get Endpoint for Socket:
+		# Callback for IOBase - Finds the Client associated with a given Socket.
 		# @param [TCPSocket] s Any socket
 		# @return [Hash] The Endpoint associated with Socket _s_, or nil
 		def get_endpoint_for_sock s
 			@cmap[s]
 		end
 
-		# On Drop - Callback for IOBase
-		# Unregisters a Client and closes the associated socket.
+		# On Drop:
+		# Callback for IOBase - Unregisters a Client and closes the associated socket.
 		# @param [Hash] c Client Hash
 		def on_drop c
 

data/lib/rxio/version.rb

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

data/lib/rxio.rb

@@ -8,7 +8,7 @@ require 'rxio/io_filters'
 require 'rxio/service'
 require 'rxio/client'
 
-# RxIO Module
-# Root Module for RxIO
+# RxIO Module:
+# Root Module for RxIO.
 module RxIO
 end

metadata

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