drbqs 0.0.8 → 0.0.9

data/README.rdoc

@@ -1,128 +0,0 @@
-= drbqs
-
-Task queuing system over network that is implemented by dRuby.
-
-== Requirements
-
-DRbQS uses Fiber, so ruby requires version 1.9.
-
-== Usage
-
-=== Preparation
-
-We prepare a class to send tasks over network,
-which has data and a method to deal with tasks.
-
-We make sum.rb as the following.
-
- class Sum
-   def initialize(start_num, end_num)
-     @num = [start_num, end_num]
-   end
- 
-   def exec
-     (@num[0]..@num[1]).inject(0) { |sum, i| sum += i }
-   end
- end
-
-The Sum class calculates sum of numbers from start_num to end_num.
-The task we want to calculate is summation of numbers.
-
-=== Start server
-
-We make server.rb as the following.
-
- require_relative 'sum.rb'
- 
- DRbQS.define_server(:finish_exit => true) do |server, argv, opts|
-   10.step(100, 10) do |i|
-     task = DRbQS::Task.new(Sum.new(i - 10, i), :exec)
-     server.queue.add(task)
-   end
- end
-
-In terminal, we load server.rb and execute server of drbqs.
-
- drbqs-server server.rb -p 13500
-
-=== Hook of server
-
-We can use two hooks of server: 'empty_queue' and 'finish'.
-
- DRbQS.define_server do |server, argv, opts|
-   server.add_hook(:empty_queue) do |srv|
-     srm.queue.add( ... )
-   end
-   
-   server.add_hook(:finish) do |srv|
-     srm.exit
-   end
- end
-
-'finish' hook usually exit server program, but
-an option :finish_exit for DRbQS.define_server or DRbQS.new
-is nearly same.
-
-We can use 'empty_queue' hook for adding tasks
-when task queue is empty.
-
-=== Task generator
-
-Arguments of DRbQS::TaskGenerator.new define instance variables.
-
- task_generator = DRbQS::TaskGenerator.new(:abc => 'ABC', :def => 123, :data => [1, 2, 3])
-
-The above example defines the following instance variables.
-
- @abc = 'ABC'
- @def = 123
- @data = [1, 2, 3]
-
-Then, DRbQS::TaskGenerator#set method defines generation of tasks.
-The block of the method is evaluated in the context of task_generator.
-For the above example we can use @abc, @def, and @data.
-
- task_generator.set do
-   @data.each do |i|
-     create_add_task(i, :to_s)
-   end
- end
-
-DRbQS::TaskGenerator#create_add_task creates a task
-and the task is returned by DRbQS::TaskGenerator#new_tasks.
-The arguments of DRbQS::TaskGenerator#create_add_task is
-the same as DRbQS::Task.new.
-
-To use the generator in DRbQS::Server,
-we set the generator by DRbQS::Server#add_task_generator.
-
-=== Start node and connect server
-
-Because nodes needs class Sum,
-the nodes load sum.rb when they starts.
-Then, we type in terminal.
-
- drbqs-node druby://localhost:13500/ -l sum.rb
-
-To use two cpu cores we execute two processes by the following.
-
- drbqs-node 2 druby://localhost:13500/ -l sum.rb
-
-Then, if it succeeds, the calculation starts.
-If it finishes, the server and node ends.
-
-== Contributing to drbqs
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Takayuki YAMAGUCHI. See LICENSE.txt for
-further details.
-