<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Function threading</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pht-thread.addFileTask.html">pht\Thread::addFileTask</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pht-thread.join.html">pht\Thread::join</a></div>
<div class="up"><a href="class.pht-thread.html">pht\Thread</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="pht-thread.addFunctionTask" class="refentry">
<div class="refnamediv">
<h1 class="refname">pht\Thread::addFunctionTask</h1>
<p class="verinfo">(PECL pht >= 0.0.1)</p><p class="refpurpose"><span class="refname">pht\Thread::addFunctionTask</span> — <span class="dc-title">Function threading</span></p>
</div>
<div class="refsect1 description" id="refsect1-pht-thread.addFunctionTask-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>pht\Thread::addFunctionTask</strong></span>
( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$func</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$...funcArgs</code></span>
] )</div>
<p class="para rdfs-comment">
Adds a new function task to a <a href="class.pht-thread.html" class="classname">pht\Thread</a>s internal task queue.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-pht-thread.addFunctionTask-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">func</code></dt>
<dd>
<p class="para">
The function to be threaded. If it is bound to an instance, then
<em>$this</em> will become <strong><code>NULL</code></strong>.
</p>
</dd>
<dt>
<code class="parameter">...funcArgs</code></dt>
<dd>
<p class="para">
An optional list of arguments for the function. These arguments will be
serialised (since they are being passed to another thread).
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-pht-thread.addFunctionTask-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No return value.
</p>
</div>
<div class="refsect1 examples" id="refsect1-pht-thread.addFunctionTask-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4548">
<p><strong>Example #1 Adding a new function task to a thread</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">use </span><span style="color: #0000BB">pht</span><span style="color: #007700">\</span><span style="color: #0000BB">Thread</span><span style="color: #007700">;<br /><br />class </span><span style="color: #0000BB">Test<br /></span><span style="color: #007700">{<br /> public static function </span><span style="color: #0000BB">run</span><span style="color: #007700">(){</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">5</span><span style="color: #007700">);}<br /> public static function </span><span style="color: #0000BB">run2</span><span style="color: #007700">(){</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">6</span><span style="color: #007700">);}<br />}<br /><br />function </span><span style="color: #0000BB">aFunc</span><span style="color: #007700">(){</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">3</span><span style="color: #007700">);}<br /><br /></span><span style="color: #0000BB">$thread </span><span style="color: #007700">= new </span><span style="color: #0000BB">Thread</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$thread</span><span style="color: #007700">-></span><span style="color: #0000BB">addFunctionTask</span><span style="color: #007700">(static function(</span><span style="color: #0000BB">$one</span><span style="color: #007700">) {</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$one</span><span style="color: #007700">);}, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$thread</span><span style="color: #007700">-></span><span style="color: #0000BB">addFunctionTask</span><span style="color: #007700">(function() {</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">2</span><span style="color: #007700">);});<br /></span><span style="color: #0000BB">$thread</span><span style="color: #007700">-></span><span style="color: #0000BB">addFunctionTask</span><span style="color: #007700">(</span><span style="color: #DD0000">'aFunc'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$thread</span><span style="color: #007700">-></span><span style="color: #0000BB">addFunctionTask</span><span style="color: #007700">(</span><span style="color: #DD0000">'array_map'</span><span style="color: #007700">, function (</span><span style="color: #0000BB">$n</span><span style="color: #007700">) {</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$n</span><span style="color: #007700">);}, [</span><span style="color: #0000BB">4</span><span style="color: #007700">]);<br /></span><span style="color: #0000BB">$thread</span><span style="color: #007700">-></span><span style="color: #0000BB">addFunctionTask</span><span style="color: #007700">([</span><span style="color: #DD0000">'Test'</span><span style="color: #007700">, </span><span style="color: #DD0000">'run'</span><span style="color: #007700">]);<br /></span><span style="color: #0000BB">$thread</span><span style="color: #007700">-></span><span style="color: #0000BB">addFunctionTask</span><span style="color: #007700">([new </span><span style="color: #0000BB">Test</span><span style="color: #007700">, </span><span style="color: #DD0000">'run2'</span><span style="color: #007700">]);<br /><br /></span><span style="color: #0000BB">$thread</span><span style="color: #007700">-></span><span style="color: #0000BB">start</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$thread</span><span style="color: #007700">-></span><span style="color: #0000BB">join</span><span style="color: #007700">();</span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
int(1)
int(2)
int(3)
int(4)
int(5)
int(6)
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pht-thread.addFileTask.html">pht\Thread::addFileTask</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pht-thread.join.html">pht\Thread::join</a></div>
<div class="up"><a href="class.pht-thread.html">pht\Thread</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
