Update

Author: wapmorgan

README.md

@@ -13,7 +13,6 @@ All you need to have installed:
 [![License](https://poser.pugx.org/wapmorgan/threadable/license)](https://packagist.org/packages/wapmorgan/threadable)
 
 1. Structure
-    - What is a `Threadable`?
     - What is a `Worker`?
         * How to create your Worker
     - What is a `WorkersPool`?
@@ -22,8 +21,8 @@ All you need to have installed:
     - One worker
     - Few workers with `WorkersPool`
 4. API
-    - `Worker` secrets and important methods
-    - `WorkersPool` features
+    - `Worker` API
+    - `WorkersPool` API
 5. Predefined workers
     - `DownloadWorker`
 6. Use cases
@@ -61,7 +60,7 @@ class SleepingWorker extends Worker
 It takes care of all maintenance, payload dispatching and life-cycle of workers. Allows you change the size of the pool dynamically and other useful stuff.
 
 # Simple usage
-For example, you want to background downloading work. Let's use `BackgroundWork` class to background it and show progress for user (or store in DB/...).
+For example, you want to just background downloading work. Let's use `wapmorgan\Threadable\BackgroundWork` class to background it and show progress for user (or store in DB/...).
 
 Everything you need to do:
 1. Prepare payloads for `DownloadWorker`
@@ -72,6 +71,10 @@ Everything you need to do:
 `DownloadWorker` needs an array with `source` and `target` elements. Prepare it:
 
 ```php
+use wapmorgan\Threadable\BackgroundWork;
+use wapmorgan\Threadable\DownloadWorker;
+use wapmorgan\Threadable\Worker;
+
 $file_sources = ['https://yandex.ru/images/today?size=1920x1080', 'http://hosting-obzo-ru.1gb.ru/hosting-obzor.ru.zip'];
 $files = [];
 foreach ($file_sources as $file_to_download) {
@@ -85,6 +88,7 @@ foreach ($file_sources as $file_to_download) {
 
 ## Stage 2. Launching in background
 
+### One-thread worker
 Run it in one thread with `doInBackground` function. Signature is following:
 
 `doInBackground(Worker $worker,
@@ -97,10 +101,10 @@ Run it in one thread with `doInBackground` function. Signature is following:
 - `$payloads` - an array of all payloads.
 - `$payloadHandlingCallback` - a callback that will be called every `$sleepMicrotime` microseconds with information about currently running payload.
     Signature for callback: `(Worker $worker, int $payloadI, $payloadData)`
--  `$onPayloadFinishCallback` - a callback that will be called when worker ends with one payload.
+- `$onPayloadFinishCallback` - a callback that will be called when worker ends with one payload.
     Signature for callback: `(Worker $worker, int $payloadI, $payloadData, $payloadResult)`
 
-So, collect all information run it:
+So, collect all information to run it:
 
 ```php
 $result = BackgroundWork::doInBackground(new DownloadWorker(), $files,
@@ -119,7 +123,9 @@ if ($result)
 
 Example is in `bin/example_file_downloading_easy` file.
 
-To run in in few threads use `doInBackgroundParallel` function with signature:
+### Few-threads worker
+
+To run it in few threads use `doInBackgroundParallel`. It has almost the same signature as one-thread function:
 
 `doInBackgroundParallel(Worker $worker,
     array $payloads,
@@ -128,6 +134,8 @@ To run in in few threads use `doInBackgroundParallel` function with signature:
     $sleepMicroTime = 1000,
     $poolSize = self::BY_CPU_NUMBER)`
 
+By adjusting `$poolSize` you can select number of workers that should be used.
+
 Example is in `bin/example_file_downloading_pool_easy` file.
 
 # How it works

bin/example_file_downloading_easy

@@ -7,7 +7,7 @@ use wapmorgan\Threadable\Worker;
 
 require_once __DIR__.'/../vendor/autoload.php';
 
-$file_sources = ['https://yandex.ru/images/today?size=1920x1080', 'http://hosting-obzo-ru.1gb.ru/hosting-obzor.ru.zip'];
+$file_sources = ['https://yandex.ru/images/today?size=1920x1080', 'http://hosting-obzo-ru.1gb.ru/hosting-obzor.ru.zip', 'http://soft.eurodir.ru/test-speed-100Mb.bin'];
 $files = [];
 foreach ($file_sources as $file_to_download) {
     $files[] = [
@@ -17,15 +17,16 @@ foreach ($file_sources as $file_to_download) {
     ];
 }
 
-BackgroundWork::doInBackground(new DownloadWorker(), $files, function (Worker $worker, $payloadI, $payloadData) {
+$result = BackgroundWork::doInBackground(new DownloadWorker(), $files, function (Worker $worker, $payloadI, $payloadData) {
     clearstatcache(true, $payloadData['target']);
     echo "\r" . '#' . ($payloadI + 1) . '. ' . basename($payloadData['source']) . ' downloading ' . round(filesize($payloadData['target']) * 100 / $payloadData['size'], 2) . '%';
 }, function (Worker $worker, $payloadI, $payloadData, $payloadResult) {
-    echo "\r" . '#' . ($payloadI + 1) . '. ' . basename($payloadData['source']) . ' successfully downloaded' . PHP_EOL;
+    echo "\r" . '#' . ($payloadI + 1) . '. ' . basename($payloadData['source']) . ' successfully downloaded (size '.filesize($payloadData['target']).')' . PHP_EOL;
     return true;
 });
 
-foreach ($files as $file)
-    unlink($file['target']);
-
+if ($result)
+    echo 'All files downloaded successfully'.PHP_EOL;
 
+foreach ($files as $file)
+    if (file_exists($file['target'])) unlink($file['target']);

bin/example_file_downloading_pool_easy

@@ -7,7 +7,7 @@ use wapmorgan\Threadable\Worker;
 use wapmorgan\Threadable\WorkersPool;
 require_once __DIR__.'/../vendor/autoload.php';
 
-$file_sources = [/*'https://yandex.ru/images/today?size=1920x1080', */'http://hosting-obzo-ru.1gb.ru/hosting-obzor.ru.zip', 'http://soft.eurodir.ru/test-speed-100Mb.bin'];
+$file_sources = ['https://yandex.ru/images/today?size=1920x1080', 'http://hosting-obzo-ru.1gb.ru/hosting-obzor.ru.zip', 'http://soft.eurodir.ru/test-speed-100Mb.bin'];
 $files = [];
 foreach ($file_sources as $file_to_download) {
     $file_size = DownloadWorker::getRemoteFileSize($file_to_download);
@@ -19,10 +19,16 @@ foreach ($file_sources as $file_to_download) {
     ];
 }
 
-BackgroundWork::doInBackgroundParallel(new DownloadWorker(), $files, function (Worker $worker, $payloadI, $payloadData) {
+$result = BackgroundWork::doInBackgroundParallel(new DownloadWorker(), $files, function (Worker $worker, $payloadI, $payloadData) {
     clearstatcache(true, $payloadData['target']);
     echo "\r" . '#' . ($payloadI + 1) . '. ' . basename($payloadData['source']) . ' downloading ' . round(filesize($payloadData['target']) * 100 / $payloadData['size'], 2) . '%';
 }, function (Worker $worker, $payloadI, $payloadData, $payloadResult) {
-    echo "\r" . '#' . ($payloadI + 1) . '. ' . basename($payloadData['source']) . ' successfully downloaded' . PHP_EOL;
+    echo "\r" . '#' . ($payloadI + 1) . '. ' . basename($payloadData['source']) . ' successfully downloaded (size '.filesize($payloadData['target']).')' . PHP_EOL;
     return true;
 });
+
+if ($result)
+    echo 'All files downloaded successfully'.PHP_EOL;
+
+foreach ($files as $file)
+    if (file_exists($file['target'])) unlink($file['target']);

composer.json

@@ -12,7 +12,8 @@
     ],
     "require": {
         "ext-posix": "*",
-        "ext-pcntl": "*"
+        "ext-pcntl": "*",
+        "ext-sockets": "*"
     },
     "require-dev": {
         "phpunit/phpunit": "~4.8"