mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
1d2b598616
Ignore entities.*.xml in en/reference/event git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@329925 c90b9560-bf6c-de11-be94-00142212c4b1
243 lines
7.5 KiB
XML
243 lines
7.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<phpdoc:classref xml:id="class.eventbuffer" 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 EventBuffer class</title>
|
|
<titleabbrev>EventBuffer</titleabbrev>
|
|
<partintro>
|
|
<!-- {{{ EventBuffer intro -->
|
|
<section xml:id="eventbuffer.intro">
|
|
&reftitle.intro;
|
|
<para>
|
|
<classname>EventBuffer</classname>
|
|
represents Libevent's "evbuffer", an utility functionality for buffered
|
|
I/O.
|
|
</para>
|
|
<para>
|
|
Event buffers are meant to be generally useful for doing the "buffer" part
|
|
of buffered network I/O.
|
|
</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>integer</type>
|
|
<varname linkend="eventbuffer.constants.eol-any">EventBuffer::EOL_ANY</varname>
|
|
<initializer>0</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventbuffer.constants.eol-crlf">EventBuffer::EOL_CRLF</varname>
|
|
<initializer>1</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventbuffer.constants.eol-crlf-strict">EventBuffer::EOL_CRLF_STRICT</varname>
|
|
<initializer>2</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventbuffer.constants.eol-lf">EventBuffer::EOL_LF</varname>
|
|
<initializer>3</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventbuffer.constants.ptr-set">EventBuffer::PTR_SET</varname>
|
|
<initializer>0</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</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>
|
|
The number of bytes stored in an event buffer.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventbuffer.props.contiguous-space">
|
|
<term>
|
|
<varname>contiguous_space</varname>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
The number of bytes stored contiguously at the front of the buffer. The
|
|
bytes in a buffer may be stored in multiple separate chunks of memory;
|
|
the property returns the number of bytes currently stored in the first
|
|
chunk.
|
|
</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>
|
|
The end of line is any sequence of any number of carriage return and
|
|
linefeed characters. This format is not very useful; it exists mainly
|
|
for backward compatibility.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventbuffer.constants.eol-crlf">
|
|
<term>
|
|
<constant>EventBuffer::EOL_CRLF</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
The end of the line is an optional carriage return, followed by a
|
|
linefeed. (In other words, it is either a
|
|
<literal>"\r\n"</literal>
|
|
or a
|
|
<literal>"\n"</literal>
|
|
.) This format is useful in parsing text-based Internet protocols,
|
|
since the standards generally prescribe a
|
|
<literal>"\r\n"</literal>
|
|
line-terminator, but nonconformant clients sometimes say just
|
|
<literal>"\n"</literal>
|
|
.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventbuffer.constants.eol-crlf-strict">
|
|
<term>
|
|
<constant>EventBuffer::EOL_CRLF_STRICT</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
The end of a line is a single carriage return, followed by a single
|
|
linefeed. (This is also known as
|
|
<literal>"\r\n"</literal>
|
|
. The ASCII values are
|
|
<constant>0x0D</constant>
|
|
<constant>0x0A</constant>
|
|
).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventbuffer.constants.eol-lf">
|
|
<term>
|
|
<constant>EventBuffer::EOL_LF</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
The end of a line is a single linefeed character. (This is also known
|
|
as
|
|
<literal>"\n"</literal>
|
|
. It is ASCII value is
|
|
<constant>0x0A</constant>
|
|
.)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventbuffer.constants.ptr-set">
|
|
<term>
|
|
<constant>EventBuffer::PTR_SET</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Flag used as argument of
|
|
<methodname>EventBuffer::setPosition</methodname>
|
|
method. If this flag specified, the position pointer is moved to an
|
|
absolute position within the buffer.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventbuffer.constants.ptr-add">
|
|
<term>
|
|
<constant>EventBuffer::PTR_ADD</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
The same as
|
|
<constant>EventBuffer::PTR_SET</constant>
|
|
, except this flag causes
|
|
<methodname>EventBuffer::setPosition</methodname>
|
|
method to move position forward up to the specified number of
|
|
bytes(instead of setting absolute position).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<!-- }}} -->
|
|
</partintro>
|
|
|
|
&reference.event.entities.eventbuffer;
|
|
|
|
</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
|
|
-->
|