php-doc-en/reference/event/eventdnsbase.xml
Christoph Michael Becker 86e6094e86 Use canonical type names
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351133 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-02 15:39:04 +00:00

160 lines
4.9 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.eventdnsbase" 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 EventDnsBase class</title>
<titleabbrev>EventDnsBase</titleabbrev>
<partintro>
<!-- {{{ EventDnsBase intro -->
<section xml:id="eventdnsbase.intro">
&reftitle.intro;
<para>
Represents Libevent&apos;s DNS base structure. Used to resolve DNS
asyncronously, parse configuration files like resolv.conf etc.
</para>
</section>
<!-- }}} -->
<section xml:id="eventdnsbase.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass>
<classname>EventDnsBase</classname>
</ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<modifier>final</modifier>
<classname>EventDnsBase</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Constants</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="eventdnsbase.constants.option-search">EventDnsBase::OPTION_SEARCH</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="eventdnsbase.constants.option-nameservers">EventDnsBase::OPTION_NAMESERVERS</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="eventdnsbase.constants.option-misc">EventDnsBase::OPTION_MISC</varname>
<initializer>4</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="eventdnsbase.constants.option-hostsfile">EventDnsBase::OPTION_HOSTSFILE</varname>
<initializer>8</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="eventdnsbase.constants.options-all">EventDnsBase::OPTIONS_ALL</varname>
<initializer>15</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.eventdnsbase')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ EventDnsBase constants -->
<section xml:id="eventdnsbase.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="eventdnsbase.constants.option-search">
<term>
<constant>EventDnsBase::OPTION_SEARCH</constant>
</term>
<listitem>
<para>
Tells to read the domain and search fields from the
<literal>resolv.conf</literal>
file and the
<literal>ndots</literal>
option, and use them to decide which domains(if any) to search for
hostnames that arent fully-qualified.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventdnsbase.constants.option-nameservers">
<term>
<constant>EventDnsBase::OPTION_NAMESERVERS</constant>
</term>
<listitem>
<para>
Tells to learn the nameservers from the
<literal>resolv.conf</literal>
file.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventdnsbase.constants.option-misc">
<term>
<constant>EventDnsBase::OPTION_MISC</constant>
</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventdnsbase.constants.option-hostsfile">
<term>
<constant>EventDnsBase::OPTION_HOSTSFILE</constant>
</term>
<listitem>
<para>
Tells to read a list of hosts from
<literal>/etc/hosts</literal>
as part of loading the
<literal>resolv.conf</literal>
file.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="eventdnsbase.constants.options-all">
<term>
<constant>EventDnsBase::OPTIONS_ALL</constant>
</term>
<listitem>
<para>
Tells to learn as much as it can from the
<literal>resolv.conf</literal>
file.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.event.entities.eventdnsbase;
</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
-->