php-doc-en/reference/parallel/parallel.events.event.xml
Christoph Michael Becker d9ecfba6ad Set svn:keywords
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347824 c90b9560-bf6c-de11-be94-00142212c4b1
2019-08-04 18:09:38 +00:00

89 lines
2.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.parallel-events-event" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The parallel\Events\Event class</title>
<titleabbrev>parallel\Events\Event</titleabbrev>
<partintro>
<section>
<title>Event Objects</title>
<para>
When an Event is returned, <varname>Event::$object</varname> shall be removed from the loop that returned it, should the event be a write event
the <classname>Input</classname> for <varname>Event::$source</varname> shall also be removed.
</para>
</section>
<section xml:id="parallel-events-event.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>parallel\Events\Event</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<modifier>final</modifier>
<classname>parallel\Events\Event</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Shall be one of <classname>Event\Type</classname> constants</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<type>int</type>
<varname>type</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">Shall be the source of the event (target name)</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname>source</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">Shall be either Future or Channel</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<type>object</type>
<varname>object</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">Shall be set for Read/Error events</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<varname>value</varname>
</fieldsynopsis>
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->