mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-22 03:48:55 +00:00
41445b3d77
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351076 c90b9560-bf6c-de11-be94-00142212c4b1
77 lines
3.1 KiB
XML
77 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="parallel.run" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<refnamediv>
|
|
<refname>parallel\run</refname>
|
|
<refpurpose>Execution</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>Future</type><type>null</type></type><methodname>parallel\run</methodname>
|
|
<methodparam><type>Closure</type><parameter>task</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Shall schedule <parameter>task</parameter> for execution in parallel.
|
|
</para>
|
|
<methodsynopsis>
|
|
<type class="union"><type>Future</type><type>null</type></type><methodname>parallel\run</methodname>
|
|
<methodparam><type>Closure</type><parameter>task</parameter></methodparam>
|
|
<methodparam><type>array</type><parameter>argv</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Shall schedule <parameter>task</parameter> for execution in parallel, passing <parameter>argv</parameter> at execution time.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="scheduling-characteristics">
|
|
<title>Automatic Scheduling</title>
|
|
<para>
|
|
If a <classname>\parallel\Runtime</classname> internally created and cached by a previous call to <function>parallel\run</function> is idle,
|
|
it will be used to execute the task. If no <classname>\parallel\Runtime</classname> is idle parallel will create and cache a
|
|
<classname>\parallel\Runtime</classname>.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
<classname>\parallel\Runtime</classname> objects created by the programmer are not used for automatic scheduling.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='parameters'])" />
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='closure-characteristics'])" />
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='argv-characteristics'])" />
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='object-characteristics'])" />
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='returnvalues'])" />
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='exceptions'])" />
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><xref linkend="parallel-runtime.run" /></member>
|
|
</simplelist>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
<!-- 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
|
|
-->
|