The SyncEvent class

(PECL sync >= 1.0.0)

Introduction

A cross-platform, native implementation of named and unnamed event objects. Both automatic and manual event objects are supported.

An event object waits, without polling, for the object to be fired/set. One instance waits on the event object while another instance fires/sets the event. Event objects are useful wherever a long-running process would otherwise poll a resource (e.g. checking to see if uploaded data needs to be processed).

Class synopsis

class SyncEvent {

/* Methods */

public function __construct(string $name = ?, bool $manual = false, bool $prefire = false)

public function fire(): bool

public function reset(): bool

public function wait(int $wait = -1): bool

}

SyncEvent::__construct — Constructs a new SyncEvent object
SyncEvent::fire — Fires/sets the event
SyncEvent::reset — Resets a manual event
SyncEvent::wait — Waits for the event to be fired/set

The SyncEvent class

Introduction

Class synopsis

Table of Contents