wyrihaximus/parallel-runtime

🎁 ext-parallel runtime wrapping adding error, signal, and exception handling

1.0.0 2020-12-05 23:09 UTC

README

ext-parallel runtime wrapping adding error, signal, and exception handling.

Continuous Integration Latest Stable Version Total Downloads Code Coverage Type Coverage License

Installation

To install via Composer, use the command below, it will automatically detect the latest version and bind it with ^.

composer require wyrihaximus/parallel-runtime

Usage

The Runtime class transparently wraps ext-parallel's runtime class. But instead of what you return from your closure it will return an Outcome object. The Outcome object containers the results of your closure, but also any reported errors. Consider the following example:

<?php

declare(strict_types=1);

use WyriHaximus\Parallel\Runtime;

use function trigger_error;

use const WyriHaximus\Constants\ComposerAutoloader\LOCATION;

$runtime = new Runtime(LOCATION);
$future  = $runtime->run(static function (): string {
    trigger_error('Error! Error! Error!');

    return 'yay';
});
posix_kill(posix_getpid(), SIGUSR1);
$outcome = $future->value();
echo get_class($outcome), PHP_EOL; // WyriHaximus\Parallel\Outcome
echo $outcome->result(), PHP_EOL; // yay
foreach ($outcome->errors() as $error) {
    echo $error->message(), PHP_EOL; // Error! Error! Error!
}
foreach ($outcome->signals() as $signal) {
    echo $signal->signal(), PHP_EOL; // SIGUSR1
}

License

The MIT License (MIT)

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 in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.