php-doc-en/reference/pthreads/volatile.xml
2017-08-17 12:59:05 +00:00

143 lines
3.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.volatile" 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 Volatile class</title>
<titleabbrev>Volatile</titleabbrev>
<partintro>
<!-- {{{ Volatile intro -->
<section xml:id="volatile.intro">
&reftitle.intro;
<para>
The <classname>Volatile</classname> class is new to pthreads v3. Its
introduction is a consequence of the new immutability semantics of
<classname>Threaded</classname> members of <classname>Threaded</classname>
classes. The <classname>Volatile</classname> class enables for mutability
of its <classname>Threaded</classname> members, and is also used to store
PHP arrays in <classname>Threaded</classname> contexts.
</para>
</section>
<!-- }}} -->
<section xml:id="volatile.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>Volatile</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>Volatile</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>Threaded</classname>
</ooclass>
<oointerface>
<interfacename>Collectable</interfacename>
</oointerface>
<oointerface>
<interfacename>Traversable</interfacename>
</oointerface>
</classsynopsisinfo>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.threaded')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback />
</xi:include>
</classsynopsis>
<!-- }}} -->
</section>
<section xml:id="volatile.examples">
&reftitle.examples;
<example xml:id="volatile.example.immutable"><!-- {{{ -->
<title>New immutability semantics of Threaded</title>
<programlisting role="php">
<![CDATA[
<?php
class Task extends Threaded
{
public function __construct()
{
$this->data = new Threaded();
// attempt to overwrite a Threaded property of a Threaded class (invalid)
$this->data = new StdClass();
}
}
var_dump((new Task())->data);
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
RuntimeException: Threaded members previously set to Threaded objects are immutable, cannot overwrite data in %s:%d
]]>
</screen>
</example><!-- }}} -->
<example xml:id="volatile.example.basic"><!-- {{{ -->
<title>Volatile use-case</title>
<programlisting role="php">
<![CDATA[
<?php
class Task extends Volatile
{
public function __construct()
{
$this->data = new Threaded();
// attempt to overwrite a Threaded property of a Volatile class (valid)
$this->data = new StdClass();
}
}
var_dump((new Task())->data);
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
object(stdClass)#3 (0) {
}
]]>
</screen>
</example><!-- }}} -->
</section>
</partintro>
</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
-->