pcntl_sigprocmask

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

pcntl_sigprocmask — Sets and retrieves blocked signals

Description

pcntl_sigprocmask(int $mode, array $signals, array &$old_signals = null): bool

The pcntl_sigprocmask() function adds, removes or sets blocked signals, depending on the mode parameter.

Parameters

mode

Sets the behavior of pcntl_sigprocmask(). Possible values:

  • SIG_BLOCK: Add the signals to the currently blocked signals.
  • SIG_UNBLOCK: Remove the signals from the currently blocked signals.
  • SIG_SETMASK: Replace the currently blocked signals by the given list of signals.

signals

List of signals.

old_signals

The old_signals parameter is set to an array containing the list of the previously blocked signals.

Return Values

Returns true on success or false on failure.

Changelog

VersionDescription
8.4.0A ValueError is thrown if signal is empty.
8.4.0A TypeError is thrown if signal value is not an int.
8.4.0A ValueError is thrown if signal value is invalid.
8.4.0A ValueError is thrown if mode value is not SIG_BLOCK, SIG_UNBLOCK or SIG_SETMASK.

Examples

Example #1 pcntl_sigprocmask() example

<?php
pcntl_sigprocmask(SIG_BLOCK, array(SIGHUP));
$oldset = array();
pcntl_sigprocmask(SIG_UNBLOCK, array(SIGHUP), $oldset);
?>

See Also