ichannel 2.0.0 → 3.0.0

data/.yardopts

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

data/README.md

@@ -17,8 +17,7 @@ This works across any Ruby process & its subprocesses, though, which is why it
 can be useful. You could describe putting and getting objects to/from the channel
 as message passing but the message could potentially be any Ruby object, 
 although I think sending small messages(as a Hash) works very well for most 
-scenarios. You have the potential to serialize any object that `Marshal` can 
-dump+load, though.
+scenarios.
 
 __EXAMPLES__
 

data/lib/ichannel/version.rb

@@ -1,3 +1,3 @@
 class IChannel
-  VERSION = "2.0.0"
+  VERSION = "3.0.0"
 end

data/lib/ichannel.rb

@@ -1,7 +1,7 @@
 require 'socket'
 class IChannel
   #
-  # @param [#dump,#load}] serializer
+  # @param [#dump,#load] serializer
   #   Any object that implements dump, & load.
   #   
   def initialize(serializer) 
@@ -33,39 +33,82 @@ class IChannel
   #
   # Add an object to the channel.
   #
-  # @raise [IOError]
-  #   When the channel cannot be written to.
+  # @raise [IOError] 
+  #   When the channel is closed.
   #
   # @param [Object] object
   #   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
+  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.
+  #
+  # @raise [IOError]
+  #   When 0.1 seconds elapse and the channel remains unwritable.
+  #
+  # @param (see IChannel#put).
+  #
+  def write!(object)
     _, writable, _ = IO.select [], [@writer], [], 0.1
     if writable
-      @writer.send @serializer.dump(object), 0
-    else
-      raise IOError, 'The channel cannot be written to.'
+      writable[0].send @serializer.dump(@object), 0
     end
   end
-  alias_method :put, :write
+  alias_method :put!, :write
 
   #
   # Receive a object from the channel.
   #
   # @raise [IOError]
-  #   When the channel cannot be read from.
+  #   When the channel is closed.
   #
   # @return [Object]
-  #   The object added to the channel.
-  #
+  #   The object read from the channel.
+  #   
   def recv
-    readable, _ = IO.select [@reader], [], [], 0.1
+    if @reader.closed?
+      raise IOError, 'The channel cannot be read from (closed).'
+    end
+    readable, _ = IO.select [@reader], [], []
+    msg, _ = readable[0].recvmsg
+    @serializer.load msg
+  end
+  alias_method :get, :recv
+
+  #
+  # Receive a 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.
+  #
+  # @raise [IOError]
+  #   When 0.1 seconds elapse and the channel remains unreadable.
+  #
+  # @return [Object]
+  #   The object read from the channel.
+  #
+  def recv! 
+    readble, _ = IO.select [@reader], [], []
     if readable
-      msg, _ = @reader.recvmsg
+      msg, _ = readable[0].recvmsg
       @serializer.load msg
     else
-      raise IOError, 'The channel cannot be read from.' 
+      raise IOError, 'The channel cannot be read from.'
     end
   end
-  alias_method :get, :recv
+  alias_method :get!, :recv!
+
 end

data/test/ichannel_class_test.rb

@@ -1,7 +1,7 @@
 require_relative 'setup'
 class IChannelTest < Test::Unit::TestCase
   def setup
-    @channel = IChannel.new Marshal
+    @channel = IChannel.new [YAML, Marshal, JSON].sample
   end
 
   def teardown

data/test/setup.rb

@@ -1,2 +1,4 @@
 require '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: 2.0.0
+  version: 3.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -20,6 +20,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- .yardopts
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -43,7 +44,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -795267943345486764
+      hash: 3779638339953442798
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -52,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -795267943345486764
+      hash: 3779638339953442798
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23