SyncEvent (class)

The SyncEvent class

Introduction

(PECL sync >= 1.0.0)

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

public __construct ([ string $name [, bool $manual = false [, bool $prefire = false ]]] )

public bool fire ( void )

public bool reset ( void )

public bool wait ([ integer $wait = -1 ] )

Table of Contents

• 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