php8.5
Home/ Manual/ sync / syncevent/ SyncEvent::wait

SyncEvent::wait

PHP function Edit on GitHub ✎

(PECL sync >= 1.0.0)

Waits for the event to be fired/set

Description

SyncEvent::wait(int $wait = -1): bool

Waits for the SyncEvent object to be fired.

Parameters

wait

The number of milliseconds to wait for the event to be fired. A value of -1 is infinite.

Return Values

Success

Examples

SyncEvent::wait() example

php
<?php
// In a web application:
$event = new SyncEvent("GetAppReport");
$event->fire();

// In a cron job:
$event = new SyncEvent("GetAppReport");
$event->wait();
?>

See Also

  • SyncEvent::fire

Source: reference/sync/syncevent/wait.xml · from the official PHP manual (php/doc-en)