Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/php-strict/cooperative-worker
Class for executing jobs from one list in several processes
https://github.com/php-strict/cooperative-worker
cooperative php php-library php7
Last synced: 6 days ago
JSON representation
Class for executing jobs from one list in several processes
- Host: GitHub
- URL: https://github.com/php-strict/cooperative-worker
- Owner: php-strict
- License: gpl-3.0
- Created: 2020-04-23T07:51:08.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-03T12:42:41.000Z (7 months ago)
- Last Synced: 2024-07-05T17:56:24.711Z (6 months ago)
- Topics: cooperative, php, php-library, php7
- Language: PHP
- Size: 47.9 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Cooperative worker
[![Software License][ico-license]](LICENSE.txt)
[![Build Status][ico-travis]][link-travis]
[![codecov][ico-codecov]][link-codecov]
[![Codacy Badge][ico-codacy]][link-codacy]
Class for executing jobs from one list in several processes.
Class not have mechanism to create processes, consumer must create it by self.
Each separate process can create instance of class wich will work with shared storage without collisions.
Temporary storage of jobs (queue) will be created in first instance of class and it be use all of instances.
## Requirements
* PHP >= 7.1
## Install
Use class as standalone:
```php
require 'CooperativeWorker.php';
use PhpStrict\CooperativeWorker\CooperativeWorker;
```
Install with [Composer](http://getcomposer.org):
```bash
composer require php-strict/cooperative-worker
```
## Usage
Before (all jobs running through one process):
```php
//$jobs - list of commands, files to processing, ...
$jobs = ['job 1', 'job 2', 'job 3', 'job 4', 'job 5'];
foreach ($jobs as $job) {
echo 'Start job: ' . $job . PHP_EOL;
//do some job
}
```
With cooperative worker:
cw.php
```php
use PhpStrict\CooperativeWorker\CooperativeWorker;
$cw = new CooperativeWorker(
function() {
return ['job 1', 'job 2', 'job 3', 'job 4', 'job 5'];
},
function(string $job) {
echo 'Start job: ' . $job . PHP_EOL;
//do some job
}
);
$cw->run();
```
cw.bat (on Windows using `start` command to create a two separate processes)
```bat
start php -f cw.php
start php -f cw.php
```
cw.sh (on Linux using `&` at the end of command to create a two separate processes)
```sh
php -f cw.php &
php -f cw.php &
```
using [ScriptRunner](https://github.com/php-strict/script-runner)
```php
use PhpStrict\ScriptRunner\ScriptRunner;
//path_to_script, processes count (if omitted then system CPU cores count will be used)
$sr = new ScriptRunner('cw.php', 4);
$sr->run();
```
Processing images (log files, data files, etc.)
cw.php
```php
use PhpStrict\CooperativeWorker\CooperativeWorker;
$cw = new CooperativeWorker(
//returns array of images (with path to it) from dir
function() {
$images = glob('/path_to_images/*.jpg');
array_walk(
$images,
function(&$val, $key, $path) {
$val = $path . '/' . $val;
},
'/path_to_images'
);
return $images;
},
function(string $image) {
echo 'Processing image: ' . $image . PHP_EOL;
//do some image operation (resizing, cropping, etc.)
}
);
$cw->run();
```
## Tests
To execute the test suite, you'll need [Codeception](https://codeception.com/).
```bash
vendor/bin/codecept run
```
[ico-license]: https://img.shields.io/badge/license-GPL-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/php-strict/cooperative-worker/master.svg?style=flat-square
[link-travis]: https://travis-ci.org/php-strict/cooperative-worker
[ico-codecov]: https://codecov.io/gh/php-strict/cooperative-worker/branch/master/graph/badge.svg
[link-codecov]: https://codecov.io/gh/php-strict/cooperative-worker
[ico-codacy]: https://app.codacy.com/project/badge/Grade/af51d7f320384404a0dfefb2511cbf42
[link-codacy]: https://www.codacy.com/gh/php-strict/cooperative-worker?utm_source=github.com&utm_medium=referral&utm_content=php-strict/cooperative-worker&utm_campaign=Badge_Grade