mirror of
https://github.com/php/doc-en.git
synced 2026-03-24 07:42:10 +01:00
114 lines
2.7 KiB
XML
114 lines
2.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eventbufferevent.createpair">
|
|
<refnamediv>
|
|
<refname>EventBufferEvent::createPair</refname>
|
|
<refpurpose>Creates two buffer events connected to each other</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier>
|
|
<modifier>static</modifier>
|
|
<type>array</type>
|
|
<methodname>EventBufferEvent::createPair</methodname>
|
|
<methodparam>
|
|
<type>EventBase</type>
|
|
<parameter>base</parameter>
|
|
</methodparam>
|
|
<methodparam choice="opt">
|
|
<type>int</type>
|
|
<parameter>options</parameter>
|
|
<initializer>0</initializer>
|
|
</methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns array of two
|
|
<classname>EventBufferEvent</classname>
|
|
objects connected to each other. All the usual options are supported,
|
|
except for
|
|
<constant>EventBufferEvent::OPT_CLOSE_ON_FREE</constant>,
|
|
which has no effect, and
|
|
<constant>EventBufferEvent::OPT_DEFER_CALLBACKS</constant>,
|
|
which is always on.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>base</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Associated event base
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>options</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
<link>EventBufferEvent::OPT_* constants</link>
|
|
combined with bitwise
|
|
<literal>OR</literal>
|
|
operator.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns array of two
|
|
<classname>EventBufferEvent</classname>
|
|
objects connected to each other.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>PECL event 1.9.0</entry>
|
|
<entry>
|
|
Method made static.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</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
|
|
-->
|