Home > PHP > Function > PCNTL > pcntl_alarm()

pcntl_alarm()

pcntl_alarm - Set an alarm clock for delivery of a signal

Syntax

int pcntl_alarm (int $seconds)

Arguments

  • seconds - The number of seconds to wait. If seconds is zero, no new alarm is created.

Description

Creates a timer that will send a SIGALRM signal to the process after the given number of seconds. Any call to pcntl_alarm() will cancel any previously set alarm.

Version

PHP 4.3.0, 5

Return value

Returns the time in seconds that any previously scheduled alarm had remaining before it was to be delivered, or 0if there was no previously scheduled alarm.