@@ -19,12 +19,15 @@ Following snippet will invoke method @some_task@ with argument @data@ in @foo_wo
be invoked asychrounously and Rails won't wait for result from BackgrounDRb server.
<pre class="multiline">worker = MiddleMan.worker(:foo_worker)
-worker.some_task(data,false) </pre>
+worker.some_task(data) </pre>
+
+Here, I would like to illustrate a point that contrary to general percenption, since @some_task@ method is being
+executed asyhcrounously, don't expect any meaningful return values from second line.
When you invoke @MiddleMan.worker(:foo_worker)@ it returns a worker proxy, hence you can combine above two lines in
one as follows:
-<pre class="boxed">MiddleMan.worker(:foo_worker,<optional_job_key>).some_task(data,false) </pre>
+<pre class="boxed">MiddleMan.worker(:foo_worker,<optional_job_key>).some_task(data) </pre>
Above snippet also demonstrates that, if your worker was started with a @job_key@ you can use it to
get correct proper worker proxy.
@@ -35,9 +38,11 @@ Following snippet will invoke method @some_task@ with argument @data@ in @foo_wo
until BackgrounDRb server returns a result.
<pre class="multiline">worker = MiddleMan.worker(:foo_worker)
-result = worker.some_task(data,false) </pre>
+result = worker.some_task(data,true) </pre>
-As illustrated above, you can use @job_key@ or make them in single line too.
+As illustrated above, you can use @job_key@ or make them in single line too. When you are invoking a method
+on your worker first optional argument will be passed to your worker method and second optional argument @true|false@
+indicates whether we should wait for result from _BackgrounDRb_ server or not.
p(sub-title). Fetch Status/Result Objects of a worker :
@@ -52,11 +57,45 @@ p(sub-title). Start a Worker :
To start a worker from rails:
-<pre class="boxed">MiddleMan.new_worker(:foo_worker,"my_secret_job_key") </pre>
+<pre class="multiline">used_job_key = MiddleMan.new_worker(:worker => :foo_worker,\
+ :job_key => "my_secret_job_key") </pre>
+
+@new_worker@ will always return @job_key@ generated for the worker. It will be same as @job_key@ passed while creating the
+worker and can be reused to invoke further tasks on the same worker or for deleting the worker.
Important thing to be kept in mind is, when you are creating a worker using above approach, you
must use a unique @job_key@ while starting the worker. Also, while invoking any of the other methods
like @ask_status@, @worker_info@ or one of the worker methods, you must use @job_key@.
+Also another complicated example of starting a worker will be:
+
+<pre class="multiline">MiddleMan.new_worker(:worker => :error_worker, :job_key => :hello_world,\
+ :data => "wow_man",:schedule => \
+ { :hello_world => { :trigger_args => "*/5 * * * * * *",\
+ :data => "hello_world" }}) </pre>
+
+Above code will start @error_worker@ with @job_key@ and will pass argument @:data@ to @create@
+method of the worker. Worker will be scheduled to run @hello_world@ method every 5 seconds with argument
+specified in @:data@.
+
+p(sub-title). Worker Statistics:
+
+You can get worker specific information using:
+
+<pre class="boxed">MiddleMan.worker(:foo_worker).worker_info </pre>
+
+The return value will look something like:
+
+<pre class="boxed">{:worker=>:foo_worker, :status=>:running, :job_key=>"hello"} </pre>
+
+Information about all currently running workers can be obtained using:
+
+<pre class="boxed">MiddleMan.all_worker_info </pre>
+
+Return value will look like:
+<pre class="multiline">[{:worker=>:foo_worker, :status=>:running, :job_key=>"hello"}, \
+ {:worker=>:foo_worker, :status=>:running, :job_key=>""}] </pre>
+
+
</div>
doc/content/rails/rails.txt
@@ -2,6 +2,34 @@
%(entry-title)<a name="introduction"> Introduction </a>%
-Workers are your building blocks of Asynchronous Task Processing.
+Workers are your building blocks of Asynchronous Task Processing. An empty auto generated worker looks like this:
+
+<pre class="multiline">class BillingWorker < BackgrounDRb::MetaWorker
+ set_worker_name :billing_worker
+ def create(args = nil)
+ # method gets called, when new instance of worker is created.
+ end
+ end </pre>
+
+@set_worker_name@ will set the worker name which can be later used while invoking tasks on the worker.
+@create@ method gets called when worker is loaded for the first time. If you are starting your worker
+from rails, you can pass arguments to @create@ method using:
+
+<pre class="multiline">MiddleMan.new_worker(:worker => :billing_worker,\
+ :job_key => user_session,:data => current_user.id) </pre>
+
+p(sub-title). Using Workers
+
+You can invoke random tasks on workers from rails or you can schedule them using config file. Look into
+"Scheduling":/scheduling/index.html section for scheduling and "Rails Integration":/rails/index.html section
+for invoking worker tasks from rails.
+
+p(sub-title). Inbuilt instance methods available in your workers:
+
+*(content_list) @register_status@ : Can be used to store random results from worker which can be later retrieved from rails. For example:
+ <pre class="boxed"> register_status("Hello") </pre>
+* @add_timer@
+* @add_periodic_timer@
+* @thread_pool@
</div>
doc/content/workers/workers.txt
@@ -78,13 +78,17 @@ be invoked asychrounously and Rails won’t wait for result from BackgrounDR
<pre class="multiline">worker = MiddleMan.worker(:foo_worker)
-worker.some_task(data,false) </pre>
+worker.some_task(data) </pre>
+
+ <p>Here, I would like to illustrate a point that contrary to general percenption, since <code>some_task</code> method is being
+executed asyhcrounously, don’t expect any meaningful return values from second line.</p>
+
<p>When you invoke <code>MiddleMan.worker(:foo_worker)</code> it returns a worker proxy, hence you can combine above two lines in
one as follows:</p>
-<pre class="boxed">MiddleMan.worker(:foo_worker,<optional_job_key>).some_task(data,false) </pre>
+<pre class="boxed">MiddleMan.worker(:foo_worker,<optional_job_key>).some_task(data) </pre>
<p>Above snippet also demonstrates that, if your worker was started with a <code>job_key</code> you can use it to
get correct proper worker proxy.</p>
@@ -98,9 +102,11 @@ until BackgrounDRb server returns a result.</p>
<pre class="multiline">worker = MiddleMan.worker(:foo_worker)
-result = worker.some_task(data,false) </pre>
+result = worker.some_task(data,true) </pre>
- <p>As illustrated above, you can use <code>job_key</code> or make them in single line too.</p>
+ <p>As illustrated above, you can use <code>job_key</code> or make them in single line too. When you are invoking a method
+on your worker first optional argument will be passed to your worker method and second optional argument <code>true|false</code>
+indicates whether we should wait for result from <em>BackgrounDRb</em> server or not.</p>
<p class="sub-title">Fetch Status/Result Objects of a worker :</p>
@@ -121,13 +127,53 @@ rails using:</p>
<p>To start a worker from rails:</p>
-<pre class="boxed">MiddleMan.new_worker(:foo_worker,"my_secret_job_key") </pre>
+<pre class="multiline">used_job_key = MiddleMan.new_worker(:worker => :foo_worker,\
+ :job_key => "my_secret_job_key") </pre>
+
+ <p><code>new_worker</code> will always return <code>job_key</code> generated for the worker. It will be same as <code>job_key</code> passed while creating the
+worker and can be reused to invoke further tasks on the same worker or for deleting the worker.</p>
+
<p>Important thing to be kept in mind is, when you are creating a worker using above approach, you
must use a unique <code>job_key</code> while starting the worker. Also, while invoking any of the other methods
like <code>ask_status</code>, <code>worker_info</code> or one of the worker methods, you must use <code>job_key</code>.</p>
+ <p>Also another complicated example of starting a worker will be:</p>
+
+
+<pre class="multiline">MiddleMan.new_worker(:worker => :error_worker, :job_key => :hello_world,\
+ :data => "wow_man",:schedule => \
+ { :hello_world => { :trigger_args => "*/5 * * * * * *",\
+ :data => "hello_world" }}) </pre>
+
+ <p>Above code will start <code>error_worker</code> with <code>job_key</code> and will pass argument <code>:data</code> to <code>create</code>
+method of the worker. Worker will be scheduled to run <code>hello_world</code> method every 5 seconds with argument
+specified in <code>:data</code>.</p>
+
+
+ <p class="sub-title">Worker Statistics:</p>
+
+
+ <p>You can get worker specific information using:</p>
+
+
+<pre class="boxed">MiddleMan.worker(:foo_worker).worker_info </pre>
+
+ <p>The return value will look something like:</p>
+
+
+<pre class="boxed">{:worker=>:foo_worker, :status=>:running, :job_key=>"hello"} </pre>
+
+ <p>Information about all currently running workers can be obtained using:</p>
+
+
+<pre class="boxed">MiddleMan.all_worker_info </pre>
+
+Return value will look like:
+<pre class="multiline">[{:worker=>:foo_worker, :status=>:running, :job_key=>"hello"}, \
+ {:worker=>:foo_worker, :status=>:running, :job_key=>""}] </pre>
+
</div>
<div id="footer">
doc/output/rails/index.html
@@ -52,7 +52,42 @@
<p><span class="entry-title"><a name="introduction"> Introduction </a></span></p>
- <p>Workers are your building blocks of Asynchronous Task Processing.</p>
+ <p>Workers are your building blocks of Asynchronous Task Processing. An empty auto generated worker looks like this:</p>
+
+
+<pre class="multiline">class BillingWorker < BackgrounDRb::MetaWorker
+ set_worker_name :billing_worker
+ def create(args = nil)
+ # method gets called, when new instance of worker is created.
+ end
+ end </pre>
+
+ <p><code>set_worker_name</code> will set the worker name which can be later used while invoking tasks on the worker.
+<code>create</code> method gets called when worker is loaded for the first time. If you are starting your worker
+from rails, you can pass arguments to <code>create</code> method using:</p>
+
+
+<pre class="multiline">MiddleMan.new_worker(:worker => :billing_worker,\
+ :job_key => user_session,:data => current_user.id) </pre>
+
+ <p class="sub-title">Using Workers</p>
+
+
+ <p>You can invoke random tasks on workers from rails or you can schedule them using config file. Look into
+<a href="/scheduling/index.html">Scheduling</a> section for scheduling and <a href="/rails/index.html">Rails Integration</a> section
+for invoking worker tasks from rails.</p>
+
+
+ <p class="sub-title">Inbuilt instance methods available in your workers:</p>
+
+
+ <ul class="content_list">
+ <li><code>register_status</code> : Can be used to store random results from worker which can be later retrieved from rails. For example:
+ <pre class="boxed"> register_status("Hello") </pre></li>
+ <li><code>add_timer</code></li>
+ <li><code>add_periodic_timer</code></li>
+ <li><code>thread_pool</code></li>
+ </ul>
</div>
doc/output/workers/index.html
@@ -16,7 +16,9 @@ MiddleMan.worker(:foo_worker).some_work("hello World")
MiddleMan.new_worker(:worker => :foo_worker, :job_key => "wow",:data => "Hello World")
# new API
-worker = MiddelMan.new_worker(:foo_worker,:job_key => "Wow")
+worker = MiddelMan.new_worker(:foo_worker,:job_key => "Wow",:data => "Wow man",\
+ :schedule => { :hello_world => { :trigger_args => "*/5 * * * * * *",:data => "hello_world" }})
+
worker.hello_world("Wow man")
worker.delete
examples/clean_api.rb
@@ -22,6 +22,10 @@ class BackgrounDRb::WorkerProxy
@mutex = Mutex.new
establish_connection
end
+
+ def worker(worker_name,job_key = nil)
+ BackgrounDRb::RailsWorkerProxy.worker(worker_name,job_key)
+ end
def establish_connection
begin
@@ -71,6 +75,7 @@ class BackgrounDRb::WorkerProxy
end
def dump_object data
+ p data
unless @connection_status
establish_connection
raise BackgrounDRb::BdrbConnError.new("Error while connecting to the backgroundrb server") unless @connection_status
lib/backgroundrb.rb
@@ -9,31 +9,36 @@ module BackgrounDRb
end
def method_missing(method_id,*args)
- @worker_method = method_id
- @data = args[0]
+ worker_method = method_id
+ p worker_method
+
+ data = args[0]
+
+ p data
+
flag = args[1]
- case @worker_method
+
+ p flag
+
+ case worker_method
when :ask_status
- if job_key
- MiddleMan.ask_status(:worker => worker_name,:job_key => job_key)
- else
- MiddleMan.ask_status(:worker => worker_name)
- end
+ MiddleMan.ask_status(compact(:worker => worker_name,:job_key => job_key))
when :worker_info
-
- when :all_worker_info
-
- when :new_worker
-
+ MiddleMan.worker_info(compact(:worker => worker_name,:job_key => job_key))
when :delete
-
+ MiddleMan.delete_worker(compact(:worker => worker_name, :job_key => job_key))
else
-
-
+ if flag
+ MiddleMan.send_request(compact(:worker => worker_name,:job_key => job_key,:worker_method => worker_method,:data => data))
+ else
+ MiddleMan.ask_work(compact(:worker => worker_name,:job_key => job_key,:worker_method => worker_method,:data => data))
+ end
end
end
- def pack_modifers(p_option = { })
+ def compact(options = { })
+ options.delete_if { |key,value| value.nil? }
+ options
end
lib/backgroundrb/rails_worker_proxy.rb
9f4a7726962233dbe0665422be80a7b68ffcd62c
gnufied
mail@gnufied.org
http://github.com/georgepalmer/backgroundrb_merb/commit/ec5226be22def1cab45e6e185481b43a21d8504a
ec5226be22def1cab45e6e185481b43a21d8504a
2008-02-27T02:27:40-08:00
2008-02-27T02:27:40-08:00
Fixed new API and updated documentation
9b22cd4d322652e125da8f83fab4b2f406834602
gnufied
mail@gnufied.org