README.md in concurrent_worker-0.1.2 vs README.md in concurrent_worker-0.1.3

- old
+ new

@@ -1,12 +1,12 @@ # ConcurrentWorker +Concurrent worker in thread/process with preparation structure. - ## Installation -Add this line to your application's Gemfile: +Add this line to your application's Gemfile. ```ruby gem 'concurrent_worker' ``` @@ -40,55 +40,53 @@ logger.req("thread%d n=%d\n",0, 1) logger.join ``` -If you need some preparation for the worker block, you can define 'base block': +If you need some preparation for the worker block, you can define 'base block'. ```ruby logger = ConcurrentWorker::Worker.new do |args| - # share object with 'base block' by instance variable(@xxx). + # worker block and base block can share object with instance variable(@xxx). printf(@file, *args) @file.flush nil end -# define 'base block' for some preparation of 'work block'. +# define base block for some preparation of work block. logger.set_block(:base_block) do open( "log.txt" , "w" ) do |file| @file = file - # 'yield_loop_block' must be called in 'base block'. - # 'work block' will be called in this call. + # 'yield_loop_block' must be called in base block. + # work block will be called in this call. yield_loop_block end end ... ``` -The 'work blick' and 'base block' are executed in a worker's instance scope, in a same thread, so that they can share object with the worker's instance variable. +The work block and base block are executed in a same thread, and in a worker's instance scope so that they can share object with the worker's instance variable. ### WorkerPool You can exec work block in some process concurrently. ```ruby #define a pool of 8 workers , executed in other process. -pw = ConcurrentWorker::WorkerPool.new(type: :process, pool_max: 8) do - |n| +wp = ConcurrentWorker::WorkerPool.new(type: :process, pool_max: 8) do |n| [n , n.times.inject(:+)] end # you can receive the result of work block with callback block. -pw.add_callback do |n, result| +wp.add_callback do |n, result| logger.log( "n=%d,result=%d", n, result) end (10000000..10000200).each do |n| - pw.req(n) + wp.req(n) end -pw.join - +wp.join ``` Worker uses `Marshal::dump/load` to transport ruby object to other process. So, request arguments and result objects must be able to be Marshal dumped. @@ -98,10 +96,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/murjp/concurrent_worker. +Bug reports and pull requests are welcome on GitHub at https://github.com/dddogdiamond/concurrent_worker. ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).