<!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 Queue class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pht-vector.updateAt.html">pht\Vector::updateAt</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pht-queue.front.html">pht\Queue::front</a></div>
<div class="up"><a href="book.pht.html">pht</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.pht-queue" class="reference">
<h1 class="title">The Queue class</h1>
<div class="partintro"><p class="verinfo">(PECL pht >= 0.0.1)</p>
<div class="section" id="pht-queue.intro">
<h2 class="title">Introduction</h2>
<p class="para">
The <strong class="classname">pht\Queue</strong> class is one of the Inter-Thread
Communication (ITC) data structures exposed by pht. It can be safely passed
around between threads, and manipulated by multiple threads using the mutex
locks that have been packed in with the data structure. It is
reference-counted across threads, and so it does not need to be explicitly
destroyed.
</p>
</div>
<div class="section" id="pht-queue.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">pht\Queue</strong>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.pht-threaded.html" class="interfacename">pht\Threaded</a></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="pht-queue.front.html" class="methodname">front</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="pht-queue.lock.html" class="methodname">lock</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="pht-queue.pop.html" class="methodname">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="pht-queue.push.html" class="methodname">push</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">$value</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="pht-queue.size.html" class="methodname">size</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="pht-queue.unlock.html" class="methodname">unlock</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="pht-queue.front.html">pht\Queue::front</a> — Returns the first value from a queue</li><li><a href="pht-queue.lock.html">pht\Queue::lock</a> — Acquires the queue's mutex lock</li><li><a href="pht-queue.pop.html">pht\Queue::pop</a> — Pops a value off of the front of a queue</li><li><a href="pht-queue.push.html">pht\Queue::push</a> — Pushes a value to the end of a queue</li><li><a href="pht-queue.size.html">pht\Queue::size</a> — Gets the size of the queue</li><li><a href="pht-queue.unlock.html">pht\Queue::unlock</a> — Releases the queue's mutex lock</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pht-vector.updateAt.html">pht\Vector::updateAt</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pht-queue.front.html">pht\Queue::front</a></div>
<div class="up"><a href="book.pht.html">pht</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
