-
Notifications
You must be signed in to change notification settings - Fork 73
/
eventbuffer.xml
227 lines (223 loc) · 8.84 KB
/
eventbuffer.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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f80105b4fc1196bd8d5fecb98d686b580b1ff65d Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<reference xml:id="class.eventbuffer" 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>Класс EventBuffer</title>
<titleabbrev>EventBuffer</titleabbrev>
<partintro>
<!-- {{{ EventBuffer intro -->
<section xml:id="eventbuffer.intro">
&reftitle.intro;
<para>
Класс <classname>EventBuffer</classname> представляет «событийный» буфер
модуля Libevent — служебная функция для буферизированного ввода-вывода.
</para>
<para>
Буферы событий обычно полезны для организации «буферной» части
буферизированного сетевого ввода-вывода.
</para>
</section>
<!-- }}} -->
<section xml:id="eventbuffer.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass>
<classname>EventBuffer</classname>
</ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>EventBuffer</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="eventbuffer.constants.eol-any">EventBuffer::EOL_ANY</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="eventbuffer.constants.eol-crlf">EventBuffer::EOL_CRLF</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="eventbuffer.constants.eol-crlf-strict">EventBuffer::EOL_CRLF_STRICT</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="eventbuffer.constants.eol-lf">EventBuffer::EOL_LF</varname>
<initializer>3</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="eventbuffer.constants.ptr-set">EventBuffer::PTR_SET</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="eventbuffer.constants.ptr-add">EventBuffer::PTR_ADD</varname>
<initializer>1</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>int</type>
<varname linkend="eventbuffer.props.length">length</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>int</type>
<varname linkend="eventbuffer.props.contiguous-space">contiguous_space</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.eventbuffer')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ EventBuffer properties -->
<section xml:id="eventbuffer.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="eventbuffer.props.length">
<term>
<varname>length</varname>
</term>
<listitem>
<para>
Количество байтов, которые хранятся в буфере событий.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventbuffer.props.contiguous-space">
<term>
<varname>contiguous_space</varname>
</term>
<listitem>
<para>
Количество байтов, которые хранятся последовательно в начале буфера.
Байты в буфере могут храниться в отдельных фрагментах памяти;
свойство возвращает количество байтов, которые хранятся в первом фрагменте.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ EventBuffer constants -->
<section xml:id="eventbuffer.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="eventbuffer.constants.eol-any">
<term>
<constant>EventBuffer::EOL_ANY</constant>
</term>
<listitem>
<para>
Конец строки — последовательность произвольного количества символов
возврата каретки и перевода строки. Этот формат не очень
полезен и его сохраняют в основном для обратной совместимости.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventbuffer.constants.eol-crlf">
<term>
<constant>EventBuffer::EOL_CRLF</constant>
</term>
<listitem>
<para>
Конец строки — последовательность из необязательного
возврата каретки и перевода строки. Говоря по-другому, либо
<literal>"\r\n"</literal>, либо <literal>"\n"</literal>. Этот формат полезен
при разборе текстовых интернет-протоколов,
поскольку стандарты обычно предписывают обозначать конец строки
последовательностью символов <literal>"\r\n"</literal>, но клиенты,
которые не соблюдают стандарты, иногда говорят просто <literal>"\n"</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventbuffer.constants.eol-crlf-strict">
<term>
<constant>EventBuffer::EOL_CRLF_STRICT</constant>
</term>
<listitem>
<para>
Конец строки — один символ возврата каретки, за которым идёт один символ перевода строки.
Эту последовательность символов знают как <literal>"\r\n"</literal>. Значения кодировки ASCII:
<literal>0x0D</literal><literal>0x0A</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventbuffer.constants.eol-lf">
<term>
<constant>EventBuffer::EOL_LF</constant>
</term>
<listitem>
<para>
Конец строки — один символ перевода строки —
<literal>"\n"</literal>. Значение в кодировке ASCII: <literal>0x0A</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventbuffer.constants.ptr-set">
<term>
<constant>EventBuffer::PTR_SET</constant>
</term>
<listitem>
<para>
Флаг, который передают как аргумент в метод <methodname>EventBuffer::setPosition</methodname>.
Если флаг установили, указатель позиции перемещается в буфере в абсолютную позицию.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventbuffer.constants.ptr-add">
<term>
<constant>EventBuffer::PTR_ADD</constant>
</term>
<listitem>
<para>
То же, что и флаг <constant>EventBuffer::PTR_SET</constant>,
за исключением того, что этот флаг заставляет метод
<methodname>EventBuffer::setPosition</methodname>
перемещать позицию вперёд на заданное количество байтов, а не устанавливать
абсолютную позицию.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.event.entities.eventbuffer;
</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
-->