<!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>The Thread class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="threaded.wait.html">Threaded::wait</a></div>
<div class="next" style="text-align: right; float: right;"><a href="thread.detach.html">Thread::detach</a></div>
<div class="up"><a href="book.pthreads.html">pthreads</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.thread" class="reference">
<h1 class="title">The Thread class</h1>
<div class="partintro"><p class="verinfo">(PECL pthreads >= 2.0.0)</p>
<div class="section" id="thread.intro">
<h2 class="title">Introduction</h2>
<p class="para">
When the start method of a Thread is invoked, the run method code will be executed in separate Thread, in parallel.
</p>
<p class="para">
After the run method is executed the Thread will exit immediately, it will be joined with the creating Thread at the appropriate time.
</p>
<div class="warning"><strong class="warning">Warning</strong>
<p class="para">
Relying on the engine to determine when a Thread should join may cause undesirable behaviour; the programmer should be explicit, where possible.
</p>
</div>
</div>
<div class="section" id="thread.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">Thread</strong>
</span>
<span class="ooclass">
<span class="modifier">extends</span>
<a href="class.threaded.html" class="classname">Threaded</a>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.countable.html" class="interfacename">Countable</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.traversable.html" class="interfacename">Traversable</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.arrayaccess.html" class="interfacename">ArrayAccess</a></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="thread.detach.html" class="methodname">detach</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="thread.getcreatorid.html" class="methodname">getCreatorId</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">Thread</span> <span class="methodname"><a href="thread.getcurrentthread.html" class="methodname">getCurrentThread</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">int</span> <span class="methodname"><a href="thread.getcurrentthreadid.html" class="methodname">getCurrentThreadId</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="thread.getthreadid.html" class="methodname">getThreadId</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">mixed</span> <span class="methodname"><a href="thread.globally.html" class="methodname">globally</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="thread.isjoined.html" class="methodname">isJoined</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="thread.isstarted.html" class="methodname">isStarted</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="thread.join.html" class="methodname">join</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="thread.kill.html" class="methodname">kill</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="thread.start.html" class="methodname">start</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span>
] )</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="threaded.chunk.html" class="methodname">Threaded::chunk</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$size</code></span>
, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$preserve</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="threaded.count.html" class="methodname">Threaded::count</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="threaded.extend.html" class="methodname">Threaded::extend</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$class</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">Threaded</span> <span class="methodname"><a href="threaded.from.html" class="methodname">Threaded::from</a></span>
( <span class="methodparam"><span class="type"><a href="class.closure.html" class="type Closure">Closure</a></span> <code class="parameter">$run</code></span>
[, <span class="methodparam"><span class="type"><a href="class.closure.html" class="type Closure">Closure</a></span> <code class="parameter">$construct</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$args</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="threaded.getterminationinfo.html" class="methodname">Threaded::getTerminationInfo</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="thread.isrunning.html" class="methodname">Threaded::isRunning</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="threaded.isterminated.html" class="methodname">Threaded::isTerminated</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="threaded.iswaiting.html" class="methodname">Threaded::isWaiting</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="threaded.lock.html" class="methodname">Threaded::lock</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="threaded.merge.html" class="methodname">Threaded::merge</a></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">$from</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$overwrite</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="threaded.notify.html" class="methodname">Threaded::notify</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="threaded.notifyone.html" class="methodname">Threaded::notifyOne</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="threaded.pop.html" class="methodname">Threaded::pop</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="threaded.run.html" class="methodname">Threaded::run</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="threaded.shift.html" class="methodname">Threaded::shift</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="threaded.synchronized.html" class="methodname">Threaded::synchronized</a></span>
( <span class="methodparam"><span class="type"><a href="class.closure.html" class="type Closure">Closure</a></span> <code class="parameter">$block</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">$...</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="threaded.unlock.html" class="methodname">Threaded::unlock</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="threaded.wait.html" class="methodname">Threaded::wait</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeout</code></span>
] )</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="thread.detach.html">Thread::detach</a> — Execution</li><li><a href="thread.getcreatorid.html">Thread::getCreatorId</a> — Identification</li><li><a href="thread.getcurrentthread.html">Thread::getCurrentThread</a> — Identification</li><li><a href="thread.getcurrentthreadid.html">Thread::getCurrentThreadId</a> — Identification</li><li><a href="thread.getthreadid.html">Thread::getThreadId</a> — Identification</li><li><a href="thread.globally.html">Thread::globally</a> — Execution</li><li><a href="thread.isjoined.html">Thread::isJoined</a> — State Detection</li><li><a href="thread.isstarted.html">Thread::isStarted</a> — State Detection</li><li><a href="thread.join.html">Thread::join</a> — Synchronization</li><li><a href="thread.kill.html">Thread::kill</a> — Execution</li><li><a href="thread.start.html">Thread::start</a> — Execution</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="threaded.wait.html">Threaded::wait</a></div>
<div class="next" style="text-align: right; float: right;"><a href="thread.detach.html">Thread::detach</a></div>
<div class="up"><a href="book.pthreads.html">pthreads</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
