-
Notifications
You must be signed in to change notification settings - Fork 81
Expand file tree
/
Copy pathconstruct.xml
More file actions
122 lines (114 loc) · 4.12 KB
/
construct.xml
File metadata and controls
122 lines (114 loc) · 4.12 KB
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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncsharedmemory.construct">
<refnamediv>
<refname>SyncSharedMemory::__construct</refname>
<refpurpose>Создаёт новый объект SyncSharedMemory</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>SyncSharedMemory::__construct</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
</methodsynopsis>
<simpara>
Создаёт именованный объект разделяемой памяти.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<simpara>
Имя объекта разделяемой памяти.
</simpara>
<note>
<simpara>
Если имя уже существует, оно должно быть доступно для открытия текущим пользователем,
от имени которого запущен процесс, иначе будет выброшено исключение
с бессмысленным сообщением об ошибке.
</simpara>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<simpara>
Размер в байтах разделяемой памяти, которую необходимо зарезервировать.
</simpara>
<note>
<simpara>
Объем памяти не может быть изменён позже. Запросите заранее достаточно места для хранения.
</simpara>
</note>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Новый объект <classname>SyncSharedMemory</classname>.
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simpara>
Выбрасывается исключение, если объект разделяемой памяти не может быть создан или открыт.
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Пример использования <function>SyncSharedMemory::__construct</function></title>
<programlisting role="php">
<![CDATA[
<?php
// Возможно, вам потребуется защитить разделяемую память с другими объектами синхронизации.
// Разделяемая память исчезает, когда исчезает последняя ссылка на неё.
$mem = new SyncSharedMemory("AppReportName", 1024);
if ($mem->first())
{
// Выполните здесь первоначальную инициализацию.
}
$result = $mem->write(json_encode(array("name" => "my_report.txt")));
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>SyncSharedMemory::first</methodname></member>
<member><methodname>SyncSharedMemory::size</methodname></member>
<member><methodname>SyncSharedMemory::write</methodname></member>
<member><methodname>SyncSharedMemory::read</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- 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
-->