Merge pull request #5 from reactphp-parallel/add-documentation

Add Documentation

Author: WyriHaximus

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Cees-Jan Kiewiet
+Copyright (c) 2020 Cees-Jan Kiewiet
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -17,9 +17,29 @@ To install via [Composer](http://getcomposer.org/), use the command below, it wi
 composer require react-parallel/limited-pool 
 ```
 
+## Usage
+
+Just like any other `react-parallel` the limited pool will run any closure you send to it. With the exception that this 
+pool have a fixed number of threads running.
+
+```php
+$loop = Factory::create();
+
+$finite = new Limited(
+    new Infinite($loop, new EventLoopBridge($loop), 1), // Another pool, preferably an inifinite pool
+    100 // The amount of threads to start and keep running
+);
+$time = time();
+$finite->run(function (int $time): int {
+    return $time;
+}, [$time])->then(function (int $time): void {
+    echo 'Unix timestamp: ', $time, PHP_EOL;
+})->done();
+```
+
 ## License ##
 
-Copyright 2019 [Cees-Jan Kiewiet](http://wyrihaximus.net/)
+Copyright 2020 [Cees-Jan Kiewiet](http://wyrihaximus.net/)
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

examples/sleep.php

@@ -3,6 +3,7 @@
 
 use React\EventLoop\Factory;
 use ReactParallel\EventLoop\EventLoopBridge;
+use ReactParallel\Pool\Infinite\Infinite;
 use ReactParallel\Pool\Limited\Limited;
 use WyriHaximus\React\Parallel\Finite;
 use function React\Promise\all;
@@ -12,7 +13,7 @@
 
 $loop = Factory::create();
 
-$finite = Limited::create($loop, new EventLoopBridge($loop), 100);
+$finite = new Limited(new Infinite($loop, new EventLoopBridge($loop), 1), 100);
 
 $timer = $loop->addPeriodicTimer(1, function () use ($finite) {
     var_export(iteratorOrArrayToArray($finite->info()));

examples/versions.php

@@ -4,6 +4,7 @@
 use PackageVersions\Versions;
 use React\EventLoop\Factory;
 use ReactParallel\EventLoop\EventLoopBridge;
+use ReactParallel\Pool\Infinite\Infinite;
 use ReactParallel\Pool\Limited\Limited;
 use WyriHaximus\React\Parallel\Finite;
 use function WyriHaximus\iteratorOrArrayToArray;
@@ -12,7 +13,7 @@
 
 $loop = Factory::create();
 
-$finite = Limited::create($loop, new EventLoopBridge($loop), 2);
+$finite = new Limited(new Infinite($loop, new EventLoopBridge($loop), 1), 2);
 
 $timer = $loop->addPeriodicTimer(1, function () use ($finite) {
     var_export(iteratorOrArrayToArray($finite->info()));

src/Limited.php

@@ -5,15 +5,12 @@
 namespace ReactParallel\Pool\Limited;
 
 use Closure;
-use React\EventLoop\LoopInterface;
 use React\Promise\Promise;
 use React\Promise\PromiseInterface;
 use ReactParallel\Contracts\ClosedException;
 use ReactParallel\Contracts\GroupInterface;
 use ReactParallel\Contracts\LowLevelPoolInterface;
 use ReactParallel\Contracts\PoolInterface;
-use ReactParallel\EventLoop\EventLoopBridge;
-use ReactParallel\Pool\Infinite\Infinite;
 use SplQueue;
 use WyriHaximus\PoolInfo\Info;
 
@@ -35,17 +32,7 @@ final class Limited implements PoolInterface
 
     private bool $closed = false;
 
-    public static function create(LoopInterface $loop, EventLoopBridge $eventLoopBridge, int $threadCount): self
-    {
-        return new self(new Infinite($loop, $eventLoopBridge, 1), $threadCount);
-    }
-
-    public static function createWithPool(PoolInterface $pool, int $threadCount): self
-    {
-        return new self($pool, $threadCount);
-    }
-
-    private function __construct(PoolInterface $pool, int $threadCount)
+    public function __construct(PoolInterface $pool, int $threadCount)
     {
         $this->pool         = $pool;
         $this->threadCount  = $threadCount;

tests/LimitedTest.php

@@ -6,6 +6,7 @@
 use React\EventLoop\LoopInterface;
 use ReactParallel\Contracts\PoolInterface;
 use ReactParallel\EventLoop\EventLoopBridge;
+use ReactParallel\Pool\Infinite\Infinite;
 use ReactParallel\Pool\Limited\Limited;
 use ReactParallel\Tests\AbstractPoolTest;
 use WyriHaximus\PoolInfo\PoolInfoInterface;
@@ -21,11 +22,11 @@ final class LimitedTest extends AbstractPoolTest
     private function poolFactory(): PoolInfoInterface
     {
         $loop = Factory::create();
-        return Limited::create($loop, new EventLoopBridge($loop), 5);
+        return new Limited(new Infinite($loop, new EventLoopBridge($loop), 1), 5);
     }
 
     protected function createPool(LoopInterface $loop): PoolInterface
     {
-        return Limited::create($loop, new EventLoopBridge($loop), 5);
+        return new Limited(new Infinite($loop, new EventLoopBridge($loop), 1), 5);
     }
 }

tests/LimitedWithPoolTest.php

@@ -22,11 +22,11 @@ final class LimitedWithPoolTest extends AbstractPoolTest
     private function poolFactory(): PoolInfoInterface
     {
         $loop = Factory::create();
-        return Limited::createWithPool(new Infinite($loop, new EventLoopBridge($loop), 0.2), 5);
+        return new Limited(new Infinite($loop, new EventLoopBridge($loop), 1), 5);
     }
 
     protected function createPool(LoopInterface $loop): PoolInterface
     {
-        return Limited::createWithPool(new Infinite($loop, new EventLoopBridge($loop), 0.2), 5);
+        return new Limited(new Infinite($loop, new EventLoopBridge($loop), 1), 5);
     }
 }