1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.volatile" role="class" 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>
</reference>
<!-- 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
-->
|
