-
Notifications
You must be signed in to change notification settings - Fork 70
/
stream-set-option.xml
173 lines (166 loc) · 5.44 KB
/
stream-set-option.xml
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: de8e36659fb2b22c9b60ffa0380d9bea945b2819 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="streamwrapper.stream-set-option" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>streamWrapper::stream_set_option</refname>
<refpurpose>Изменение настроек потока</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>streamWrapper::stream_set_option</methodname>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>int</type><parameter>arg1</parameter></methodparam>
<methodparam><type>int</type><parameter>arg2</parameter></methodparam>
</methodsynopsis>
<para>
Этот метод вызывается при установке настроек потока.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
Одно из значений:
<simplelist>
<member>
<constant>STREAM_OPTION_BLOCKING</constant>
(Метод вызван в результате вызова функции
<function>stream_set_blocking</function>)
</member>
<member>
<constant>STREAM_OPTION_READ_TIMEOUT</constant>
(Метод вызван в результате вызова функции
<function>stream_set_timeout</function>)
</member>
<member>
<constant>STREAM_OPTION_READ_BUFFER</constant>
(Метод вызван в результате вызова функции
<function>stream_set_read_buffer</function>)
</member>
<member>
<constant>STREAM_OPTION_WRITE_BUFFER</constant>
(Метод вызван в результате вызова функции
<function>stream_set_write_buffer</function>)
</member>
</simplelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>arg1</parameter></term>
<listitem>
<para>
Если <parameter>option</parameter> принимает значение:
<simplelist>
<member>
<constant>STREAM_OPTION_BLOCKING</constant>:
запрошен режим блокировки (1 — блокировать, 0 — не блокировать).
</member>
<member>
<constant>STREAM_OPTION_READ_TIMEOUT</constant>: время ожидания в секундах.
</member>
<member>
<constant>STREAM_OPTION_READ_BUFFER</constant>: режим буфера
(опции <constant>STREAM_BUFFER_NONE</constant> или <constant>STREAM_BUFFER_FULL</constant>).
</member>
<member>
<constant>STREAM_OPTION_WRITE_BUFFER</constant>:
режим буферизации (<constant>STREAM_BUFFER_NONE</constant> или
<constant>STREAM_BUFFER_FULL</constant>).
</member>
</simplelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>arg2</parameter></term>
<listitem>
<para>
Если <parameter>option</parameter> принимает значение:
<simplelist>
<member>
<constant>STREAM_OPTION_BLOCKING</constant>: это значение ни на что не влияет.
</member>
<member>
<constant>STREAM_OPTION_READ_TIMEOUT</constant>: время ожидания в микросекундах.
</member>
<member>
<constant>STREAM_OPTION_READ_BUFFER</constant>: требуемый размер буфера.
</member>
<member>
<constant>STREAM_OPTION_WRITE_BUFFER</constant>: требуемый размер буфера.
</member>
</simplelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
Если <parameter>option</parameter> не реализован, метод должен возвращать &false;.
</para>
</refsect1>
<!--
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>streamWrapper::stream_set_option</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
]]>
</screen>
</example>
</para>
</refsect1>
-->
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>stream_set_blocking</function></member>
<member><function>stream_set_timeout</function></member>
<member><function>stream_set_write_buffer</function></member>
</simplelist>
</para>
</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
-->