mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 08:28:54 +00:00
a31156c3d8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347391 c90b9560-bf6c-de11-be94-00142212c4b1
131 lines
3.6 KiB
XML
131 lines
3.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<phpdoc:classref xml:id="class.parallel-future" 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\Future class</title>
|
|
<titleabbrev>parallel\Future</titleabbrev>
|
|
|
|
<partintro>
|
|
|
|
<section>
|
|
<title>Futures</title>
|
|
<para>
|
|
A Future represents the return value or uncaught exception from a task, and exposes an API for cancellation.
|
|
</para>
|
|
<example>
|
|
<title>Example showing Future as return value</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$runtime = new \parallel\Runtime;
|
|
$future = $runtime->run(function(){
|
|
return "World";
|
|
});
|
|
printf("Hello %s\n", $future->value());
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Hello World
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
<para>
|
|
The behaviour of a future also allows it to be used as a simple synchronization point even where the task does not return a value explicitly.
|
|
</para>
|
|
<example>
|
|
<title>Example showing Future as synchronization point</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$runtime = new \parallel\Runtime;
|
|
$future = $runtime->run(function(){
|
|
echo "in child ";
|
|
for ($i = 0; $i < 500; $i++) {
|
|
if ($i % 10 == 0) {
|
|
echo ".";
|
|
}
|
|
}
|
|
echo " leaving child";
|
|
});
|
|
|
|
$future->value();
|
|
echo "\nparent continues\n";
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
in child .................................................. leaving child
|
|
parent continues
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</section>
|
|
|
|
<section xml:id="parallel-future.synopsis">
|
|
&reftitle.classsynopsis;
|
|
|
|
<!-- {{{ Synopsis -->
|
|
<classsynopsis>
|
|
<ooclass><classname>parallel\Future</classname></ooclass>
|
|
|
|
<!-- {{{ Class synopsis -->
|
|
<classsynopsisinfo>
|
|
<ooclass>
|
|
<modifier>final</modifier>
|
|
<classname>parallel\Future</classname>
|
|
</ooclass>
|
|
</classsynopsisinfo>
|
|
<!-- }}} -->
|
|
|
|
<classsynopsisinfo role="comment">Resolution</classsynopsisinfo>
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-future')/db:refentry/db:refsect1[@audience='resolution']/descendant::db:methodsynopsis[not(@role='procedural')])">
|
|
<xi:fallback />
|
|
</xi:include>
|
|
|
|
<classsynopsisinfo role="comment">State</classsynopsisinfo>
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-future')/db:refentry/db:refsect1[@audience='state']/descendant::db:methodsynopsis[not(@role='procedural')])">
|
|
<xi:fallback />
|
|
</xi:include>
|
|
|
|
<classsynopsisinfo role="comment">Cancellation</classsynopsisinfo>
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-future')/db:refentry/db:refsect1[@audience='cancellation']/descendant::db:methodsynopsis[not(@role='procedural')])">
|
|
<xi:fallback />
|
|
</xi:include>
|
|
|
|
</classsynopsis>
|
|
<!-- }}} -->
|
|
|
|
</section>
|
|
|
|
</partintro>
|
|
|
|
&reference.parallel.parallel.entities.future;
|
|
|
|
</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
|
|
-->
|