Pool::collect

Collect references to completed tasks

&reftitle.description; public `int` `Pool::collect` `Callable` `collector`

Allows the pool to collect references determined to be garbage by the optionally given collector.

&reftitle.parameters;

`collector`

- A Callable collector that returns a boolean on whether the task can be collected or not. Only in rare cases should a custom collector need to be used.

&reftitle.returnvalues;

The number of remaining tasks in the pool to be collected.

&reftitle.changelog;

&Version; | &Description;
v3 | An integer is now returned, and the `collector` parameter is now optional.

&reftitle.examples;

### A basic example of `Pool::collect`

    <?php
    $pool = new Pool(4);

    for ($i = 0; $i < 15; ++$i) {
        $pool->submit(new class extends Threaded {});
    }

    while ($pool->collect()); // blocks until all tasks have finished executing

    $pool->shutdown();