Files
doc-en/reference/event/eventconfig/avoidmethod.xml
2021-07-22 17:26:04 +08:00

97 lines
2.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="eventconfig.avoidmethod" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EventConfig::avoidMethod</refname>
<refpurpose>Tells libevent to avoid specific event method</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>bool</type>
<methodname>EventConfig::avoidMethod</methodname>
<methodparam>
<type>string</type>
<parameter>method</parameter>
</methodparam>
</methodsynopsis>
<para>
Tells libevent to avoid specific event method(backend). See
<link
xlink:href="http://www.wangafu.net/~nickm/libevent-book/Ref2_eventbase.html#_creating_an_event_base">Creating
an event base</link>
.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>method</parameter>
</term>
<listitem>
<para>
The backend method to avoid. See
<link
linkend="eventconfig.constants">EventConfig constants</link>
.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>
<function>EventConfig::avoidMethod</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$cfg = new EventConfig();
if ($cfg->avoidMethod("select")) {
echo "'select' method avoided\n";
}
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member>
<methodname>EventBase::__construct</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
-->