blob: bf0b6e069d1d9db04769e4337d4c11d229f9eac9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
<?php
/**
* High-performance PHP process supervisor and load balancer written in Go.
*
* @author Wolfy-J
*/
declare(strict_types=1);
namespace Spiral\RoadRunner;
use Spiral\Goridge\Exception\GoridgeException;
use Spiral\RoadRunner\Exception\RoadRunnerException;
interface WorkerInterface
{
/**
* Wait for incoming payload from the server. Must return null when worker stopped.
*
* @return Payload|null
* @throws GoridgeException
* @throws RoadRunnerException
*/
public function waitPayload(): ?Payload;
/**
* Respond to the server with the processing result.
*
* @param Payload $payload
* @throws GoridgeException
*/
public function respond(Payload $payload): void;
/**
* Respond to the server with an error. Error must be treated as TaskError and might not cause
* worker destruction.
*
* Example:
*
* $worker->error("invalid payload");
*
* @param string $error
* @throws GoridgeException
*/
public function error(string $error): void;
/**
* Terminate the process. Server must automatically pass task to the next available process.
* Worker will receive stop command after calling this method.
*
* Attention, you MUST use continue; after invoking this method to let rr to properly stop worker.
*/
public function stop(): void;
}
|