ichannel 3.0.2 → 3.0.3

data/.yardopts

@@ -1,4 +1,4 @@
 -m markdown -M redcarpet
---
+-
 README.md
 LICENSE.txt

data/Gemfile

@@ -1,3 +1,7 @@
 source 'http://rubygems.org'
-gem 'rake'
+group :development do
+  gem 'rake'
+  gem 'redcarpet'
+  gem 'yard'
+end
 gemspec

data/lib/ichannel.rb

@@ -25,8 +25,10 @@ class IChannel
   #   Returns nil when the channel is already closed.
   #
   def close
-    if !@reader.closed? && !@writer.closed?
-      !! [@reader.close, @writer.close]
+    unless closed?
+      @reader.close
+      @writer.close
+      true
     end
   end
 
@@ -40,38 +42,43 @@ class IChannel
   #   An object to add to the channel.
   #
   def write(object)
-    if @writer.closed?
-      raise IOError, 'The channel cannot be written to (closed).' 
-    end
-    _, writable, _ = IO.select [], [@writer], []
-    writable[0].send @serializer.dump(object), 0
+    write!(object, nil)
   end
   alias_method :put, :write
 
   #
   # Add an object to the channel.
   #
-  # Unlike {#put}, which waits indefinitely until the channel becomes writable,
-  # this method will raise an IOError if 0.1 seconds elapse and the channel 
-  # remains unwritable.
+  # Unlike {#write}, which waits indefinitely until the channel becomes writable,
+  # this method will raise an IOError when _timeout_ seconds elapse and 
+  # the channel remains unwritable.
   #
-  # @raise [IOError]
-  #   When 0.1 seconds elapse and the channel remains unwritable.
+  # @param 
+  #   (see IChannel#write)
+  #
+  # @param [Numeric] timeout
+  #   The number of seconds to wait for the channel to become writable.
+  #
+  # @raise (see IChannel#write) 
   #
-  # @param (see IChannel#put).
+  # @raise [IOError]
+  #   When _timeout_ seconds elapse & the channel remains unwritable.  
   #
-  def write!(object)
-    _, writable, _ = IO.select [], [@writer], [], 0.1
+  def write!(object, timeout = 0.1)
+    if @writer.closed?
+      raise IOError, 'The channel cannot be written to (closed).'
+    end
+    _, writable, _ = IO.select [], [@writer], [], timeout
     if writable
-      writable[0].send @serializer.dump(@object), 0
+      writable[0].send @serializer.dump(object), 0
     else
       raise IOError, 'The channel cannot be written to.'
     end
   end
-  alias_method :put!, :write
+  alias_method :put!, :write!
 
   #
-  # Receive a object from the channel.
+  # Receive an object from the channel.
   #
   # @raise [IOError]
   #   When the channel is closed.
@@ -80,30 +87,34 @@ class IChannel
   #   The object read from the channel.
   #   
   def recv
-    if @reader.closed?
-      raise IOError, 'The channel cannot be read from (closed).'
-    end
-    readable, _ = IO.select [@reader], [], []
-    msg, _ = readable[0].recvmsg
-    @serializer.load msg
+    recv!(nil)
   end
   alias_method :get, :recv
 
   #
-  # Receive a object from the channel.
+  # Receive an object from the channel.
   #
-  # Unlike {#get}, which waits indefinitely until the channel becomes readable, 
-  # this method will raise an IOError if 0.1 seconds elapse and the channel 
-  # remains unreadable.
+  # 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]
-  #   When 0.1 seconds elapse and the channel remains unreadable.
-  #
+  #   (see IChannel#recv)
+  #   
+  # @raise [IOError]
+  #   When _timeout_ seconds elapse & the channel remains unreadable.
+  #   
   # @return [Object]
   #   The object read from the channel.
   #
-  def recv! 
-    readble, _ = IO.select [@reader], [], [], 0.1
+  def recv!(timeout = 0.1)
+    if @reader.closed?
+      raise IOError, 'The channel cannot be read from (closed).'
+    end
+    readable, _ = IO.select [@reader], [], [], timeout
     if readable
       msg, _ = readable[0].recvmsg
       @serializer.load msg
@@ -112,5 +123,4 @@ class IChannel
     end
   end
   alias_method :get!, :recv!
-
 end

data/lib/ichannel/version.rb

@@ -1,3 +1,3 @@
 class IChannel
-  VERSION = "3.0.2"
+  VERSION = "3.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ichannel
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-17 00:00:00.000000000 Z
+date: 2012-11-24 00:00:00.000000000 Z
 dependencies: []
 description: ! "A modern and easy-to-use interprocess communication \n    primitive."
 email:
@@ -44,7 +44,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4054372097139346221
+      hash: 3488469513037529160
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -53,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4054372097139346221
+      hash: 3488469513037529160
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -63,3 +63,4 @@ summary: A modern and easy-to-use interprocess communication  primitive.
 test_files:
 - test/ichannel_class_test.rb
 - test/setup.rb
+has_rdoc: