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

SyncEvent::reset

PHP function Edit on GitHub ✎

(PECL sync >= 1.0.0)

Resets a manual event

Description

SyncEvent::reset(): bool

Resets a SyncEvent object that has been fired/set. Only valid for manual event objects.

Parameters Parameters

Return Values

Success

Examples

SyncEvent::reset() example

php
<?php
// In a web application:
$event = new SyncEvent("DemoApplication", true);
$event->wait();

// In a cron job:
$event = new SyncEvent("DemoApplication", true);
$event->reset();
/* ... Do some maintenance task(s) ... */
$event->fire();
?>

See Also

  • SyncEvent::fire
  • SyncEvent::reset
  • SyncEvent::wait

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