php-doc-en/reference/pht/pht.threaded.xml
2018-02-24 11:12:03 +00:00

75 lines
2.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.pht-threaded" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The Threaded interface</title>
<titleabbrev>pht\Threaded</titleabbrev>
<partintro>
<!-- {{{ pht\Threaded intro -->
<section xml:id="pht-threaded.intro">
&reftitle.intro;
<para>
The <interfacename>pht\Threaded</interfacename> interface is an internal interface used
by the Inter-Thread Communication (ITC) data structures
(<classname>pht\HashTable</classname>, <classname>pht\Queue</classname>, and
<classname>pht\Vector</classname>). It allows those data structures to be
threaded and ensures that the mutex locking API
(<methodname>pht\Threaded::lock</methodname> and
<methodname>pht\Threaded::unlock</methodname>) is implemented by each of the
ITC data structures. It is not implementable by userland classes (since
standalone mutex locks are not exposed).
</para>
</section>
<!-- }}} -->
<section xml:id="pht-threaded.synopsis">
&reftitle.interfacesynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>pht\Threaded</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>pht\Threaded</classname>
</ooclass>
</classsynopsisinfo>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.pht-threaded')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.pht.entities.threaded;
</phpdoc:classref>
<!-- 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
-->