Add IO example

Author: pitr-ch

doc/actor/io.in.rb

@@ -0,0 +1,49 @@
+require 'concurrent'
+
+# logger = Logger.new(STDOUT)
+# Concurrent.configuration.logger = logger.method(:add)
+
+# First option is to use operation pool
+
+class ActorDoingIO < Concurrent::Actor::RestartingContext
+  def on_message(message)
+    # do IO operation
+  end
+
+  def default_executor
+    Concurrent.configuration.global_operation_pool
+  end
+end #
+
+actor_doing_io = ActorDoingIO.spawn :actor_doing_io
+actor_doing_io.executor == Concurrent.configuration.global_operation_pool
+
+# It can be also built into a pool so there is not too many IO operations
+
+class IOWorker < Concurrent::Actor::Utils::AbstractWorker
+  def work(io_job)
+    # do IO work
+    sleep 1
+    puts "#{path} second:#{Time.now.to_i} message:#{io_job}"
+  end
+
+  def default_executor
+    Concurrent.configuration.global_operation_pool
+  end
+end #
+
+pool = Concurrent::Actor::Utils::Pool.spawn('pool', 2) do |balancer, index|
+  IOWorker.spawn(name: "worker-#{index}", supervise: true, args: [balancer])
+end
+
+pool << 1 << 2 << 3 << 4 << 5 << 6
+
+# prints two lines each second
+# /pool/worker-0 second:1414677666 message:1
+# /pool/worker-1 second:1414677666 message:2
+# /pool/worker-0 second:1414677667 message:3
+# /pool/worker-1 second:1414677667 message:4
+# /pool/worker-0 second:1414677668 message:5
+# /pool/worker-1 second:1414677668 message:6
+
+sleep 4

doc/actor/io.out.rb

@@ -0,0 +1,53 @@
+require 'concurrent'                               # => true
+
+# logger = Logger.new(STDOUT)
+# Concurrent.configuration.logger = logger.method(:add)
+
+# First option is to use operation pool
+
+class ActorDoingIO < Concurrent::Actor::RestartingContext
+  def on_message(message)
+    # do IO operation
+  end
+
+  def default_executor
+    Concurrent.configuration.global_operation_pool
+  end
+end 
+
+actor_doing_io = ActorDoingIO.spawn :actor_doing_io
+    # => #<Concurrent::Actor::Reference /actor_doing_io (ActorDoingIO)>
+actor_doing_io.executor == Concurrent.configuration.global_operation_pool
+    # => true
+
+# It can be also built into a pool so there is not too many IO operations
+
+class IOWorker < Concurrent::Actor::Utils::AbstractWorker
+  def work(io_job)
+    # do IO work
+    sleep 1
+    puts "#{path} second:#{Time.now.to_i} message:#{io_job}"
+  end
+
+  def default_executor
+    Concurrent.configuration.global_operation_pool
+  end
+end 
+
+pool = Concurrent::Actor::Utils::Pool.spawn('pool', 2) do |balancer, index|
+  IOWorker.spawn(name: "worker-#{index}", supervise: true, args: [balancer])
+end
+    # => #<Concurrent::Actor::Reference /pool (Concurrent::Actor::Utils::Pool)>
+
+pool << 1 << 2 << 3 << 4 << 5 << 6
+    # => #<Concurrent::Actor::Reference /pool (Concurrent::Actor::Utils::Pool)>
+
+# prints two lines each second
+# /pool/worker-0 second:1414677666 message:1
+# /pool/worker-1 second:1414677666 message:2
+# /pool/worker-0 second:1414677667 message:3
+# /pool/worker-1 second:1414677667 message:4
+# /pool/worker-0 second:1414677668 message:5
+# /pool/worker-1 second:1414677668 message:6
+
+sleep 4                                            # => 4

doc/actor/main.md

@@ -96,6 +96,10 @@ Blocking operations could starve the `default_task_pool`. However there are two
   (which is intended for blocking operations) sending results back to self in messages.
 - Create an actor using `global_operation_pool` instead of `global_task_pool`, e.g.
   `AnIOActor.spawn name: :blocking, executor: Concurrent.configuration.global_operation_pool`.
+  
+### Example
+  
+{include:file:doc/actor/io.out.rb}
 
 ## Dead letter routing
 

lib/concurrent/actor.rb

@@ -7,8 +7,9 @@
 module Concurrent
   # TODO https://github.com/celluloid/celluloid/wiki/Supervision-Groups ?
   # TODO Remote actors using DRb
-  # TODO IO interoperation
   # TODO un/become
+  # TODO supervision tree, pause children on error in parent, pause may need higher priority
+  # TODO more effective executor
 
   # {include:file:doc/actor/main.md}
   module Actor