Added deprecation notes to Actor, Channel, and Postable.

Author: jdantonio

lib/concurrent/actor.rb

@@ -119,6 +119,8 @@ module Concurrent
   #   
   #   ping << :pong
   #
+  # @deprecated +Actor+ is being replaced with a completely new framework prior to v1.0.0
+  #
   # @see http://ruby-doc.org/stdlib-2.0/libdoc/observer/rdoc/Observable.html
   class Actor
     include Observable
@@ -174,6 +176,8 @@ def initialize(queue)
     #   #=> [6] handled by #<EchoActor:0x007fc8014fb8b8>
     #   #=> [7] handled by #<EchoActor:0x007fc8014fb818>
     #   #=> [8] handled by #<EchoActor:0x007fc8014fb890>
+    #
+    # @deprecated +Actor+ is being replaced with a completely new framework prior to v1.0.0
     def self.pool(count, *args, &block)
       raise ArgumentError.new('count must be greater than zero') unless count > 0
       mailbox = Queue.new
@@ -202,24 +206,32 @@ def self.pool(count, *args, &block)
     # @return [Object] the result obtained when the message is successfully processed
     #
     # @raise NotImplementedError unless overridden in the +Actor+ subclass
+    #
+    # @deprecated +Actor+ is being replaced with a completely new framework prior to v1.0.0
     # 
     # @!visibility public
     def act(*message)
       raise NotImplementedError.new("#{self.class} does not implement #act")
     end
 
     # @!visibility private
+    #
+    # @deprecated +Actor+ is being replaced with a completely new framework prior to v1.0.0
     def on_run # :nodoc:
       queue.clear
     end
 
     # @!visibility private
+    #
+    # @deprecated +Actor+ is being replaced with a completely new framework prior to v1.0.0
     def on_stop # :nodoc:
       queue.clear
       queue.push(:stop)
     end
 
     # @!visibility private
+    #
+    # @deprecated +Actor+ is being replaced with a completely new framework prior to v1.0.0
     def on_task # :nodoc:
       package = queue.pop
       return if package == :stop
@@ -247,6 +259,8 @@ def on_task # :nodoc:
     end
 
     # @!visibility private
+    #
+    # @deprecated +Actor+ is being replaced with a completely new framework prior to v1.0.0
     def on_error(time, msg, ex) # :nodoc:
     end
   end

lib/concurrent/channel.rb

@@ -30,6 +30,14 @@ module Concurrent
   #   future.fulfilled? => true
   #   
   #   channel.stop => true  
+  #
+  # @note +Actor+ is being replaced with a completely new framework prior to v1.0.0.
+  #       Subsequently +Channel+ will be rewritten to no longer inherit from +Actor+
+  #       and no longer include +Stoppable+. The +forward+ method from +Postable+
+  #       will also be deprecated. The +pool+ method will likely be removed as
+  #       well (in lieu of an internal thread pool). The other messaging methods
+  #       (+post+, +post?+, and +post!+) will remain and will behave as they do
+  #       now.
   #   
   # @see http://blogs.msdn.com/b/dsyme/archive/2010/02/15/async-and-parallel-design-patterns-in-f-part-3-agents.aspx Async and Parallel Design Patterns in F#: Agents
   # @see http://msdn.microsoft.com/en-us/library/ee370357.aspx Control.MailboxProcessor<'Msg> Class (F#)

lib/concurrent/postable.rb

@@ -75,13 +75,15 @@ def post!(seconds, *message)
       end
     end
 
+    # @deprecated +Actor+ is being replaced with a completely new framework prior to v1.0.0
     def forward(receiver, *message)
       raise ArgumentError.new('empty message') if message.empty?
       return false unless ready?
       queue.push(Package.new(message, receiver))
       queue.length
     end
 
+    # @deprecated +Actor+ is being replaced with a completely new framework prior to v1.0.0
     def ready?
       if self.respond_to?(:running?) && ! running?
         false