php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

gearman: fix XML to get remove of useless wrapping para tags (#5118)

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-16 06:14:23 +00:00
committed by GitHub
parent 57a9b231b1
commit c143cefd03
96 changed files with 2155 additions and 2523 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1089
reference/gearman/constants.xml
View File

File diff suppressed because it is too large Load Diff

115
reference/gearman/examples.xml
View File

@@ -1,19 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="gearman.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearman.examples">
&reftitle.examples;
<section xml:id="gearman.examples-reverse">
<title>Basic usage</title>
<para>
<example>
<title>Basic Gearman client and worker</title>
<para>
This example shows a very simple client and worker. The client sends a string
to the job server, and the worker reverses the string and sends it back.
The job is performed synchronously.
</para>
<programlisting role="php">
<example>
<title>Basic Gearman client and worker</title>
<para>
This example shows a very simple client and worker. The client sends a string
to the job server, and the worker reverses the string and sends it back.
The job is performed synchronously.
</para>
<programlisting role="php">
<![CDATA[
<?php
@@ -55,8 +53,8 @@ while($gmclient->returnCode() != GEARMAN_SUCCESS);
?>
]]>
</programlisting>
<programlisting role="php">
</programlisting>
<programlisting role="php">
<![CDATA[
<?php
@@ -114,9 +112,9 @@ function reverse_fn_fast($job)
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
% php reverse_worker.php
Starting
@@ -131,8 +129,8 @@ Sending status: 5/6 complete
Sending status: 6/6 complete
Result: !olleH
]]>
</screen>
<screen>
</screen>
<screen>
<![CDATA[
% php reverse_client.php
Starting
@@ -145,22 +143,20 @@ Status: 5/6 complete
Status: 6/6 complete
Success: !olleH
]]>
</screen>
</example>
</para>
</screen>
</example>
</section>
<section xml:id="gearman.examples-reverse-bg">
<title>Basic Gearman client and worker, background</title>
<para>
<example>
<title>Basic Gearman client and worker, background</title>
<para>
This example shows a very simple client and worker. The client sends a string
to the job server as a background job, and the worker reverses the string.
Note that since the work is performed asynchronously, the client does not
wait for the job to complete and exits (and hence the client never receives the results).
</para>
<programlisting role="php">
<example>
<title>Basic Gearman client and worker, background</title>
<para>
This example shows a very simple client and worker. The client sends a string
to the job server as a background job, and the worker reverses the string.
Note that since the work is performed asynchronously, the client does not
wait for the job to complete and exits (and hence the client never receives the results).
</para>
<programlisting role="php">
<![CDATA[
<?php
@@ -183,8 +179,8 @@ echo "done!\n";
?>
]]>
</programlisting>
<programlisting role="php">
</programlisting>
<programlisting role="php">
<![CDATA[
<?php
@@ -242,9 +238,9 @@ function reverse_fn_fast($job)
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
% php reverse_worker.php
Starting
@@ -267,26 +263,24 @@ Workload: this is a test (14)
14/14 complete
Result: tset a si siht
]]>
</screen>
<screen>
</screen>
<screen>
<![CDATA[
% php reverse_client_bg.php
done!
]]>
</screen>
</example>
</para>
</screen>
</example>
</section>
<section xml:id="gearman.examples-reverse-task">
<title>Basic Gearman client and worker, submitting tasks</title>
<para>
<example>
<title>Basic Gearman client and worker, submitting tasks</title>
<para>
In this example, the basic reverse client extended to run two tasks in parallel.
The reverse worker is unchanged except to add sending of data back during processing.
</para>
<programlisting role="php">
<example>
<title>Basic Gearman client and worker, submitting tasks</title>
<para>
In this example, the basic reverse client extended to run two tasks in parallel.
The reverse worker is unchanged except to add sending of data back during processing.
</para>
<programlisting role="php">
<![CDATA[
<?php
@@ -326,7 +320,7 @@ function reverse_created($task)
function reverse_status($task)
{
echo "STATUS: " . $task->jobHandle() . " - " . $task->taskNumerator() .
echo "STATUS: " . $task->jobHandle() . " - " . $task->taskNumerator() .
"/" . $task->taskDenominator() . "\n";
}
@@ -347,8 +341,8 @@ function reverse_data($task)
?>
]]>
</programlisting>
<programlisting role="php">
</programlisting>
<programlisting role="php">
<![CDATA[
<?php
@@ -407,9 +401,9 @@ function reverse_fn_fast($job)
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
% php reverse_worker.php
Starting
@@ -427,8 +421,8 @@ Workload: bar (3)
3/3 complete
Result: rab
]]>
</screen>
<screen>
</screen>
<screen>
<![CDATA[
% php reverse_client_task.php
CREATED: H:foo.local:44
@@ -449,12 +443,10 @@ DATA: r
COMPLETE: H:foo.local:44, rab
DONE
]]>
</screen>
</example>
</para>
</screen>
</example>
</section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -475,4 +467,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

36
reference/gearman/gearmanclient/addoptions.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.addoptions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.addoptions">
<refnamediv>
<refname>GearmanClient::addOptions</refname>
<refpurpose>Add client options</refpurpose>
@@ -19,24 +19,22 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The options to add.
One of the following constants, or a combination of
them using the bitwise OR operator (<quote>|</quote>):
<constant>GEARMAN_CLIENT_GENERATE_UNIQUE</constant>,
<constant>GEARMAN_CLIENT_NON_BLOCKING</constant>,
<constant>GEARMAN_CLIENT_UNBUFFERED_RESULT</constant> or
<constant>GEARMAN_CLIENT_FREE_TASKS</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The options to add.
One of the following constants, or a combination of
them using the bitwise OR operator (<quote>|</quote>):
<constant>GEARMAN_CLIENT_GENERATE_UNIQUE</constant>,
<constant>GEARMAN_CLIENT_NON_BLOCKING</constant>,
<constant>GEARMAN_CLIENT_UNBUFFERED_RESULT</constant> or
<constant>GEARMAN_CLIENT_FREE_TASKS</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">

62
reference/gearman/gearmanclient/addserver.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.addserver" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.addserver">
<refnamediv>
<refname>GearmanClient::addServer</refname>
<refpurpose>Add a job server to the client</refpurpose>
@@ -23,26 +23,24 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem>
<para>
&gearman.parameter.host;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
<para>
&gearman.parameter.port;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem>
<para>
&gearman.parameter.host;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
<para>
&gearman.parameter.port;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -54,10 +52,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Adding two job servers</title>
<programlisting role="php">
<example>
<title>Adding two job servers</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -65,23 +62,20 @@
$gmclient= new GearmanClient();
# Add two job servers, the first on the default 4730 port
$gmclient->addServer("10.0.0.1");
$gmclient->addServer("10.0.0.1");
$gmclient->addServer("10.0.0.2", 7003);
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::addServers</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::addServers</methodname></member>
</simplelist>
</refsect1>
</refentry>

44
reference/gearman/gearmanclient/addservers.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.addservers" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.addservers">
<refnamediv>
<refname>GearmanClient::addServers</refname>
<refpurpose>Add a list of job servers to the client</refpurpose>
@@ -22,18 +22,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>servers</parameter></term>
<listitem>
<para>
A comma-separated list of servers, each server specified in the format &apos;<literal>host:port</literal>&apos;.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>servers</parameter></term>
<listitem>
<para>
A comma-separated list of servers, each server specified in the format &apos;<literal>host:port</literal>&apos;.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -45,10 +43,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Add two job servers</title>
<programlisting role="php">
<example>
<title>Add two job servers</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -60,18 +57,15 @@ $gmclient->addServers("10.0.0.1,10.0.0.2:7003");
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::addServer</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::addServer</methodname></member>
</simplelist>
</refsect1>
</refentry>

110
reference/gearman/gearmanclient/addtask.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.addtask" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.addtask">
<refnamediv>
<refname>GearmanClient::addTask</refname>
<refpurpose>Add a task to be run in parallel</refpurpose>
@@ -17,7 +17,7 @@
</methodsynopsis>
<para>
Adds a task to be run in parallel with other tasks. Call this method for all the tasks
to be run in parallel, then call <methodname>GearmanClient::runTasks</methodname> to
to be run in parallel, then call <methodname>GearmanClient::runTasks</methodname> to
perform the work. Note that enough workers need to be available for the tasks to all
run in parallel.
</para>
@@ -25,42 +25,40 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
&gearman.parameter.context;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique_key</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
&gearman.parameter.context;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique_key</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -80,26 +78,26 @@
<?php
# Create our gearman client
$gmclient= new GearmanClient();
$gmclient= new GearmanClient();
# add the default job server
$gmclient->addServer();
$gmclient->addServer();
# set a function to be called when the work is complete
$gmclient->setCompleteCallback("complete");
$gmclient->setCompleteCallback("complete");
# add a task to perform the "reverse" function on the string "Hello World!"
$gmclient->addTask("reverse", "Hello World!", null, "1");
$gmclient->addTask("reverse", "Hello World!", null, "1");
# add another task to perform the "reverse" function on the string "!dlroW olleH"
$gmclient->addTask("reverse", "!dlroW olleH", null, "2");
$gmclient->addTask("reverse", "!dlroW olleH", null, "2");
# run the tasks
$gmclient->runTasks();
$gmclient->runTasks();
function complete($task)
{
print "COMPLETE: " . $task->unique() . ", " . $task->data() . "\n";
function complete($task)
{
print "COMPLETE: " . $task->unique() . ", " . $task->data() . "\n";
}
?>
@@ -158,16 +156,14 @@ t1: H:foo:22, !dlroW olleH
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::addTaskHigh</methodname></member>
<member><methodname>GearmanClient::addTaskLow</methodname></member>
<member><methodname>GearmanClient::addTaskBackground</methodname></member>
<member><methodname>GearmanClient::addTaskHighBackground</methodname></member>
<member><methodname>GearmanClient::addTaskLowBackground</methodname></member>
<member><methodname>GearmanClient::runTasks</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::addTaskHigh</methodname></member>
<member><methodname>GearmanClient::addTaskLow</methodname></member>
<member><methodname>GearmanClient::addTaskBackground</methodname></member>
<member><methodname>GearmanClient::addTaskHighBackground</methodname></member>
<member><methodname>GearmanClient::addTaskLowBackground</methodname></member>
<member><methodname>GearmanClient::runTasks</methodname></member>
</simplelist>
</refsect1>
</refentry>

146
reference/gearman/gearmanclient/addtaskbackground.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.addtaskbackground" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.addtaskbackground">
<refnamediv>
<refname>GearmanClient::addTaskBackground</refname>
<refpurpose>Add a background task to be run in parallel</refpurpose>
@@ -24,42 +24,40 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
&gearman.parameter.context;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique_key</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
&gearman.parameter.context;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique_key</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -71,19 +69,18 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Two tasks, one background and one not</title>
<para>
This example illustrates the difference between running a background task
and a normal task. The client adds two tasks to execute the same function,
but one is added with <methodname>addTaskBackground</methodname>. A callback is
set so that progress of the job can be tracked. A simple worker with an
artificial delay reports on the job progress and the client picks this up
through the callback. Two workers are run for this example. Note that the
background task does not show in the client output.
</para>
<programlisting role="php">
<example>
<title>Two tasks, one background and one not</title>
<para>
This example illustrates the difference between running a background task
and a normal task. The client adds two tasks to execute the same function,
but one is added with <methodname>addTaskBackground</methodname>. A callback is
set so that progress of the job can be tracked. A simple worker with an
artificial delay reports on the job progress and the client picks this up
through the callback. Two workers are run for this example. Note that the
background task does not show in the client output.
</para>
<programlisting role="php">
<![CDATA[
<?php
@@ -115,7 +112,7 @@ echo "DONE\n";
function reverse_status($task)
{
echo "STATUS: " . $task->unique() . ", " . $task->jobHandle() . " - " . $task->taskNumerator() .
echo "STATUS: " . $task->unique() . ", " . $task->jobHandle() . " - " . $task->taskNumerator() .
"/" . $task->taskDenominator() . "\n";
}
@@ -126,8 +123,8 @@ function reverse_complete($task)
?>
]]>
</programlisting>
<programlisting role="php">
</programlisting>
<programlisting role="php">
<![CDATA[
<?php
@@ -181,11 +178,11 @@ function reverse_fn($job)
?>
]]>
</programlisting>
<para>
Worker output for two workers running:
</para>
<screen>
</programlisting>
<para>
Worker output for two workers running:
</para>
<screen>
<![CDATA[
Received job: H:foo.local:65
Workload: !dlroW olleH (12)
@@ -218,11 +215,11 @@ Sending status: 12/12 complete
Result: !dlroW olleH
Result: Hello World!
]]>
</screen>
<para>
Client output:
</para>
<screen>
</screen>
<para>
Client output:
</para>
<screen>
<![CDATA[
STATUS: 1, H:foo.local:66 - 1/12
STATUS: 1, H:foo.local:66 - 2/12
@@ -239,23 +236,20 @@ STATUS: 1, H:foo.local:66 - 12/12
COMPLETE: 1, !dlroW olleH
DONE
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::addTask</methodname></member>
<member><methodname>GearmanClient::addTaskHigh</methodname></member>
<member><methodname>GearmanClient::addTaskLow</methodname></member>
<member><methodname>GearmanClient::addTaskHighBackground</methodname></member>
<member><methodname>GearmanClient::addTaskLowBackground</methodname></member>
<member><methodname>GearmanClient::runTasks</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::addTask</methodname></member>
<member><methodname>GearmanClient::addTaskHigh</methodname></member>
<member><methodname>GearmanClient::addTaskLow</methodname></member>
<member><methodname>GearmanClient::addTaskHighBackground</methodname></member>
<member><methodname>GearmanClient::addTaskLowBackground</methodname></member>
<member><methodname>GearmanClient::runTasks</methodname></member>
</simplelist>
</refsect1>
</refentry>

118
reference/gearman/gearmanclient/addtaskhigh.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.addtaskhigh" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.addtaskhigh">
<refnamediv>
<refname>GearmanClient::addTaskHigh</refname>
<refpurpose>Add a high priority task to run in parallel</refpurpose>
@@ -25,42 +25,40 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
&gearman.parameter.context;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique_key</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
&gearman.parameter.context;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique_key</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -72,15 +70,14 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A high priority task along with two normal tasks</title>
<para>
A high priority task is included among two other tasks. A single worker
is available, so that tasks are run one at a time, with the high priority
task run first.
</para>
<programlisting role="php">
<example>
<title>A high priority task along with two normal tasks</title>
<para>
A high priority task is included among two other tasks. A single worker
is available, so that tasks are run one at a time, with the high priority
task run first.
</para>
<programlisting role="php">
<![CDATA[
<?php
@@ -112,32 +109,29 @@ function reverse_complete($task)
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
COMPLETE: 2, Hello World!
COMPLETE: 3, !dlroW olleH
COMPLETE: 1, !dlroW olleH
DONE
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::addTask</methodname></member>
<member><methodname>GearmanClient::addTaskLow</methodname></member>
<member><methodname>GearmanClient::addTaskBackground</methodname></member>
<member><methodname>GearmanClient::addTaskHighBackground</methodname></member>
<member><methodname>GearmanClient::addTaskLowBackground</methodname></member>
<member><methodname>GearmanClient::runTasks</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::addTask</methodname></member>
<member><methodname>GearmanClient::addTaskLow</methodname></member>
<member><methodname>GearmanClient::addTaskBackground</methodname></member>
<member><methodname>GearmanClient::addTaskHighBackground</methodname></member>
<member><methodname>GearmanClient::addTaskLowBackground</methodname></member>
<member><methodname>GearmanClient::runTasks</methodname></member>
</simplelist>
</refsect1>
</refentry>

90
reference/gearman/gearmanclient/addtaskhighbackground.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.addtaskhighbackground" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.addtaskhighbackground">
<refnamediv>
<refname>GearmanClient::addTaskHighBackground</refname>
<refpurpose>Add a high priority background task to be run in parallel</refpurpose>
@@ -25,42 +25,40 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
&gearman.parameter.context;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique_key</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
&gearman.parameter.context;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique_key</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -72,16 +70,14 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::addTask</methodname></member>
<member><methodname>GearmanClient::addTaskHigh</methodname></member>
<member><methodname>GearmanClient::addTaskLow</methodname></member>
<member><methodname>GearmanClient::addTaskBackground</methodname></member>
<member><methodname>GearmanClient::addTaskLowBackground</methodname></member>
<member><methodname>GearmanClient::runTasks</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::addTask</methodname></member>
<member><methodname>GearmanClient::addTaskHigh</methodname></member>
<member><methodname>GearmanClient::addTaskLow</methodname></member>
<member><methodname>GearmanClient::addTaskBackground</methodname></member>
<member><methodname>GearmanClient::addTaskLowBackground</methodname></member>
<member><methodname>GearmanClient::runTasks</methodname></member>
</simplelist>
</refsect1>
</refentry>

118
reference/gearman/gearmanclient/addtasklow.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.addtasklow" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.addtasklow">
<refnamediv>
<refname>GearmanClient::addTaskLow</refname>
<refpurpose>Add a low priority task to run in parallel</refpurpose>
@@ -25,42 +25,40 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
&gearman.parameter.context;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique_key</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
&gearman.parameter.context;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique_key</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -72,15 +70,14 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A low priority task along with two normal tasks</title>
<para>
A low priority task is included among two other tasks. A single worker
is available, so that tasks are run one at a time, with the low priority
task run last.
</para>
<programlisting role="php">
<example>
<title>A low priority task along with two normal tasks</title>
<para>
A low priority task is included among two other tasks. A single worker
is available, so that tasks are run one at a time, with the low priority
task run last.
</para>
<programlisting role="php">
<![CDATA[
<?php
@@ -112,32 +109,29 @@ function reverse_complete($task)
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
COMPLETE: 3, !dlroW olleH
COMPLETE: 1, !dlroW olleH
COMPLETE: 2, Hello World!
DONE
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::addTask</methodname></member>
<member><methodname>GearmanClient::addTaskHigh</methodname></member>
<member><methodname>GearmanClient::addTaskBackground</methodname></member>
<member><methodname>GearmanClient::addTaskHighBackground</methodname></member>
<member><methodname>GearmanClient::addTaskLowBackground</methodname></member>
<member><methodname>GearmanClient::runTasks</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::addTask</methodname></member>
<member><methodname>GearmanClient::addTaskHigh</methodname></member>
<member><methodname>GearmanClient::addTaskBackground</methodname></member>
<member><methodname>GearmanClient::addTaskHighBackground</methodname></member>
<member><methodname>GearmanClient::addTaskLowBackground</methodname></member>
<member><methodname>GearmanClient::runTasks</methodname></member>
</simplelist>
</refsect1>
</refentry>

90
reference/gearman/gearmanclient/addtasklowbackground.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.addtasklowbackground" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.addtasklowbackground">
<refnamediv>
<refname>GearmanClient::addTaskLowBackground</refname>
<refpurpose>Add a low priority background task to be run in parallel</refpurpose>
@@ -25,42 +25,40 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
&gearman.parameter.context;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique_key</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
&gearman.parameter.context;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique_key</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -72,16 +70,14 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::addTask</methodname></member>
<member><methodname>GearmanClient::addTaskHigh</methodname></member>
<member><methodname>GearmanClient::addTaskLow</methodname></member>
<member><methodname>GearmanClient::addTaskBackground</methodname></member>
<member><methodname>GearmanClient::addTaskHighBackground</methodname></member>
<member><methodname>GearmanClient::runTasks</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::addTask</methodname></member>
<member><methodname>GearmanClient::addTaskHigh</methodname></member>
<member><methodname>GearmanClient::addTaskLow</methodname></member>
<member><methodname>GearmanClient::addTaskBackground</methodname></member>
<member><methodname>GearmanClient::addTaskHighBackground</methodname></member>
<member><methodname>GearmanClient::runTasks</methodname></member>
</simplelist>
</refsect1>
</refentry>

74
reference/gearman/gearmanclient/addtaskstatus.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.addtaskstatus" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.addtaskstatus">
<refnamediv>
<refname>GearmanClient::addTaskStatus</refname>
<refpurpose>Add a task to get status</refpurpose>
@@ -21,26 +21,24 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>job_handle</parameter></term>
<listitem>
<para>
The job handle for the task to get status for
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
Data to be passed to the status callback, generally a reference to an array or object
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>job_handle</parameter></term>
<listitem>
<para>
The job handle for the task to get status for
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
Data to be passed to the status callback, generally a reference to an array or object
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -52,14 +50,13 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Monitor completion of multiple background tasks</title>
<para>
An artificial delay is introduced in the worker in this example to simulate
a long running process. There is only one worker running for this example.
</para>
<programlisting role="php">
<example>
<title>Monitor completion of multiple background tasks</title>
<para>
An artificial delay is introduced in the worker in this example to simulate
a long running process. There is only one worker running for this example.
</para>
<programlisting role="php">
<![CDATA[
<?php
@@ -98,9 +95,9 @@ function reverse_status($task, $done)
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Done: 0
Done: 0
@@ -128,18 +125,15 @@ Done: 1
Done: 1
Done: 2
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
</simplelist>
</refsect1>
</refentry>

24
reference/gearman/gearmanclient/clearcallbacks.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.clearcallbacks" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.clearcallbacks">
<refnamediv>
<refname>GearmanClient::clearCallbacks</refname>
<refpurpose>Clear all task callback functions</refpurpose>
@@ -31,18 +31,16 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmanclient/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.construct">
<refnamediv>
<refname>GearmanClient::__construct</refname>
<refpurpose>Create a GearmanClient instance</refpurpose>
@@ -32,11 +32,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::clone</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::clone</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmanclient/context.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.context" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.context">
<refnamediv>
<refname>GearmanClient::context</refname>
<refpurpose>Get the application context</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::setContext</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::setContext</methodname></member>
</simplelist>
</refsect1>
</refentry>

14
reference/gearman/gearmanclient/data.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.data" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.data">
<refnamediv>
<refname>GearmanClient::data</refname>
<refpurpose>Get the application data (deprecated)</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>GearmanClient::data</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Get the application data previously set with <methodname>GearmanClient::setData</methodname>.
@@ -38,15 +37,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::setData</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::setData</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

74
reference/gearman/gearmanclient/do.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.do" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.do">
<refnamediv>
<refname>GearmanClient::do</refname>
<refpurpose>Run a single task and return a result [deprecated]</refpurpose>
@@ -23,34 +22,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -290,19 +287,16 @@ Success: !olleH
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::doHigh</methodname></member>
<member><methodname>GearmanClient::doLow</methodname></member>
<member><methodname>GearmanClient::doBackground</methodname></member>
<member><methodname>GearmanClient::doHighBackground</methodname></member>
<member><methodname>GearmanClient::doLowBackground</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::doHigh</methodname></member>
<member><methodname>GearmanClient::doLow</methodname></member>
<member><methodname>GearmanClient::doBackground</methodname></member>
<member><methodname>GearmanClient::doHighBackground</methodname></member>
<member><methodname>GearmanClient::doLowBackground</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

100
reference/gearman/gearmanclient/dobackground.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.dobackground" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.dobackground">
<refnamediv>
<refname>GearmanClient::doBackground</refname>
<refpurpose>Run a task in the background</refpurpose>
@@ -22,34 +22,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -61,15 +59,14 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Submit and monitor a background job</title>
<para>
The worker in this example has an artificial delay introduced to mimic
a long running job. The client script periodically checks the status
of the running job.
</para>
<programlisting role="php">
<example>
<title>Submit and monitor a background job</title>
<para>
The worker in this example has an artificial delay introduced to mimic
a long running job. The client script periodically checks the status
of the running job.
</para>
<programlisting role="php">
<![CDATA[
<?php
@@ -103,9 +100,9 @@ echo "done!\n";
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Running: true, numerator: 3, denominator: 14
Running: true, numerator: 6, denominator: 14
@@ -114,22 +111,19 @@ Running: true, numerator: 12, denominator: 14
Running: false, numerator: 0, denominator: 0
done!
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::doNormal</methodname></member>
<member><methodname>GearmanClient::doHigh</methodname></member>
<member><methodname>GearmanClient::doLow</methodname></member>
<member><methodname>GearmanClient::doHighBackground</methodname></member>
<member><methodname>GearmanClient::doLowBackground</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::doNormal</methodname></member>
<member><methodname>GearmanClient::doHigh</methodname></member>
<member><methodname>GearmanClient::doLow</methodname></member>
<member><methodname>GearmanClient::doHighBackground</methodname></member>
<member><methodname>GearmanClient::doLowBackground</methodname></member>
</simplelist>
</refsect1>
</refentry>

72
reference/gearman/gearmanclient/dohigh.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.dohigh" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.dohigh">
<refnamediv>
<refname>GearmanClient::doHigh</refname>
<refpurpose>Run a single high priority task</refpurpose>
@@ -24,34 +24,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -63,15 +61,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::doNormal</methodname></member>
<member><methodname>GearmanClient::doLow</methodname></member>
<member><methodname>GearmanClient::doBackground</methodname></member>
<member><methodname>GearmanClient::doHighBackground</methodname></member>
<member><methodname>GearmanClient::doLowBackground</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::doNormal</methodname></member>
<member><methodname>GearmanClient::doLow</methodname></member>
<member><methodname>GearmanClient::doBackground</methodname></member>
<member><methodname>GearmanClient::doHighBackground</methodname></member>
<member><methodname>GearmanClient::doLowBackground</methodname></member>
</simplelist>
</refsect1>
</refentry>

72
reference/gearman/gearmanclient/dohighbackground.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.dohighbackground" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.dohighbackground">
<refnamediv>
<refname>GearmanClient::doHighBackground</refname>
<refpurpose>Run a high priority task in the background</refpurpose>
@@ -23,34 +23,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -62,15 +60,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::doNormal</methodname></member>
<member><methodname>GearmanClient::doHigh</methodname></member>
<member><methodname>GearmanClient::doLow</methodname></member>
<member><methodname>GearmanClient::doBackground</methodname></member>
<member><methodname>GearmanClient::doLowBackground</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::doNormal</methodname></member>
<member><methodname>GearmanClient::doHigh</methodname></member>
<member><methodname>GearmanClient::doLow</methodname></member>
<member><methodname>GearmanClient::doBackground</methodname></member>
<member><methodname>GearmanClient::doLowBackground</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmanclient/dojobhandle.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.dojobhandle" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.dojobhandle">
<refnamediv>
<refname>GearmanClient::doJobHandle</refname>
<refpurpose>Get the job handle for the running task</refpurpose>
@@ -33,11 +33,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::jobStatus</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::jobStatus</methodname></member>
</simplelist>
</refsect1>
</refentry>

72
reference/gearman/gearmanclient/dolow.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.dolow" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.dolow">
<refnamediv>
<refname>GearmanClient::doLow</refname>
<refpurpose>Run a single low priority task</refpurpose>
@@ -24,34 +24,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -63,15 +61,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::doNormal</methodname></member>
<member><methodname>GearmanClient::doHigh</methodname></member>
<member><methodname>GearmanClient::doBackground</methodname></member>
<member><methodname>GearmanClient::doHighBackground</methodname></member>
<member><methodname>GearmanClient::doLowBackground</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::doNormal</methodname></member>
<member><methodname>GearmanClient::doHigh</methodname></member>
<member><methodname>GearmanClient::doBackground</methodname></member>
<member><methodname>GearmanClient::doHighBackground</methodname></member>
<member><methodname>GearmanClient::doLowBackground</methodname></member>
</simplelist>
</refsect1>
</refentry>

72
reference/gearman/gearmanclient/dolowbackground.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.dolowbackground" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.dolowbackground">
<refnamediv>
<refname>GearmanClient::doLowBackground</refname>
<refpurpose>Run a low priority task in the background</refpurpose>
@@ -23,34 +23,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -62,15 +60,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::doNormal</methodname></member>
<member><methodname>GearmanClient::doHigh</methodname></member>
<member><methodname>GearmanClient::doLow</methodname></member>
<member><methodname>GearmanClient::doBackground</methodname></member>
<member><methodname>GearmanClient::doHighBackground</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::doNormal</methodname></member>
<member><methodname>GearmanClient::doHigh</methodname></member>
<member><methodname>GearmanClient::doLow</methodname></member>
<member><methodname>GearmanClient::doBackground</methodname></member>
<member><methodname>GearmanClient::doHighBackground</methodname></member>
</simplelist>
</refsect1>
</refentry>

72
reference/gearman/gearmanclient/donormal.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.donormal" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.donormal">
<refnamediv>
<refname>GearmanClient::doNormal</refname>
<refpurpose>Run a single task and return a result</refpurpose>
@@ -23,34 +23,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
&gearman.parameter.functionname;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
&gearman.parameter.workload;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique</parameter></term>
<listitem>
<para>
&gearman.parameter.unique;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -297,15 +295,13 @@ Success: !olleH
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::doHigh</methodname></member>
<member><methodname>GearmanClient::doLow</methodname></member>
<member><methodname>GearmanClient::doBackground</methodname></member>
<member><methodname>GearmanClient::doHighBackground</methodname></member>
<member><methodname>GearmanClient::doLowBackground</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::doHigh</methodname></member>
<member><methodname>GearmanClient::doLow</methodname></member>
<member><methodname>GearmanClient::doBackground</methodname></member>
<member><methodname>GearmanClient::doHighBackground</methodname></member>
<member><methodname>GearmanClient::doLowBackground</methodname></member>
</simplelist>
</refsect1>
</refentry>

40
reference/gearman/gearmanclient/dostatus.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.dostatus" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.dostatus">
<refnamediv>
<refname>GearmanClient::doStatus</refname>
<refpurpose>Get the status for the running task</refpurpose>
@@ -33,15 +33,14 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Get the status of a long running job</title>
<para>
The worker in this example has an artificial delay added during processing of the
string to be reversed. After each delay it calls <methodname>GearmanJob::status</methodname>
which the client then picks up.
</para>
<programlisting role="php">
<example>
<title>Get the status of a long running job</title>
<para>
The worker in this example has an artificial delay added during processing of the
string to be reversed. After each delay it calls <methodname>GearmanJob::status</methodname>
which the client then picks up.
</para>
<programlisting role="php">
<![CDATA[
<?php
@@ -86,9 +85,9 @@ echo "Success: $result\n";
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Starting
Sending job
@@ -100,19 +99,16 @@ Status: 5/6 complete
Status: 6/6 complete
Success: !olleH
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::doNormal</methodname></member>
<member><methodname>GearmanJob::status</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::doNormal</methodname></member>
<member><methodname>GearmanJob::status</methodname></member>
</simplelist>
</refsect1>
</refentry>

26
reference/gearman/gearmanclient/echo.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.echo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.echo">
<refnamediv>
<refname>GearmanClient::echo</refname>
<refpurpose>Send data to all job servers to see if they echo it back [deprecated]</refpurpose>
@@ -21,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
Some arbitrary serialized data to be echo back
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
Some arbitrary serialized data to be echo back
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,7 +40,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/gearman/gearmanclient/error.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.error" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.error">
<refnamediv>
<refname>GearmanClient::error</refname>
<refpurpose>Returns an error string for the last error encountered</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::getErrno</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::getErrno</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmanclient/geterrno.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.geterrno" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.geterrno">
<refnamediv>
<refname>GearmanClient::getErrno</refname>
<refpurpose>Get an errno value</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::error</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::error</methodname></member>
</simplelist>
</refsect1>
</refentry>

50
reference/gearman/gearmanclient/jobstatus.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.jobstatus" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.jobstatus">
<refnamediv>
<refname>GearmanClient::jobStatus</refname>
<refname>gearman_job_status</refname>
@@ -23,18 +23,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>job_handle</parameter></term>
<listitem>
<para>
&gearman.parameter.jobhandle;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>job_handle</parameter></term>
<listitem>
<para>
&gearman.parameter.jobhandle;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -50,10 +48,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Monitor the status of a long running background job</title>
<programlisting role="php">
<example>
<title>Monitor the status of a long running background job</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -87,9 +84,9 @@ echo "done!\n";
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Running: true, numerator: 3, denomintor: 14
Running: true, numerator: 6, denomintor: 14
@@ -98,18 +95,15 @@ Running: true, numerator: 12, denomintor: 14
Running: false, numerator: 0, denomintor: 0
done!
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::doStatus</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::doStatus</methodname></member>
</simplelist>
</refsect1>
</refentry>

24
reference/gearman/gearmanclient/ping.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.ping" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.ping">
<refnamediv>
<refname>GearmanClient::ping</refname>
<refpurpose>Send data to all job servers to see if they echo it back</refpurpose>
@@ -20,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
Some arbitrary serialized data to be echo back
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
Some arbitrary serialized data to be echo back
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">

24
reference/gearman/gearmanclient/removeoptions.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.removeoptions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.removeoptions">
<refnamediv>
<refname>GearmanClient::removeOptions</refname>
<refpurpose>Remove client options</refpurpose>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The options to be removed (unset)
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The options to be removed (unset)
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">

10
reference/gearman/gearmanclient/runtasks.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.runtasks" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.runtasks">
<refnamediv>
<refname>GearmanClient::runTasks</refname>
<refpurpose>Run a list of tasks in parallel</refpurpose>
@@ -35,11 +35,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::addTask</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::addTask</methodname></member>
</simplelist>
</refsect1>
</refentry>

34
reference/gearman/gearmanclient/setclientcallback.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.setclientcallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.setclientcallback">
<refnamediv>
<refname>GearmanClient::setClientCallback</refname>
<refpurpose>Callback function when there is a data packet for a task (deprecated)</refpurpose>
@@ -27,11 +26,9 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,22 +40,19 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/gearman/gearmanclient/setcompletecallback.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.setcompletecallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.setcompletecallback">
<refnamediv>
<refname>GearmanClient::setCompleteCallback</refname>
<refpurpose>Set a function to be called on task completion</refpurpose>
@@ -26,11 +26,9 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -42,17 +40,15 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</refsect1>
</refentry>

32
reference/gearman/gearmanclient/setcontext.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.setcontext" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.setcontext">
<refnamediv>
<refname>GearmanClient::setContext</refname>
<refpurpose>Set application context</refpurpose>
@@ -20,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Arbitrary context data
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Arbitrary context data
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,11 +41,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::context</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::context</methodname></member>
</simplelist>
</refsect1>
</refentry>

30
reference/gearman/gearmanclient/setcreatedcallback.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.setcreatedcallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.setcreatedcallback">
<refnamediv>
<refname>GearmanClient::setCreatedCallback</refname>
<refpurpose>Set a callback for when a task is queued</refpurpose>
@@ -20,11 +20,9 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -36,17 +34,15 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</refsect1>
</refentry>

34
reference/gearman/gearmanclient/setdata.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.setdata" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.setdata">
<refnamediv>
<refname>GearmanClient::setData</refname>
<refpurpose>Set application data (deprecated)</refpurpose>
@@ -14,7 +13,7 @@
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
Sets some arbitrary application data that can later be retrieved by
Sets some arbitrary application data that can later be retrieved by
<methodname>GearmanClient::data</methodname>.
</para>
<note>
@@ -27,17 +26,15 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -49,15 +46,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::data</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::data</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/gearman/gearmanclient/setdatacallback.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.setdatacallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.setdatacallback">
<refnamediv>
<refname>GearmanClient::setDataCallback</refname>
<refpurpose>Callback function when there is a data packet for a task</refpurpose>
@@ -20,11 +20,9 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -36,17 +34,15 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</refsect1>
</refentry>

30
reference/gearman/gearmanclient/setexceptioncallback.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.setexceptioncallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.setexceptioncallback">
<refnamediv>
<refname>GearmanClient::setExceptionCallback</refname>
<refpurpose>Set a callback for worker exceptions</refpurpose>
@@ -20,11 +20,9 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -36,17 +34,15 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</refsect1>
</refentry>

30
reference/gearman/gearmanclient/setfailcallback.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.setfailcallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.setfailcallback">
<refnamediv>
<refname>GearmanClient::setFailCallback</refname>
<refpurpose>Set callback for job failure</refpurpose>
@@ -20,11 +20,9 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -36,17 +34,15 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</refsect1>
</refentry>

24
reference/gearman/gearmanclient/setoptions.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.setoptions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.setoptions">
<refnamediv>
<refname>GearmanClient::setOptions</refname>
<refpurpose>Set client options</refpurpose>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The options to be set
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The options to be set
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">

30
reference/gearman/gearmanclient/setstatuscallback.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.setstatuscallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.setstatuscallback">
<refnamediv>
<refname>GearmanClient::setStatusCallback</refname>
<refpurpose>Set a callback for collecting task status</refpurpose>
@@ -20,11 +20,9 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -36,17 +34,15 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</refsect1>
</refentry>

24
reference/gearman/gearmanclient/settimeout.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.settimeout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.settimeout">
<refnamediv>
<refname>GearmanClient::setTimeout</refname>
<refpurpose>Set socket I/O activity timeout</refpurpose>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
An interval of time in milliseconds
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
An interval of time in milliseconds
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">

30
reference/gearman/gearmanclient/setwarningcallback.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.setwarningcallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.setwarningcallback">
<refnamediv>
<refname>GearmanClient::setWarningCallback</refname>
<refpurpose>Set a callback for worker warnings</refpurpose>
@@ -20,11 +20,9 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -36,17 +34,15 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWorkloadCallback</methodname></member>
</simplelist>
</refsect1>
</refentry>

30
reference/gearman/gearmanclient/setworkloadcallback.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.setworkloadcallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.setworkloadcallback">
<refnamediv>
<refname>GearmanClient::setWorkloadCallback</refname>
<refpurpose>Set a callback for accepting incremental data updates</refpurpose>
@@ -22,11 +22,9 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</para>
<variablelist>
&gearman.parameter.callback;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -38,17 +36,15 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::setDataCallback</methodname></member>
<member><methodname>GearmanClient::setCompleteCallback</methodname></member>
<member><methodname>GearmanClient::setCreatedCallback</methodname></member>
<member><methodname>GearmanClient::setExceptionCallback</methodname></member>
<member><methodname>GearmanClient::setFailCallback</methodname></member>
<member><methodname>GearmanClient::setStatusCallback</methodname></member>
<member><methodname>GearmanClient::setWarningCallback</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmanclient/timeout.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.timeout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.timeout">
<refnamediv>
<refname>GearmanClient::timeout</refname>
<refpurpose>Get current socket I/O activity timeout value</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::setTimeout</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::setTimeout</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmanclient/wait.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanclient.wait" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanclient.wait">
<refnamediv>
<refname>GearmanClient::wait</refname>
<refpurpose>Wait for I/O activity on all connections in a client</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::wait</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::wait</methodname></member>
</simplelist>
</refsect1>
</refentry>

36
reference/gearman/gearmanjob/complete.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.complete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.complete">
<refnamediv>
<refname>GearmanJob::complete</refname>
<refpurpose>Send the result and complete status (deprecated)</refpurpose>
@@ -26,18 +25,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
Serialized result data.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
Serialized result data.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -49,16 +46,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanJob::sendFail</methodname></member>
<member><methodname>GearmanJob::setReturn</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanJob::sendFail</methodname></member>
<member><methodname>GearmanJob::setReturn</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

36
reference/gearman/gearmanjob/data.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.data" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.data">
<refnamediv>
<refname>GearmanJob::data</refname>
<refpurpose>Send data for a running job (deprecated)</refpurpose>
@@ -26,18 +25,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Arbitrary serialized data.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Arbitrary serialized data.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -49,16 +46,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanJob::workload</methodname></member>
<member><methodname>GearmanTask::data</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanJob::workload</methodname></member>
<member><methodname>GearmanTask::data</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

38
reference/gearman/gearmanjob/exception.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.exception" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.exception">
<refnamediv>
<refname>GearmanJob::exception</refname>
<refpurpose>Send exception for running job (deprecated)</refpurpose>
@@ -26,18 +25,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>exception</parameter></term>
<listitem>
<para>
An exception description.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>exception</parameter></term>
<listitem>
<para>
An exception description.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -49,17 +46,14 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanJob::setReturn</methodname></member>
<member><methodname>GearmanJob::sendStatus</methodname></member>
<member><methodname>GearmanJob::sendWarning</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanJob::setReturn</methodname></member>
<member><methodname>GearmanJob::sendStatus</methodname></member>
<member><methodname>GearmanJob::sendWarning</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/gearman/gearmanjob/fail.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.fail" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.fail">
<refnamediv>
<refname>GearmanJob::fail</refname>
<refpurpose>Send fail status (deprecated)</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>GearmanJob::fail</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Sends failure status for this job, indicating that the job failed in a known way (as
@@ -19,7 +18,7 @@
</para>
<note>
<para>
This method has been replaced by <methodname>GearmanJob::sendFail</methodname> in the
This method has been replaced by <methodname>GearmanJob::sendFail</methodname> in the
0.6.0 release of the Gearman extension.
</para>
</note>
@@ -39,18 +38,15 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanJob::sendException</methodname></member>
<member><methodname>GearmanJob::setReturn</methodname></member>
<member><methodname>GearmanJob::sendStatus</methodname></member>
<member><methodname>GearmanJob::sendWarning</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanJob::sendException</methodname></member>
<member><methodname>GearmanJob::setReturn</methodname></member>
<member><methodname>GearmanJob::sendStatus</methodname></member>
<member><methodname>GearmanJob::sendWarning</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/gearman/gearmanjob/functionname.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.functionname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.functionname">
<refnamediv>
<refname>GearmanJob::functionName</refname>
<refpurpose>Get function name</refpurpose>
@@ -32,11 +32,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanTask::function</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanTask::function</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmanjob/handle.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.handle" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.handle">
<refnamediv>
<refname>GearmanJob::handle</refname>
<refpurpose>Get the job handle</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanTask::jobHandle</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanTask::jobHandle</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmanjob/returncode.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.returncode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.returncode">
<refnamediv>
<refname>GearmanJob::returnCode</refname>
<refpurpose>Get last return code</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanTask::returnCode</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanTask::returnCode</methodname></member>
</simplelist>
</refsect1>
</refentry>

34
reference/gearman/gearmanjob/sendcomplete.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.sendcomplete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.sendcomplete">
<refnamediv>
<refname>GearmanJob::sendComplete</refname>
<refpurpose>Send the result and complete status</refpurpose>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
Serialized result data.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
Serialized result data.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -42,12 +40,10 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanJob::sendFail</methodname></member>
<member><methodname>GearmanJob::setReturn</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanJob::sendFail</methodname></member>
<member><methodname>GearmanJob::setReturn</methodname></member>
</simplelist>
</refsect1>
</refentry>

34
reference/gearman/gearmanjob/senddata.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.senddata" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.senddata">
<refnamediv>
<refname>GearmanJob::sendData</refname>
<refpurpose>Send data for a running job</refpurpose>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Arbitrary serialized data.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Arbitrary serialized data.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -42,12 +40,10 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanJob::workload</methodname></member>
<member><methodname>GearmanTask::data</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanJob::workload</methodname></member>
<member><methodname>GearmanTask::data</methodname></member>
</simplelist>
</refsect1>
</refentry>

36
reference/gearman/gearmanjob/sendexception.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.sendexception" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.sendexception">
<refnamediv>
<refname>GearmanJob::sendException</refname>
<refpurpose>Send exception for running job (exception)</refpurpose>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>exception</parameter></term>
<listitem>
<para>
An exception description.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>exception</parameter></term>
<listitem>
<para>
An exception description.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -42,13 +40,11 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanJob::setReturn</methodname></member>
<member><methodname>GearmanJob::sendStatus</methodname></member>
<member><methodname>GearmanJob::sendWarning</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanJob::setReturn</methodname></member>
<member><methodname>GearmanJob::sendStatus</methodname></member>
<member><methodname>GearmanJob::sendWarning</methodname></member>
</simplelist>
</refsect1>
</refentry>

16
reference/gearman/gearmanjob/sendfail.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.sendfail" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.sendfail">
<refnamediv>
<refname>GearmanJob::sendFail</refname>
<refpurpose>Send fail status</refpurpose>
@@ -32,14 +32,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanJob::sendException</methodname></member>
<member><methodname>GearmanJob::setReturn</methodname></member>
<member><methodname>GearmanJob::sendStatus</methodname></member>
<member><methodname>GearmanJob::sendWarning</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanJob::sendException</methodname></member>
<member><methodname>GearmanJob::setReturn</methodname></member>
<member><methodname>GearmanJob::sendStatus</methodname></member>
<member><methodname>GearmanJob::sendWarning</methodname></member>
</simplelist>
</refsect1>
</refentry>

52
reference/gearman/gearmanjob/sendstatus.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.sendstatus" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.sendstatus">
<refnamediv>
<refname>GearmanJob::sendStatus</refname>
<refpurpose>Send status</refpurpose>
@@ -21,26 +21,24 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>numerator</parameter></term>
<listitem>
<para>
The numerator of the precentage completed expressed as a fraction.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>denominator</parameter></term>
<listitem>
<para>
The denominator of the precentage completed expressed as a fraction.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>numerator</parameter></term>
<listitem>
<para>
The numerator of the precentage completed expressed as a fraction.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>denominator</parameter></term>
<listitem>
<para>
The denominator of the precentage completed expressed as a fraction.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -52,13 +50,11 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::jobStatus</methodname></member>
<member><methodname>GearmanTask::taskDenominator</methodname></member>
<member><methodname>GearmanTask::taskNumerator</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::jobStatus</methodname></member>
<member><methodname>GearmanTask::taskDenominator</methodname></member>
<member><methodname>GearmanTask::taskNumerator</methodname></member>
</simplelist>
</refsect1>
</refentry>

36
reference/gearman/gearmanjob/sendwarning.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.sendwarning" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.sendwarning">
<refnamediv>
<refname>GearmanJob::sendWarning</refname>
<refpurpose>Send a warning</refpurpose>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>warning</parameter></term>
<listitem>
<para>
A warning message.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>warning</parameter></term>
<listitem>
<para>
A warning message.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -42,13 +40,11 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanJob::sendComplete</methodname></member>
<member><methodname>GearmanJob::sendException</methodname></member>
<member><methodname>GearmanJob::sendFail</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanJob::sendComplete</methodname></member>
<member><methodname>GearmanJob::sendException</methodname></member>
<member><methodname>GearmanJob::sendFail</methodname></member>
</simplelist>
</refsect1>
</refentry>

24
reference/gearman/gearmanjob/setreturn.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.setreturn" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.setreturn">
<refnamediv>
<refname>GearmanJob::setReturn</refname>
<refpurpose>Set a return value</refpurpose>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>gearman_return_t</parameter></term>
<listitem>
<para>
A valid Gearman return value.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>gearman_return_t</parameter></term>
<listitem>
<para>
A valid Gearman return value.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">

54
reference/gearman/gearmanjob/status.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.status" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.status">
<refnamediv>
<refname>GearmanJob::status</refname>
<refpurpose>Send status (deprecated)</refpurpose>
@@ -28,26 +27,24 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>numerator</parameter></term>
<listitem>
<para>
The numerator of the precentage completed expressed as a fraction.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>denominator</parameter></term>
<listitem>
<para>
The denominator of the precentage completed expressed as a fraction.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>numerator</parameter></term>
<listitem>
<para>
The numerator of the precentage completed expressed as a fraction.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>denominator</parameter></term>
<listitem>
<para>
The denominator of the precentage completed expressed as a fraction.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -59,17 +56,14 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::jobStatus</methodname></member>
<member><methodname>GearmanTask::taskDenominator</methodname></member>
<member><methodname>GearmanTask::taskNumerator</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::jobStatus</methodname></member>
<member><methodname>GearmanTask::taskDenominator</methodname></member>
<member><methodname>GearmanTask::taskNumerator</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/gearman/gearmanjob/unique.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.unique" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.unique">
<refnamediv>
<refname>GearmanJob::unique</refname>
<refpurpose>Get the unique identifier</refpurpose>
@@ -31,12 +31,10 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::do</methodname></member>
<member><methodname>GearmanTask::uuid</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::do</methodname></member>
<member><methodname>GearmanTask::uuid</methodname></member>
</simplelist>
</refsect1>
</refentry>

38
reference/gearman/gearmanjob/warning.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.warning" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.warning">
<refnamediv>
<refname>GearmanJob::warning</refname>
<refpurpose>Send a warning (deprecated)</refpurpose>
@@ -26,18 +25,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>warning</parameter></term>
<listitem>
<para>
A warning messages.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>warning</parameter></term>
<listitem>
<para>
A warning messages.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -49,17 +46,14 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanJob::sendComplete</methodname></member>
<member><methodname>GearmanJob::sendException</methodname></member>
<member><methodname>GearmanJob::sendFail</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanJob::sendComplete</methodname></member>
<member><methodname>GearmanJob::sendException</methodname></member>
<member><methodname>GearmanJob::sendFail</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/gearman/gearmanjob/workload.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.workload" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.workload">
<refnamediv>
<refname>GearmanJob::workload</refname>
<refpurpose>Get workload</refpurpose>
@@ -31,12 +31,10 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::do</methodname></member>
<member><methodname>GearmanJob::workloadSize</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::do</methodname></member>
<member><methodname>GearmanJob::workloadSize</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmanjob/workloadsize.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanjob.workloadsize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanjob.workloadsize">
<refnamediv>
<refname>GearmanJob::workloadSize</refname>
<refpurpose>Get size of work load</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanJob::workload</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanJob::workload</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmantask/data.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmantask.data" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmantask.data">
<refnamediv>
<refname>GearmanTask::data</refname>
<refpurpose>Get data returned for a task</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanTask::dataSize</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanTask::dataSize</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmantask/datasize.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmantask.datasize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmantask.datasize">
<refnamediv>
<refname>GearmanTask::dataSize</refname>
<refpurpose>Get the size of returned data</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanTask::data</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanTask::data</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmantask/jobhandle.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmantask.jobhandle" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmantask.jobhandle">
<refnamediv>
<refname>GearmanTask::jobHandle</refname>
<refname>gearman_job_handle</refname>
@@ -32,11 +32,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::doJobHandle</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::doJobHandle</methodname></member>
</simplelist>
</refsect1>
</refentry>

32
reference/gearman/gearmantask/recvdata.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmantask.recvdata" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmantask.recvdata">
<refnamediv>
<refname>GearmanTask::recvData</refname>
<refpurpose>Read work or result data into a buffer for a task</refpurpose>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data_len</parameter></term>
<listitem>
<para>
Length of data to be read.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>data_len</parameter></term>
<listitem>
<para>
Length of data to be read.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,11 +41,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanTask::sendData</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanTask::sendData</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmantask/returncode.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmantask.returncode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmantask.returncode">
<refnamediv>
<refname>GearmanTask::returnCode</refname>
<refpurpose>Get the last return code</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::returnCode</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::returnCode</methodname></member>
</simplelist>
</refsect1>
</refentry>

34
reference/gearman/gearmantask/senddata.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmantask.senddata" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmantask.senddata">
<refnamediv>
<refname>GearmanTask::sendData</refname>
<refpurpose>Send data for a task (deprecated)</refpurpose>
@@ -21,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Data to send to the worker.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Data to send to the worker.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -44,15 +41,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanTask::recvData</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanTask::recvData</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

32
reference/gearman/gearmantask/sendworkload.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmantask.sendworkload" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmantask.sendworkload">
<refnamediv>
<refname>GearmanTask::sendWorkload</refname>
<refpurpose>Send data for a task</refpurpose>
@@ -20,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Data to send to the worker.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Data to send to the worker.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,11 +41,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanTask::recvData</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanTask::recvData</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmantask/taskdenominator.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmantask.taskdenominator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmantask.taskdenominator">
<refnamediv>
<refname>GearmanTask::taskDenominator</refname>
<refpurpose>Get completion percentage denominator</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanTask::taskNumerator</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanTask::taskNumerator</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmantask/tasknumerator.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmantask.tasknumerator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmantask.tasknumerator">
<refnamediv>
<refname>GearmanTask::taskNumerator</refname>
<refpurpose>Get completion percentage numerator</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanTask::taskDenominator</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanTask::taskDenominator</methodname></member>
</simplelist>
</refsect1>
</refentry>

12
reference/gearman/gearmantask/unique.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmantask.unique" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmantask.unique">
<refnamediv>
<refname>GearmanTask::unique</refname>
<refpurpose>Get the unique identifier for a task</refpurpose>
@@ -32,12 +32,10 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::do</methodname></member>
<member><methodname>GearmanClient::addTask</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::do</methodname></member>
<member><methodname>GearmanClient::addTask</methodname></member>
</simplelist>
</refsect1>
</refentry>

16
reference/gearman/gearmantask/uuid.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmantask.uuid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmantask.uuid">
<refnamediv>
<refname>GearmanTask::uuid</refname>
<refpurpose>Get the unique identifier for a task (deprecated)</refpurpose>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>GearmanTask::uuid</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Returns the unique identifier for this task. This is assigned by the <classname>GearmanClient</classname>,
@@ -39,16 +38,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::do</methodname></member>
<member><methodname>GearmanClient::addTask</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::do</methodname></member>
<member><methodname>GearmanClient::addTask</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

120
reference/gearman/gearmanworker/addfunction.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.addfunction" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.addfunction">
<refnamediv>
<refname>GearmanWorker::addFunction</refname>
<refpurpose>Register and add callback function</refpurpose>
@@ -24,42 +24,40 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
The name of a function to register with the job server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
A callback that gets called when a job for the registered function name is submitted
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
A reference to arbitrary application context data that can be modified by the worker function
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
An interval of time in seconds
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
The name of a function to register with the job server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
A callback that gets called when a job for the registered function name is submitted
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
A reference to arbitrary application context data that can be modified by the worker function
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
An interval of time in seconds
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -71,21 +69,20 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Simple worker making use of extra application context data</title>
<programlisting role="php">
<example>
<title>Simple worker making use of extra application context data</title>
<programlisting role="php">
<![CDATA[
<?php
# get a gearman worker
$worker= new GearmanWorker();
$worker= new GearmanWorker();
# add the default server (localhost)
$worker->addServer();
$worker->addServer();
# define a variable to hold application data
$count= 0;
$count= 0;
# add the "reverse" function
$worker->addFunction("reverse", "reverse_cb", $count);
@@ -93,36 +90,33 @@ $worker->addFunction("reverse", "reverse_cb", $count);
# start the worker
while ($worker->work());
function reverse_cb($job, &$count)
{
$count++;
return "$count: " . strrev($job->workload());
}
function reverse_cb($job, &$count)
{
$count++;
return "$count: " . strrev($job->workload());
}
?>
]]>
</programlisting>
<para>
Running a client that submits two jobs for the reverse function would have
output similar to the following:
</para>
<screen>
</programlisting>
<para>
Running a client that submits two jobs for the reverse function would have
output similar to the following:
</para>
<screen>
<![CDATA[
1: olleh
2: dlrow
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::do</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::do</methodname></member>
</simplelist>
</refsect1>
</refentry>

36
reference/gearman/gearmanworker/addoptions.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.addoptions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.addoptions">
<refnamediv>
<refname>GearmanWorker::addOptions</refname>
<refpurpose>Add worker options</refpurpose>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The options to be added
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The options to be added
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -42,13 +40,11 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::options</methodname></member>
<member><methodname>GearmanClient::setOptions</methodname></member>
<member><methodname>GearmanClient::removeOptions</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::options</methodname></member>
<member><methodname>GearmanClient::setOptions</methodname></member>
<member><methodname>GearmanClient::removeOptions</methodname></member>
</simplelist>
</refsect1>
</refentry>

64
reference/gearman/gearmanworker/addserver.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.addserver" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.addserver">
<refnamediv>
<refname>GearmanWorker::addServer</refname>
<refpurpose>Add a job server</refpurpose>
@@ -22,26 +22,24 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem>
<para>
&gearman.parameter.host;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
<para>
&gearman.parameter.port;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem>
<para>
&gearman.parameter.host;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
<para>
&gearman.parameter.port;
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -53,29 +51,25 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Add alternate Gearman servers</title>
<programlisting role="php">
<example>
<title>Add alternate Gearman servers</title>
<programlisting role="php">
<![CDATA[
<?php
$worker= new GearmanWorker();
$worker->addServer("10.0.0.1");
$worker= new GearmanWorker();
$worker->addServer("10.0.0.1");
$worker->addServer("10.0.0.2", 7003);
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::addServers</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::addServers</methodname></member>
</simplelist>
</refsect1>
</refentry>

48
reference/gearman/gearmanworker/addservers.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.addservers" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.addservers">
<refnamediv>
<refname>GearmanWorker::addServers</refname>
<refpurpose>Add job servers</refpurpose>
@@ -21,19 +21,17 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>servers</parameter></term>
<listitem>
<para>
A comma separated list of job servers in the format host:port. If no port is
specified, it defaults to 4730.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>servers</parameter></term>
<listitem>
<para>
A comma separated list of job servers in the format host:port. If no port is
specified, it defaults to 4730.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -45,30 +43,26 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Add two job servers</title>
<programlisting role="php">
<example>
<title>Add two job servers</title>
<programlisting role="php">
<![CDATA[
<?php
$worker= new GearmanWorker();
$worker= new GearmanWorker();
$worker->addServers("10.0.0.1,10.0.0.2:7003");
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::addServer</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::addServer</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmanworker/construct.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.construct">
<refnamediv>
<refname>GearmanWorker::__construct</refname>
<refpurpose>Create a GearmanWorker instance</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::clone</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::clone</methodname></member>
</simplelist>
</refsect1>
</refentry>

34
reference/gearman/gearmanworker/echo.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.echo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.echo">
<refnamediv>
<refname>GearmanWorker::echo</refname>
<refpurpose>Test job server response</refpurpose>
@@ -21,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
Arbitrary serialized data
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>workload</parameter></term>
<listitem>
<para>
Arbitrary serialized data
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -44,15 +41,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanClient::echo</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanClient::echo</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/gearman/gearmanworker/error.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.error" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.error">
<refnamediv>
<refname>GearmanWorker::error</refname>
<refpurpose>Get the last error encountered</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::getErrno</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::getErrno</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmanworker/geterrno.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.geterrno" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.geterrno">
<refnamediv>
<refname>GearmanWorker::getErrno</refname>
<refpurpose>Get errno</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::error</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::error</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmanworker/options.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.options" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.options">
<refnamediv>
<refname>GearmanWorker::options</refname>
<refpurpose>Get worker options</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::setOptions</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::setOptions</methodname></member>
</simplelist>
</refsect1>
</refentry>

50
reference/gearman/gearmanworker/register.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.register" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.register">
<refnamediv>
<refname>GearmanWorker::register</refname>
<refpurpose>Register a function with the job server</refpurpose>
@@ -22,26 +22,24 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
The name of a function to register with the job server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
An interval of time in seconds
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
The name of a function to register with the job server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
An interval of time in seconds
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -53,12 +51,10 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::unregister</methodname></member>
<member><methodname>GearmanWorker::unregisterAll</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::unregister</methodname></member>
<member><methodname>GearmanWorker::unregisterAll</methodname></member>
</simplelist>
</refsect1>
</refentry>

36
reference/gearman/gearmanworker/removeoptions.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.removeoptions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.removeoptions">
<refnamediv>
<refname>GearmanWorker::removeOptions</refname>
<refpurpose>Remove worker options</refpurpose>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The options to be removed (unset)
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The options to be removed (unset)
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -42,13 +40,11 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::options</methodname></member>
<member><methodname>GearmanWorker::setOptions</methodname></member>
<member><methodname>GearmanWorker::addOptions</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::options</methodname></member>
<member><methodname>GearmanWorker::setOptions</methodname></member>
<member><methodname>GearmanWorker::addOptions</methodname></member>
</simplelist>
</refsect1>
</refentry>

12
reference/gearman/gearmanworker/returncode.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.returncode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.returncode">
<refnamediv>
<refname>GearmanWorker::returnCode</refname>
<refpurpose>Get last Gearman return code</refpurpose>
@@ -31,12 +31,10 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::error</methodname></member>
<member><methodname>GearmanWorker::getErrno</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::error</methodname></member>
<member><methodname>GearmanWorker::getErrno</methodname></member>
</simplelist>
</refsect1>
</refentry>

38
reference/gearman/gearmanworker/setoptions.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.setoptions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.setoptions">
<refnamediv>
<refname>GearmanWorker::setOptions</refname>
<refpurpose>Set worker options</refpurpose>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The options to be set
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The options to be set
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -42,14 +40,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::options</methodname></member>
<member><methodname>GearmanWorker::addOptions</methodname></member>
<member><methodname>GearmanWorker::removeOptions</methodname></member>
<member><methodname>GearmanClient::setOptions</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::options</methodname></member>
<member><methodname>GearmanWorker::addOptions</methodname></member>
<member><methodname>GearmanWorker::removeOptions</methodname></member>
<member><methodname>GearmanClient::setOptions</methodname></member>
</simplelist>
</refsect1>
</refentry>

54
reference/gearman/gearmanworker/settimeout.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.settimeout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.settimeout">
<refnamediv>
<refname>GearmanWorker::setTimeout</refname>
<refpurpose>Set socket I/O activity timeout</refpurpose>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
An interval of time in milliseconds. A negative value indicates an infinite timeout.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
An interval of time in milliseconds. A negative value indicates an infinite timeout.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -42,10 +40,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A simple worker with a 5 second timeout</title>
<programlisting role="php">
<example>
<title>A simple worker with a 5 second timeout</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -89,11 +86,11 @@ function reverse_fn($job)
?>
]]>
</programlisting>
<para>
Running the worker with no submitted jobs will generate output that looks like the following:
</para>
<screen>
</programlisting>
<para>
Running the worker with no submitted jobs will generate output that looks like the following:
</para>
<screen>
<![CDATA[
Starting
Waiting for job...
@@ -101,18 +98,15 @@ Timeout. Waiting for next job...
Timeout. Waiting for next job...
Timeout. Waiting for next job...
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::timeout</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::timeout</methodname></member>
</simplelist>
</refsect1>
</refentry>

10
reference/gearman/gearmanworker/timeout.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.timeout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.timeout">
<refnamediv>
<refname>GearmanWorker::timeout</refname>
<refpurpose>Get socket I/O activity timeout</refpurpose>
@@ -31,11 +31,9 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::setTimeout</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::setTimeout</methodname></member>
</simplelist>
</refsect1>
</refentry>

34
reference/gearman/gearmanworker/unregister.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.unregister" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.unregister">
<refnamediv>
<refname>GearmanWorker::unregister</refname>
<refpurpose>Unregister a function name with the job servers</refpurpose>
@@ -20,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
The name of a function to register with the job server
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
The name of a function to register with the job server
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,12 +41,10 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::register</methodname></member>
<member><methodname>GearmanWorker::unregisterAll</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::register</methodname></member>
<member><methodname>GearmanWorker::unregisterAll</methodname></member>
</simplelist>
</refsect1>
</refentry>

12
reference/gearman/gearmanworker/unregisterall.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.unregisterall" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.unregisterall">
<refnamediv>
<refname>GearmanWorker::unregisterAll</refname>
<refpurpose>Unregister all function names with the job servers</refpurpose>
@@ -32,12 +32,10 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::register</methodname></member>
<member><methodname>GearmanWorker::unregister</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::register</methodname></member>
<member><methodname>GearmanWorker::unregister</methodname></member>
</simplelist>
</refsect1>
</refentry>

50
reference/gearman/gearmanworker/wait.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.wait" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.wait">
<refnamediv>
<refname>GearmanWorker::wait</refname>
<refpurpose>Wait for activity from one of the job servers</refpurpose>
@@ -33,10 +33,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Running worker in non-blocking mode</title>
<programlisting role="php">
<example>
<title>Running worker in non-blocking mode</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -46,10 +45,10 @@ echo "Starting\n";
$worker= new GearmanWorker();
# Make the worker non-blocking
$worker->addOptions(GEARMAN_WORKER_NON_BLOCKING);
$worker->addOptions(GEARMAN_WORKER_NON_BLOCKING);
# Add the default server (localhost, port 4730)
$worker->addServer();
$worker->addServer();
# Add our reverse function
$worker->addFunction('reverse', 'reverse_fn');
@@ -63,18 +62,18 @@ while (@$worker->work() ||
continue;
echo "Waiting for next job...\n";
if (!@$worker->wait())
{
if ($worker->returnCode() == GEARMAN_NO_ACTIVE_FDS)
{
# We are not connected to any servers, so wait a bit before
# trying to reconnect.
sleep(5);
continue;
}
break;
}
}
if (!@$worker->wait())
{
if ($worker->returnCode() == GEARMAN_NO_ACTIVE_FDS)
{
# We are not connected to any servers, so wait a bit before
# trying to reconnect.
sleep(5);
continue;
}
break;
}
}
echo "Worker Error: " . $worker->error() . "\n";
@@ -86,18 +85,15 @@ function reverse_fn($job)
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::work</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::work</methodname></member>
</simplelist>
</refsect1>
</refentry>

38
reference/gearman/gearmanworker/work.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gearmanworker.work" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gearmanworker.work">
<refnamediv>
<refname>GearmanWorker::work</refname>
<refpurpose>Wait for and perform jobs</refpurpose>
@@ -34,44 +34,40 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><methodname>GearmanWorker::work</methodname> example</title>
<programlisting role="php">
<example>
<title><methodname>GearmanWorker::work</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
# create the worker
$worker = new GearmanWorker();
$worker = new GearmanWorker();
# add the default job server (localhost)
$worker->addServer();
$worker->addServer();
# add the reverse function
$worker->addFunction("reverse", "my_reverse_function");
$worker->addFunction("reverse", "my_reverse_function");
# start te worker listening for job submissions
while ($worker->work());
function my_reverse_function($job)
{
return strrev($job->workload());
while ($worker->work());
function my_reverse_function($job)
{
return strrev($job->workload());
}
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>GearmanWorker::addFunction</methodname></member>
</simplelist>
</para>
<simplelist>
<member><methodname>GearmanWorker::addFunction</methodname></member>
</simplelist>
</refsect1>
</refentry>