aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 80ab12173c6760520eae1ad718a4e2f7b315f3dc (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
# php-jobd-client

This is a simple PHP client for [jobd](https://github.com/gch1p/jobd). It can send
requests and read responses to/from *jobd* and *jobd-master* instances.

## Installation

```
composer require ch1p/jobd-client
```

## Usage

The API is compact and simple, just read the code of `Client.php`.

Here's a small example.

```php
try {
    $jobd = new jobd\Client(jobd\Client::MASTER_PORT, '127.0.0.1');
} catch (Exception $e) {
    die('Failed to connect.');
}

// poke master to send poll requests to workers
$response = $jobd->poke(['target_name', 'another_name']);

// get status from master
$response = $status = $jobd->status();

$jobd->close();
```

## License

BSD-2c