PHP Conference Japan 2024

GearmanClient::do

(PECL gearman >= 0.5.0)

GearmanClient::do執行單一任務並返回結果 [已棄用]

說明

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

自 pecl/gearman 1.0.0 起,GearmanClient::do() 方法已被棄用。請使用 GearmanClient::doNormal()

參數

function_name

Worker 將執行的已註冊函式

workload

要處理的序列化資料

unique

用於識別特定任務的唯一 ID

回傳值

表示任務執行結果的字串。

範例

範例 #1 簡單的工作提交並立即返回

<?php

// Client 端程式碼

echo "開始\n";

// 建立 Client 物件。
$gmclient= new GearmanClient();

// 新增預設伺服器 (localhost)。
$gmclient->addServer();

echo
"正在送出工作\n";

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

echo
"成功: $result\n";

?>
<?php

echo "開始\n";

// 建立 Worker 物件。
$gmworker= new GearmanWorker();

// 新增預設伺服器 (localhost)。
$gmworker->addServer();

// 向伺服器註冊函式 "reverse"。 將 worker 函式更改為
// "reverse_fn_fast" 可獲得更快速且無輸出的 worker。
$gmworker->addFunction("reverse", "reverse_fn");

print
"正在等待工作...\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 提交工作並擷取增量狀態

提交一個作業後,腳本會循環擷取狀態資訊。Worker 端會刻意加入延遲,導致作業長時間執行,並在處理過程中傳送狀態和資料。每次後續呼叫 GearmanClient::do() 都會產生正在執行作業的狀態資訊。

<?php

// Client 端程式碼

// 建立 Client 物件。
$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

# Worker code

echo "Starting\n";

# Create our worker object.
$gmworker= new GearmanWorker();

# Add default server (localhost).
$gmworker->addServer();

# Register function "reverse" with the server.
$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)
{
echo
"Received job: " . $job->handle() . "\n";

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

echo
"Workload: $workload ($workload_size)\n";

# This status loop is not needed, just showing how it works
for ($x= 0; $x < $workload_size; $x++)
{
echo
"Sending status: " + $x + 1 . "/$workload_size complete\n";
$job->sendStatus($x+1, $workload_size);
$job->sendData(substr($workload, $x, 1));
sleep(1);
}

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

# Return what we want to send back to the client.
return $result;
}

?>

上述範例將輸出類似以下的內容

Worker 端輸出

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

Client 端輸出

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