ichannel 5.0.1 → 5.1.0

data/.gitattributes

@@ -0,0 +1 @@
+* text eol=lf

data/ChangeLog.txt

@@ -1,32 +1,46 @@
+== HEAD
+	…
+== v5.1.0
+	* Remove restriction on size of message.
+
+	IChannel#get can read a message of any size(before hand it was limited to 
+	1MB in size). Thanks to @quezacoatl.
+
+	* IChannel#readable? no longer blocks.
+
+	IChannel#readable? no longer blocks for 0.1 seconds on IO.select call.
+	Thanks to quezacoatl(https://github.com/quezacoatl) for the initial 
+	implementation. 
+
 == v5.0.0
 	* Remove IChannel#empty?
 	
-		I think the #readable? method is all you need, and is a much more 
-		accurate description of what the method is asking. We cannot determine
-		if the channel is really empty, but we can ask if it is readable at the 
-		time you ask.
+	I think the #readable? method is all you need, and is a much more 
+	accurate description of what the method is asking. We cannot determine
+	if the channel is really empty, but we can ask if it is readable at the 
+	time you ask.
 
 == v4.1.0
 	* Add IChannel#readable?
 
-		A method that can tell you whether or not a read would block. 
-		When it returns true, a read shouldn't block, on the other hand
-		if it were false it'd likely block by the time you call #get.
+	A method that can tell you whether or not a read would block. 
+	When it returns true, a read shouldn't block, on the other hand
+	if it were false it'd likely block by the time you call #get.
 
 == v4.0.0
 	* Modify IChannel#empty?
 
-		It now returns true in case the underlying UNIXSocket being used as a 
-		reader is closed.
+	It now returns true in case the underlying UNIXSocket being used as a 
+	reader is closed.
 
 == v3.1.0
 	* Add IChannel#empty?.
 	
-		IChannel#empty? returns true when the channel is empty(nothing to read).
+	IChannel#empty? returns true when the channel is empty(nothing to read).
 	
 	* Micro speed improvement on #write!, & #recv! operations.
 
-		By passing nil instead of creating two empty arrays for every read/write 
-		operation we should see a very small improvement in their performance.
+	By passing nil instead of creating two empty arrays for every read/write 
+	operation we should see a very small improvement in their performance.
 
 	* Add ChangeLog.txt 

data/lib/ichannel/version.rb

@@ -1,3 +1,3 @@
 class IChannel
-  VERSION = "5.0.1"
+  VERSION = "5.1.0"
 end

data/lib/ichannel.rb

@@ -1,12 +1,16 @@
 require 'socket'
 class IChannel
+  SEP = '_$_'
+  if respond_to? :private_constant
+    private_constant :SEP 
+  end
   #
   # @param [#dump,#load] serializer
   #   Any object that implements dump, & load.
-  #   
-  def initialize(serializer) 
+  #
+  def initialize(serializer)
     @reader, @writer = UNIXSocket.pair Socket::SOCK_DGRAM
-    @serializer = serializer 
+    @serializer = serializer
   end
 
   #
@@ -35,7 +39,7 @@ class IChannel
   #
   # Add an object to the channel.
   #
-  # @raise [IOError] 
+  # @raise [IOError]
   #   When the channel is closed.
   #
   # @param [Object] object
@@ -50,19 +54,19 @@ class IChannel
   # Add an object to the channel.
   #
   # Unlike {#write}, which waits indefinitely until the channel becomes writable,
-  # this method will raise an IOError when _timeout_ seconds elapse and 
+  # this method will raise an IOError when _timeout_ seconds elapse and
   # the channel remains unwritable.
   #
-  # @param 
+  # @param
   #   (see IChannel#write)
   #
   # @param [Numeric] timeout
   #   The number of seconds to wait for the channel to become writable.
   #
-  # @raise (see IChannel#write) 
+  # @raise (see IChannel#write)
   #
   # @raise [IOError]
-  #   When _timeout_ seconds elapse & the channel remains unwritable.  
+  #   When _timeout_ seconds elapse & the channel remains unwritable.
   #
   def write!(object, timeout = 0.1)
     if @writer.closed?
@@ -70,7 +74,8 @@ class IChannel
     end
     _, writable, _ = IO.select nil, [@writer], nil, timeout
     if writable
-      writable[0].syswrite @serializer.dump(object)
+      msg = @serializer.dump(object)
+      writable[0].syswrite "#{msg}#{SEP}"
     else
       raise IOError, 'The channel cannot be written to.'
     end
@@ -85,7 +90,7 @@ class IChannel
   #
   # @return [Object]
   #   The object read from the channel.
-  #   
+  #
   def recv
     recv!(nil)
   end
@@ -94,19 +99,19 @@ class IChannel
   #
   # Receive an object from the channel.
   #
-  # Unlike {#recv}, which waits indefinitely until the channel becomes readable, 
-  # this method will raise an IOError when _timeout_ seconds elapse and the 
+  # Unlike {#recv}, which waits indefinitely until the channel becomes readable,
+  # this method will raise an IOError when _timeout_ seconds elapse and the
   # channel remains unreadable.
   #
   # @param [Numeric] timeout
   #   The number of seconds to wait for the channel to become readable.
-  #   
+  #
   # @raise [IOError]
   #   (see IChannel#recv)
-  #   
+  #
   # @raise [IOError]
   #   When _timeout_ seconds elapse & the channel remains unreadable.
-  #   
+  #
   # @return [Object]
   #   The object read from the channel.
   #
@@ -116,7 +121,7 @@ class IChannel
     end
     readable, _ = IO.select [@reader], nil, nil, timeout
     if readable
-      msg = readable[0].sysread 1024
+      msg = readable[0].readline(SEP).chomp SEP
       @serializer.load msg
     else
       raise IOError, 'The channel cannot be read from.'
@@ -129,10 +134,10 @@ class IChannel
   #   Returns true when the channel is readable.
   #
   def readable?
-    if @reader.closed? 
+    if @reader.closed?
       false
     else
-      readable = IO.select [@reader], nil, nil, 0.1
+      readable, _ = IO.select [@reader], nil, nil, 0
       !! readable
     end
   end

data/test/setup.rb

@@ -1,4 +1,5 @@
-require 'ichannel'
+require_relative '../lib/ichannel'
+
 require 'yaml'
 require 'json'
 require 'test/unit'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ichannel
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-01 00:00:00.000000000 Z
+date: 2013-01-01 00:00:00.000000000 Z
 dependencies: []
 description: ! "A modern and easy-to-use interprocess communication \n    primitive."
 email:
@@ -18,6 +18,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitattributes
 - .gitignore
 - .travis.yml
 - .yardopts
@@ -45,7 +46,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1662608867092836857
+      hash: 2123576931550022235
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -54,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1662608867092836857
+      hash: 2123576931550022235
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23