innmind/signals

Manage multiple callbacks per signal

3.1.0 2023-09-23 12:21 UTC

Requires

• php: ~8.2
• innmind/immutable: ~4.0|~5.0

Requires (Dev)

• innmind/black-box: ~5.5
• innmind/coding-standard: ~2.0
• nikic/php-parser: ^4.13.2
• phpunit/phpunit: ~10.2
• vimeo/psalm: ~5.12

MIT

• Baptiste Langlade

• cli
• signal
• handler

README

Small abstraction on top of pcntl_signal to allow to register multiple callables for a single signal.

Installation

composer require innmind/signals

Usage

use Innmind\Signals\{
    Handler,
    Signal,
    Info,
};

$handler = new Handler; // automatically enable async signal at instanciation

$handler->listen(Signal::interrupt, function(Signal $signal, Info $info): void {
    echo 'foo';
});
$handler->listen(Signal::interrupt, function(Signal $signal, Info $info): void {
    echo 'bar';
});

// do some logic here

When above script is executed in a terminal and you do a ctrl + c to stop the process it will print foobar instead of stopping the script.

Important: when using handlers in a program that use pcntl_fork, remember to reset the handler via $handler->reset() in the child process to avoid both processes to call the listeners. Once resetted a handler can no longer be used, you need to build a new instance of it.

If for some reason you need to remove a handler (for example when a child process ended) you can call $handler->remove($listener) (remove the listener for all signals).