svn: /phpdoc/en/trunk/reference/pthreads/ pool/submit.xml pool/submitTo.xml versions.xml

From: Date: Fri, 07 Mar 2014 16:05:08 +0000
Subject: svn: /phpdoc/en/trunk/reference/pthreads/ pool/submit.xml pool/submitTo.xml versions.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-12184@lists.php.net to get a copy of this message
krakjoe Fri, 07 Mar 2014 16:05:08 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=332934 Log: send Changed paths: U phpdoc/en/trunk/reference/pthreads/pool/submit.xml A phpdoc/en/trunk/reference/pthreads/pool/submitTo.xml U phpdoc/en/trunk/reference/pthreads/versions.xml Modified: phpdoc/en/trunk/reference/pthreads/pool/submit.xml =================================================================== --- phpdoc/en/trunk/reference/pthreads/pool/submit.xml 2014-03-07 14:57:25 UTC (rev 332933) +++ phpdoc/en/trunk/reference/pthreads/pool/submit.xml 2014-03-07 16:05:08 UTC (rev 332934) @@ -35,7 +35,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - the length of the stack on the selected Worker + the identifier of the Worker executing the Stackable </para> </refsect1> Added: phpdoc/en/trunk/reference/pthreads/pool/submitTo.xml =================================================================== --- phpdoc/en/trunk/reference/pthreads/pool/submitTo.xml (rev 0) +++ phpdoc/en/trunk/reference/pthreads/pool/submitTo.xml 2014-03-07 16:05:08 UTC (rev 332934) @@ -0,0 +1,148 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 329926 $ --> + +<refentry xml:id="pool.submitTo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>Pool::submitTo</refname> + <refpurpose>Submits a Stackable for execution</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>int</type><methodname>Pool::submitTo</methodname> + <methodparam><type>int</type><parameter>worker</parameter></methodparam> + <methodparam><type>Stackable</type><parameter>task</parameter></methodparam> + </methodsynopsis> + <para> + Submit the task to the specified Worker in the Pool + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <variablelist> + <varlistentry> + <term><parameter>worker</parameter></term> + <listitem> + <para> + The worker for execution + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>size</parameter></term> + <listitem> + <para> + The task for execution + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + the identifier of the Worker executing the Stackable + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Submitting Tasks</title> + <programlisting role="php"> +<![CDATA[ +<?php +class MyWork extends Stackable { + + public function run() { + /* ... */ + } +} + +class MyWorker extends Worker { + + public function __construct(Something $something) { + $this->something = $something; + } + + public function run() { + /** ... **/ + } +} + +$pool = new Pool(8, \MyWorker::class, [new Something()]); +$pool->submit(new MyWork()); +var_dump($pool); +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +object(Pool)#1 (6) { + ["size":protected]=> + int(8) + ["class":protected]=> + string(8) "MyWorker" + ["workers":protected]=> + array(1) { + [0]=> + object(MyWorker)#4 (1) { + ["something"]=> + object(Something)#5 (0) { + } + } + } + ["work":protected]=> + array(1) { + [0]=> + object(MyWork)#3 (1) { + ["worker"]=> + object(MyWorker)#5 (1) { + ["something"]=> + object(Something)#6 (0) { + } + } + } + } + ["ctor":protected]=> + array(1) { + [0]=> + object(Something)#2 (0) { + } + } + ["last":protected]=> + int(1) +} +]]> + </screen> + </example> + </para> + </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 +--> Modified: phpdoc/en/trunk/reference/pthreads/versions.xml =================================================================== --- phpdoc/en/trunk/reference/pthreads/versions.xml 2014-03-07 14:57:25 UTC (rev 332933) +++ phpdoc/en/trunk/reference/pthreads/versions.xml 2014-03-07 16:05:08 UTC (rev 332934) @@ -64,6 +64,7 @@ <function name='pool::__construct' from='PECL pthreads &gt;= 1.0.0'/> <function name='pool::resize' from='PECL pthreads &gt;= 1.0.0'/> <function name='pool::submit' from='PECL pthreads &gt;= 1.0.0'/> + <function name='pool::submitTo' from='PECL pthreads &gt;= 1.0.0'/> <function name='pool::collect' from='PECL pthreads &gt;= 1.0.0'/> <function name='pool::shutdown' from='PECL pthreads &gt;= 1.0.0'/> <function name='pool::__destruct' from='PECL pthreads &gt;= 1.0.0'/>

« previous php.doc.cvs (#12184) next »