|
|
@@ -31,7 +31,7 @@
|
|
|
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <ulink url="http://www.zend.com/en/products/platform/">Zend Platform's</ulink> Job
|
|
|
+ <ulink url="http://www.zend.com/en/products/platform/">Zend Platform's</ulink> Job
|
|
|
Queue.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
@@ -292,7 +292,7 @@ $queue = Zend_Queue::factory('Db', $options);
|
|
|
</para>
|
|
|
|
|
|
<para>
|
|
|
- The hostname and port corresponding to the Zend Platform Job Queue daemon
|
|
|
+ The hostname and port corresponding to the Zend Platform Job Queue daemon
|
|
|
you will use. (Required)
|
|
|
</para>
|
|
|
</listitem>
|
|
|
@@ -303,7 +303,7 @@ $queue = Zend_Queue::factory('Db', $options);
|
|
|
</para>
|
|
|
|
|
|
<para>
|
|
|
- The password required for accessing the Zend Platform Job Queue daemon.
|
|
|
+ The password required for accessing the Zend Platform Job Queue daemon.
|
|
|
(Required)
|
|
|
</para>
|
|
|
</listitem>
|
|
|
@@ -453,15 +453,15 @@ $queue = Zend_Queue::factory('Db', $options);
|
|
|
<title>Zend Platform Job Queue</title>
|
|
|
|
|
|
<para>
|
|
|
- Job Queue is a feature of Zend Platform's Enterprise Solution offering. It is not a
|
|
|
- traditional message queue, and instead allows you to queue a script to execute,
|
|
|
- along with the parameters you wish to pass to it. You can find out more about Job
|
|
|
- Queue <ulink url="http://www.zend.com/en/products/platform/">on the zend.com
|
|
|
+ Job Queue is a feature of Zend Platform's Enterprise Solution offering. It is not a
|
|
|
+ traditional message queue, and instead allows you to queue a script to execute,
|
|
|
+ along with the parameters you wish to pass to it. You can find out more about Job
|
|
|
+ Queue <ulink url="http://www.zend.com/en/products/platform/">on the zend.com
|
|
|
website</ulink>.
|
|
|
</para>
|
|
|
|
|
|
<para>
|
|
|
- The following is a list of methods where this adapter's behavior diverges from the
|
|
|
+ The following is a list of methods where this adapter's behavior diverges from the
|
|
|
standard offerings:
|
|
|
</para>
|
|
|
|
|
|
@@ -470,15 +470,15 @@ $queue = Zend_Queue::factory('Db', $options);
|
|
|
<para>
|
|
|
<methodname>create()</methodname> - Zend Platform does not have the concept
|
|
|
of discrete queues; instead, it allows administrators to provide scripts for
|
|
|
- processing jobs. Since adding new scripts is restricted to the
|
|
|
- administration interface, this method simply throws an exception indicating
|
|
|
+ processing jobs. Since adding new scripts is restricted to the
|
|
|
+ administration interface, this method simply throws an exception indicating
|
|
|
the action is forbidden.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <methodname>isExists()</methodname> - Just like
|
|
|
+ <methodname>isExists()</methodname> - Just like
|
|
|
<methodname>create()</methodname>, since Job Queue does not have a notion of
|
|
|
named queues, this method throws an exception when invoked.
|
|
|
</para>
|
|
|
@@ -486,23 +486,23 @@ $queue = Zend_Queue::factory('Db', $options);
|
|
|
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <methodname>delete()</methodname> - similar to
|
|
|
- <methodname>create()</methodname>, deletion of JQ scripts is not possible
|
|
|
+ <methodname>delete()</methodname> - similar to
|
|
|
+ <methodname>create()</methodname>, deletion of JQ scripts is not possible
|
|
|
except via the admin interface; this method raises an exception.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <methodname>getQueues()</methodname> - Zend Platform does not allow
|
|
|
- introspection into the attached job handling scripts via the API. This
|
|
|
+ <methodname>getQueues()</methodname> - Zend Platform does not allow
|
|
|
+ introspection into the attached job handling scripts via the API. This
|
|
|
method throws an exception.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <methodname>count()</methodname> - returns the total number of jobs
|
|
|
+ <methodname>count()</methodname> - returns the total number of jobs
|
|
|
currently active in the Job Queue.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
@@ -510,8 +510,8 @@ $queue = Zend_Queue::factory('Db', $options);
|
|
|
<listitem>
|
|
|
<para>
|
|
|
<methodname>send()</methodname> - this method is perhaps the one method that
|
|
|
- diverges most from other adapters. The <varname>$message</varname> argument
|
|
|
- may be one of three possible types, and will operate differently based on
|
|
|
+ diverges most from other adapters. The <varname>$message</varname> argument
|
|
|
+ may be one of three possible types, and will operate differently based on
|
|
|
the value passed:
|
|
|
</para>
|
|
|
|
|
|
@@ -526,8 +526,8 @@ $queue = Zend_Queue::factory('Db', $options);
|
|
|
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <acronym>array</acronym> - an array of values with which to
|
|
|
- configure a <classname>ZendApi_Job</classname> object. These may
|
|
|
+ <acronym>array</acronym> - an array of values with which to
|
|
|
+ configure a <classname>ZendApi_Job</classname> object. These may
|
|
|
include the following:
|
|
|
</para>
|
|
|
|
|
|
@@ -541,7 +541,7 @@ $queue = Zend_Queue::factory('Db', $options);
|
|
|
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <varname>priority</varname> - the job priority to use when
|
|
|
+ <varname>priority</varname> - the job priority to use when
|
|
|
registering with the queue.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
@@ -554,7 +554,7 @@ $queue = Zend_Queue::factory('Db', $options);
|
|
|
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <varname>predecessor</varname> - the ID of a job on which
|
|
|
+ <varname>predecessor</varname> - the ID of a job on which
|
|
|
this one depends, and which must be executed before this one
|
|
|
may begin.
|
|
|
</para>
|
|
|
@@ -563,7 +563,7 @@ $queue = Zend_Queue::factory('Db', $options);
|
|
|
<listitem>
|
|
|
<para>
|
|
|
<varname>preserved</varname> - whether or not to retain the
|
|
|
- job within the Job Queue history. By default, off; pass a
|
|
|
+ job within the Job Queue history. By default, off; pass a
|
|
|
true value to retain it.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
@@ -579,7 +579,7 @@ $queue = Zend_Queue::factory('Db', $options);
|
|
|
<listitem>
|
|
|
<para>
|
|
|
<varname>interval</varname> - how often, in seconds, the job
|
|
|
- should run. By default, this is set to 0, indicating it
|
|
|
+ should run. By default, this is set to 0, indicating it
|
|
|
should run once, and once only.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
@@ -587,10 +587,10 @@ $queue = Zend_Queue::factory('Db', $options);
|
|
|
<listitem>
|
|
|
<para>
|
|
|
<varname>end_time</varname> - an expiry time, past which the
|
|
|
- job should not run. If the job was set to run only once,
|
|
|
- and <varname>end_time</varname> has passed, then the job
|
|
|
- will not be executed. If the job was set to run on an
|
|
|
- interval, it will not execute again once
|
|
|
+ job should not run. If the job was set to run only once,
|
|
|
+ and <varname>end_time</varname> has passed, then the job
|
|
|
+ will not be executed. If the job was set to run on an
|
|
|
+ interval, it will not execute again once
|
|
|
<varname>end_time</varname> has passed.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
@@ -598,14 +598,14 @@ $queue = Zend_Queue::factory('Db', $options);
|
|
|
<listitem>
|
|
|
<para>
|
|
|
<varname>schedule_time</varname> - a <acronym>UNIX</acronym>
|
|
|
- timestamp indicating when to run the job; by default, 0,
|
|
|
+ timestamp indicating when to run the job; by default, 0,
|
|
|
indicating the job should run as soon as possible.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <varname>application_id</varname> - the application
|
|
|
+ <varname>application_id</varname> - the application
|
|
|
identifier of the job. By default, this is null, indicating
|
|
|
that one will be automatically assigned by the queue, if the
|
|
|
queue was assigned an application ID.
|
|
|
@@ -614,8 +614,8 @@ $queue = Zend_Queue::factory('Db', $options);
|
|
|
</itemizedlist>
|
|
|
|
|
|
<para>
|
|
|
- As noted, only the <varname>script</varname> argument is required;
|
|
|
- all others are simply available to allow passing more fine-grained
|
|
|
+ As noted, only the <varname>script</varname> argument is required;
|
|
|
+ all others are simply available to allow passing more fine-grained
|
|
|
detail on how and when to run the job.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
@@ -623,33 +623,33 @@ $queue = Zend_Queue::factory('Db', $options);
|
|
|
<listitem>
|
|
|
<para>
|
|
|
<classname>ZendApi_Job</classname> - finally, you may simply pass a
|
|
|
- <classname>ZendApi_Job</classname> instance, and it will be passed
|
|
|
+ <classname>ZendApi_Job</classname> instance, and it will be passed
|
|
|
along to Platform's Job Queue.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
</itemizedlist>
|
|
|
|
|
|
<para>
|
|
|
- In all instances, <methodname>send()</methodname> returns a
|
|
|
+ In all instances, <methodname>send()</methodname> returns a
|
|
|
<classname>Zend_Queue_Message_PlatformJob</classname> object, which provides
|
|
|
- access to the <classname>ZendApi_Job</classname> object used to communicate
|
|
|
+ access to the <classname>ZendApi_Job</classname> object used to communicate
|
|
|
with Job Queue.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <methodname>receive()</methodname> - retrieves a list of active jobs from
|
|
|
- Job Queue. Each job in the returned set will be an instance of
|
|
|
+ <methodname>receive()</methodname> - retrieves a list of active jobs from
|
|
|
+ Job Queue. Each job in the returned set will be an instance of
|
|
|
<classname>Zend_Queue_Message_PlatformJob</classname>.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <methodname>deleteMessage()</methodname> - since this adapter only works
|
|
|
- with Job Queue, this method expects the provided <varname>$message</varname>
|
|
|
- to be a <classname>Zend_Queue_Message_PlatformJob</classname> instance, and
|
|
|
+ <methodname>deleteMessage()</methodname> - since this adapter only works
|
|
|
+ with Job Queue, this method expects the provided <varname>$message</varname>
|
|
|
+ to be a <classname>Zend_Queue_Message_PlatformJob</classname> instance, and
|
|
|
will throw an exception otherwise.
|
|
|
</para>
|
|
|
</listitem>
|
mikaelkael