2024年PHP日本会议

GearmanClient::do

(PECL gearman >= 0.5.0)

GearmanClient::do运行单个任务并返回结果 [已弃用]

描述

public GearmanClient::do(string $function_name, string $workload, string $unique = ?): string

自 pecl/gearman 1.0.0 起,GearmanClient::do() 方法已弃用。请使用 GearmanClient::doNormal()

参数

function_name

工作进程要执行的已注册函数

workload

要处理的序列化数据

unique

用于标识特定任务的唯一 ID

返回值

表示运行任务结果的字符串。

示例

示例 #1 简单的作业提交,立即返回

<?php

# 客户端代码

echo "Starting\n";

# 创建客户端对象。
$gmclient= new GearmanClient();

# 添加默认服务器 (localhost)。
$gmclient->addServer();

echo
"Sending job\n";

$result = $gmclient->doNormal("reverse", "Hello!");

echo
"Success: $result\n";

?>
<?php

echo "Starting\n";

# 创建工作进程对象。
$gmworker= new GearmanWorker();

# 添加默认服务器 (localhost)。
$gmworker->addServer();

# 向服务器注册函数 "reverse"。将工作进程函数更改为
# "reverse_fn_fast" 以获得速度更快的、无输出的工作进程。
$gmworker->addFunction("reverse", "reverse_fn");

print
"Waiting for job...\n";
while(
$gmworker->work())
{
if (
$gmworker->returnCode() != GEARMAN_SUCCESS)
{
echo
"return_code: " . $gmworker->returnCode() . "\n";
break;
}
}

function
reverse_fn($job)
{
return
strrev($job->workload());
}

?>

以上示例将输出类似以下内容

Starting
Sending job
Success: !olleH

示例 #2 提交作业并检索增量状态

提交作业,脚本循环检索状态信息。工作进程具有人为延迟,导致作业长时间运行,并在处理过程中发送状态和数据。每次后续调用 GearmanClient::do() 都会生成正在运行的作业的状态信息。

<?php

# 客户端代码

# 创建客户端对象。
$gmclient= new GearmanClient();

# 添加默认服务器 (localhost)。
$gmclient->addServer();

echo
"正在发送任务\n";

# 发送反转任务
do
{
$result = $gmclient->doNormal("reverse", "Hello!");
# 检查各种返回包和错误。

switch($gmclient->returnCode())
{
case
GEARMAN_WORK_DATA:
echo
"数据: $result\n";
break;
case
GEARMAN_WORK_STATUS:
list(
$numerator, $denominator)= $gmclient->doStatus();
echo
"状态: $numerator/$denominator 完成\n";
break;
case
GEARMAN_WORK_FAIL:
echo
"失败\n";
exit;
case
GEARMAN_SUCCESS:
break;
default:
echo
"返回码: " . $gmclient->returnCode() . "\n";
echo
"错误: " . $gmclient->error() . "\n";
echo
"错误号: " . $gmclient->getErrno() . "\n";
exit;
}
}
while(
$gmclient->returnCode() != GEARMAN_SUCCESS);

echo
"成功: $result\n";

?>
<?php

# 工作进程代码

echo "启动中\n";

# 创建工作进程对象。
$gmworker= new GearmanWorker();

# 添加默认服务器 (localhost)。
$gmworker->addServer();

# 向服务器注册函数 "reverse"。
$gmworker->addFunction("reverse", "reverse_fn");

print
"等待任务...\n";
while(
$gmworker->work())
{
if (
$gmworker->returnCode() != GEARMAN_SUCCESS)
{
echo
"返回码: " . $gmworker->returnCode() . "\n";
break;
}
}

function
reverse_fn($job)
{
echo
"收到任务: " . $job->handle() . "\n";

$workload = $job->workload();
$workload_size = $job->workloadSize();

echo
"工作负载: $workload ($workload_size)\n";

# 此状态循环并非必需,仅用于演示其工作原理
for ($x= 0; $x < $workload_size; $x++)
{
echo
"发送状态: " + $x + 1 . "/$workload_size 完成\n";
$job->sendStatus($x+1, $workload_size);
$job->sendData(substr($workload, $x, 1));
sleep(1);
}

$result= strrev($workload);
echo
"结果: $result\n";

# 返回要发送回客户端的内容。
return $result;
}

?>

以上示例将输出类似以下内容

工作进程输出

Starting
Waiting for job...
Received job: H:foo.local:106
Workload: Hello! (6)
1/6 complete
2/6 complete
3/6 complete
4/6 complete
5/6 complete
6/6 complete
Result: !olleH

客户端输出

Starting
Sending job
Status: 1/6 complete
Data: H
Status: 2/6 complete
Data: e
Status: 3/6 complete
Data: l
Status: 4/6 complete
Data: l
Status: 5/6 complete
Data: o
Status: 6/6 complete
Data: !
Success: !olleH

参见

添加注释

用户贡献的注释 1 条注释

Shane Harter
14 年前
请注意,这不是阻塞的——`do()` 方法会在任务被 Gearman 任务服务器接受后立即返回。

这允许您使用 `do..while` 循环,直到返回码为成功或失败,如示例所示。
To Top