pcntl_sigtimedwait

Function • Params and return types changed in PHP 8.0

Waits for signals, with a timeout.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

pcntl_sigtimedwait Function synopsis

pcntl_sigtimedwait(
    array $signals,
    &$info = [],
    int $seconds = 0,
    int $nanoseconds = 0
  ): int|false

Parameters

$signals

Typearray

Array of signals to wait for.

$info

Passed by reference, OptionalDefault value[]

The $info is set to an array containing information about the signal. See pcntl_sigwaitinfo.

$seconds

OptionalTypeintDefault value0

Timeout in seconds.

$nanoseconds

OptionalTypeintDefault value0

Timeout in nanoseconds.

Note that the parameter $info is passed by reference, and contains additional/updated context data that may be useful.

Return value

Typeint|false

pcntl_sigtimedwait returns a signal number on success, or false on failure.

Changes to the pcntl_sigtimedwait Function

PHP 8.0

  • Return type added: int|false
  • Parameter name of parameter #1 changed: $set to $signals
  • Parameter type added for parameter #1 ($signals): array
  • Parameter default value added for position #2 ($info): []
  • Parameter type added for parameter #3 ($seconds): int
  • Parameter default value added for position #3 ($seconds): 0
  • Parameter type added for parameter #4 ($nanoseconds): int
  • Parameter default value added for position #4 ($nanoseconds): 0
  pcntl_sigtimedwait(
-     $set,
+     array $signals,
-     &$info,
+     &$info = [],
-     $seconds,
+     int $seconds = 0,
-     $nanoseconds
+     int $nanoseconds = 0
-   )
+   ): int|false

pcntl_sigtimedwait Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes