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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 329774 $ -->
<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'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>integer</type>
<varname linkend="eventdnsbase.constants.option-search">EventDnsBase::OPTION_SEARCH</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventdnsbase.constants.option-nameservers">EventDnsBase::OPTION_NAMESERVERS</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventdnsbase.constants.option-misc">EventDnsBase::OPTION_MISC</varname>
<initializer>4</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="eventdnsbase.constants.option-hostsfile">EventDnsBase::OPTION_HOSTSFILE</varname>
<initializer>8</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</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 aren’t 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
-->
|