interfaces/WorkerManagerInterface.php at master · arikaim/interfaces · GitHub

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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<?php
/**
 * Arikaim
 *
 * @link        http://www.arikaim.com
 * @copyright   Copyright (c)  Konstantin Atanasov <info@arikaim.com>
 * @license     http://www.arikaim.com/license
 *
*/
namespace Arikaim\Core\Interfaces;

/**
 * Queue worker manager interface
 */
interface WorkerManagerInterface
{
    /**
     * Run worker
     *
     * @return boolean
     */
    public function run(): bool;

    /**
     * Return true if worker is running
     *
     * @return boolean
     */
    public function isRunning(): bool;

    /**
     * Stop worker
     *
     * @return boolean
     */
    public function stop(): bool;

    /**
     * Get title
     *
     * @return string
     */
    public function getTitle(): string;

    /**
     * Get description
     *
     * @return string|null
     */
    public function getDescription(): ?string;

    /**
     * Get worker service details
     *
     * @return array
     */
    public function getDetails(): array;

    /**
     * Get host
     *
     * @return string
     */
    public function getHost(): string;

    /**
     * Get port
     *
     * @return string
     */
    public function getPort(): string;
}