plezi 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2bd42dabd7c03ae27f9003f19fb7b128c86a01e
-  data.tar.gz: 01f3b6fb4a4915d4dc7ce053e85ab9447688cdd8
+  metadata.gz: 1e948ea3cceaa995b5dc7a9c496432e5ef1c0660
+  data.tar.gz: 9c70d2dbb9291d65500daa109a751e6228785d50
 SHA512:
-  metadata.gz: 91abf0160f443aa3a97fce4f3d107656d1afd79c4aaeb5d608b4b1aa506687248830cc36fe302c8d91f467d6059499d117d638d7aae47a525eb5c688a6ed4d0e
-  data.tar.gz: 12c0442612e8806bf5307b819bcf44f3536670c5135f3f93ff7120a1420652a0dbd072bb9ddf96093de3d8818d9e95a505ff93446f9bd94d88d72742cfba11a8
+  metadata.gz: 9ef50d068ce5fb0f806d7216daea2cd458b4aa5d93534ca56d2a15b7f2324e9638f1e7dbf3318accf957bd59f691b2bcfc45a82a3ea0db6e570d479cfa5af3da
+  data.tar.gz: eb1ca84b326181a96bab242927640c1d4fc1663db4ce6f433b1d4d386dd7cc748fc923bf97c948a076c032212c9ddc41931f4254951969db828a8fd85dc36802

data/CHANGELOG.md

@@ -1,4 +1,13 @@
 #Change Log
+
+***
+
+Change log v.0.8.3
+
+**Auto-ping feature**: WebSocket connections now automatically send a `ping` every ~45 seconds (approximately) before the websocket's connection would timeout. This auto-ping will keep the connection alive even if no data is exchanged.
+
+**Minor performance updates**: Disconnection workflow was slightly optimized. Also, medium and small websocket messages (less than 131,072 UTF-8 characters) should be faster to handle.
+
 ***
 
 Change log v.0.8.2

data/lib/plezi/eventmachine/connection.rb

@@ -39,7 +39,7 @@ module Plezi
 
 			def clear?
 				return false unless timedout? || disconnected?
-				disconnect
+				close
 				true
 			end
 
@@ -58,15 +58,21 @@ module Plezi
 				@socket
 			end
 
+			# the proc used to remove the connection from the IO stack.
+			REMOVE_CONNECTION_PROC = Proc.new {|old_io| EventMachine.remove_io old_io }
 			# sends data immidiately - forcing the data to be sent, flushing any pending messages in the que
 			def send data = nil
 				return false unless @out_que.any? || data
-				@locker.synchronize do
-					unless @out_que.empty?
-						@out_que.each { |d| _send d rescue disconnect }
-						@out_que.clear					
+				begin				
+					@locker.synchronize do
+						unless @out_que.empty?
+							@out_que.each { |d| _send d }
+							@out_que.clear					
+						end
+						(_send data rescue disconnect) if data
 					end
-					(_send data rescue disconnect) if data
+				rescue => e
+					EventMachine.queue( [@socket], REMOVE_CONNECTION_PROC)
 				end
 			end
 
@@ -89,43 +95,31 @@ module Plezi
 			# makes sure any data in the que is send and calls `flush` on the socket, to make sure the buffer is sent.
 			def flush
 				send
-				io.flush
+				io.flush rescue true
 			end
 
-			# the proc used to remove the connection from the IO stack.
-			REMOVE_CONNECTION_PROC = Proc.new {|old_io| EventMachine.remove_io old_io }
-			# called once a socket is disconnected or needs to be disconnected.
+			# called once the connection is closed.
+			#
 			def on_disconnect
-				EventMachine.queue [@socket], REMOVE_CONNECTION_PROC
 				@locker.synchronize do
-					@out_que.each { |d| _send d rescue true}
-					@out_que.clear
-					io.flush rescue true
-					io.close rescue true
+					EventMachine.queue [], protocol.method(:on_disconnect) if protocol && !protocol.is_a?(Class)
+					@protocol = false
 				end
-				EventMachine.queue [], protocol.method(:on_disconnect) if protocol && !protocol.is_a?(Class)
 			end
+			# closes the connection.
+			def close
+				flush
+				EventMachine.queue [@socket], REMOVE_CONNECTION_PROC
+			end
+			alias :disconnect :close
 
 			# status markers
 
-			# closes the connection
-			def close
-				@locker.synchronize do
-					io.flush rescue true
-					io.close rescue true
-				end
-			end
 			# returns true if the service is disconnected
 			def disconnected?
 				(@socket.closed? || socket.stat.mode == 0140222) rescue true # if mode is read only, it's the same as closed.
 			end
-			# the async disconnect proc
-			FIRE_DISCONNECT_PROC = Proc.new {|handler| handler.on_disconnect }
-			# disconects the service.
-			def disconnect
-				@out_que.clear
-				EventMachine.queue [self], FIRE_DISCONNECT_PROC
-			end
+
 			# returns true if the socket has content to be read.
 			def has_incoming_data?
 				 (@socket.stat.size > 0) rescue false

data/lib/plezi/eventmachine/io.rb

@@ -5,10 +5,10 @@ module Plezi
 		class BasicIO
 
 			# attribute readers
-			attr_reader :io, :params
+			attr_reader :io, :params, :protocol
 			# initialize the listener with the actual socket and the properties.
 			def initialize io, params
-				@io, @params = io, params
+				@io, @params, @protocol = io, params, false
 			end
 			# returns true if the socket is closed and the object can be cleared.
 			def clear?
@@ -29,6 +29,13 @@ module Plezi
 					Plezi.error e
 				end
 			end
+			def on_disconnect
+				true
+			end
+			def close
+				false
+			end
+			alias :disconnect :close
 		end
 		module_function
 
@@ -47,9 +54,11 @@ module Plezi
 			IO_LOCKER.synchronize { EM_IO[io] = job }
 		end
 
+		# the proc for async IO removal, in case of IO exceptions raised by unexpectedly closed sockets.
+		IO_CLEAR_ASYNC_PROC = Proc.new {|c| c.on_disconnect rescue false }
 		# removes an IO from the event machine.
 		def remove_io io
-			IO_LOCKER.synchronize { (EM_IO.delete io).close rescue true }
+			IO_LOCKER.synchronize { queue [(EM_IO.delete io)], IO_CLEAR_ASYNC_PROC; (io.close unless io.closed? rescue true);  }
 		end
 
 		# deletes any connections that are closed or timed out.
@@ -64,7 +73,7 @@ module Plezi
 
 		# stops all the connections without stopping the lisntener IO's.
 		def stop_connections
-			IO_LOCKER.synchronize { EM_IO.each { |io, c| Plezi.run_async { c.disconnect rescue true }  } }
+			IO_LOCKER.synchronize { EM_IO.each { |io, c| c.close } }
 		end
 
 		# set the default idle waiting time.
@@ -89,9 +98,6 @@ module Plezi
 			@io_timeout = value
 		end
 
-		# the proc for async IO removal, in case of IO exceptions raised by unexpectedly closed sockets.
-		IO_CLEAR_ASYNC_PROC = Proc.new {|c| c.protocol.on_disconnect if (c.protocol rescue false) }
-
 		# hangs for IO data or io_timeout
 		def review_io
 			return false if IO_LOCKER.locked?

data/lib/plezi/handlers/controller_magic.rb

@@ -52,6 +52,15 @@ module Plezi
 			def accepts_broadcast?
 				@_accepts_broadcast
 			end
+			# sets the controller to refuse "broadcasts".
+			#
+			# This allows some websocket connections to isolate themselves even before they are fully disconnected.
+			#
+			# call this method once it is clear the websocket connection should be terminated.
+			def refuse_broadcasts
+				@_accepts_broadcast = false
+				self
+			end
 
 			# this method does two things.
 			#

data/lib/plezi/server/websocket.rb

@@ -57,7 +57,7 @@ module Plezi
 		# called when a disconnect is fired
 		# (socket was disconnected / connection should be disconnected / shutdown / socket error)
 		def on_disconnect
-			Plezi.log_raw "#{@request[:client_ip]} [#{Time.now.utc}] - #{@connection.object_id} Websocket disconnected.\n"
+			# Plezi.log_raw "#{@request[:client_ip]} [#{Time.now.utc}] - #{@connection.object_id} Websocket disconnected.\n"
 			Plezi::EventMachine.queue [@connection.handler], ON_DISCONNECT_PROC if @connection.handler.methods.include?(:on_disconnect)
 		end
 

data/lib/plezi/server/ws_response.rb

@@ -17,8 +17,11 @@ module Plezi
 		#the request.
 		attr_accessor :request
 
+		PING_PROC = Proc.new {|res| EventMachine.timed_job 45, 1, [res.ping], PING_PROC unless res.service.disconnected? }
+
 		def initialize request
 			@request, @service = request,request.service
+			PING_PROC.call(self)
 		end
 
 		# sends data through the websocket connection in a non-blocking way.
@@ -27,7 +30,7 @@ module Plezi
 		#
 		# This should be the preferred way.
 		def << str
-			service.send_nonblock self.class.frame_data(str.dup)
+			service.send_nonblock self.class.frame_data(str)
 			self
 		end
 
@@ -36,19 +39,19 @@ module Plezi
 		# Plezi will try a best guess at the type of the data (binary vs. clear text).
 		#
 		def send str
-			service.send self.class.frame_data(str.dup)
+			service.send self.class.frame_data(str)
 			self
 		end
 		# sends binary data through the websocket connection in a blocking way.
 		#
 		def binsend str
-			service.send self.class.frame_data(str.dup, 2)
+			service.send self.class.frame_data(str, 2)
 			self
 		end
 		# sends clear text data through the websocket connection in a blocking way.
 		#
 		def txtsend str
-			service.send self.class.frame_data(str.dup, 1)
+			service.send self.class.frame_data(str, 1)
 			self
 		end
 
@@ -72,19 +75,28 @@ module Plezi
 
 		# sends any pending data and closes the connection.
 		def close
-			service.send_nonblock self.class.frame_data('', 8)
-			service.disconnect
+			service.send self.class.frame_data('', 8)
+			service.close
 		end
 
+		FRAME_SIZE_LIMIT = 131_072
+
 		# Dangerzone! ()alters the string, use `send` instead: formats the data as one or more WebSocket frames.
 		def self.frame_data data, op_code = nil, fin = true
 			# set up variables
 			frame = ''.force_encoding('binary')
 			op_code ||= (data.encoding.name == 'UTF-8' ? 1 : 2)
-			data.force_encoding('binary')
 
-			# fragment big data chuncks into smaller frames - op-code reset for 0 for all future frames.
-			[frame << frame_data(data.slice!(0..1048576), op_code, false), op_code = 0] while data.length > 1048576
+
+			if data[FRAME_SIZE_LIMIT]
+				# fragment big data chuncks into smaller frames - op-code reset for 0 for all future frames.
+				data = data.dup
+				data.force_encoding('binary')
+				[frame << frame_data(data.slice!(0..FRAME_SIZE_LIMIT), op_code, false), op_code = 0] while data.length > FRAME_SIZE_LIMIT # 1048576
+				# frame << frame_data(data.slice!(0..1048576), op_code, false)
+				# data = 
+				# op_code = 0
+			end
 
 			# apply extenetions to the frame
 			ext = 0
@@ -103,7 +115,9 @@ module Plezi
 				frame << 127.chr
 				frame << [data.length].pack('Q>')
 			end
+			frame.force_encoding(data.encoding)
 			frame << data
+			frame.force_encoding('binary')
 			frame
 		end
 	end

data/lib/plezi/version.rb

@@ -1,3 +1,3 @@
 module Plezi
-    VERSION = "0.8.2"
+    VERSION = "0.8.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plezi
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-29 00:00:00.000000000 Z
+date: 2015-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler