SyncEvent::__construct
(PECL sync >= 1.0.0)
SyncEvent::__construct — Constructs a new SyncEvent object
Description
$name
[, bool $manual = FALSE
[, bool $prefire = FALSE
]]] )Constructs a named or unnamed event object.
Parameters
-
name -
The name of the event if this is a named event object.
Note:
If the name already exists, it must be able to be opened by the current user that the process is running as or an exception will be thrown with a meaningless error message.
-
manual -
Specifies whether or not the event object must be reset manually.
Note:
Manual reset event objects allow all waiting processes through until the object is reset.
-
prefire -
Specifies whether or not to prefire (signal) the event object.
Note:
Only has impact if the calling process/thread is the first to create the object.
Return Values
The new SyncEvent object. An exception is thrown if the event object cannot be created or opened.
Examples
Example #1 SyncEvent::__construct() example
<?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() - Fires/sets the event
- SyncEvent::reset() - Resets a manual event
- SyncEvent::wait() - Waits for the event to be fired/set
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-syncevent.construct.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
