ichannel 5.1.1.3 → 5.1.1.4

data/ChangeLog.txt

@@ -1,3 +1,7 @@
+== v5.1.1.4
+	* doc improvements
+	another release focused on doc improvements.
+
 == v5.1.1.3
 	* doc improvements
 	another and (hopefully) last set of changes to the documentation.

data/README.md

@@ -12,10 +12,10 @@ __OVERVIEW__
 __DESCRIPTION__
 
 ichannel simplifies interprocess communication by providing a bi-directional
-channel that can transport ruby objects between processes on the same machine. 
-All communication on a channel occurs on a streamed UNIXSocket that a channel
-uses to queues its messages (ruby objects), and also to ensure that messages 
-are received in the order they are sent.
+channel that can be used to transport ruby objects between processes on the same 
+machine. All communication on a channel occurs on a streamed UNIXSocket that a 
+channel uses to queues its messages (ruby objects), and also to ensure that 
+messages are received in the order they are sent.
 
 __SERIALIZATION__
 
@@ -46,6 +46,23 @@ channel.get # => 'Hello!'
 
 __2.__
 
+Knowing when a channel is readable can be useful so that you can avoid a
+blocking read. This (bad) example demonstrates how to do that:
+
+```ruby
+channel = IChannel.new Marshal
+pid = fork do
+  sleep 3
+  channel.put 42
+end
+until channel.readable?
+  sleep 1
+  channel.get # => 42
+end
+```
+
+__3.__
+
 MessagePack doesn't implement `dump` or `load` but a wrapper can be easily
 written:
 

data/lib/ichannel/version.rb

@@ -1,3 +1,3 @@
 class IChannel
-  VERSION = "5.1.1.3"
+  VERSION = "5.1.1.4"
 end

data/lib/ichannel.rb

@@ -133,7 +133,7 @@ class IChannel
   #   Returns true when the channel is readable.
   #
   def readable?
-    if @reader.closed?
+    if closed?
       false
     else
       readable, _ = IO.select [@reader], nil, nil, 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ichannel
 version: !ruby/object:Gem::Version
-  version: 5.1.1.3
+  version: 5.1.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -46,7 +46,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -738845943245247056
+      hash: -3132810581347906708
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -55,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -738845943245247056
+      hash: -3132810581347906708
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23