archived-doc-en/reference/event/eventdnsbase.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.eventdnsbase" role="class" 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>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="eventdnsbase.constants.disable-when-inactive">EventDnsBase::DISABLE_WHEN_INACTIVE</varname>
     <initializer>32768</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="eventdnsbase.constants.initialize-nameservers">EventDnsBase::INITIALIZE_NAMESERVERS</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="eventdnsbase.constants.nameservers-no-default">EventDnsBase::NAMESERVERS_NO_DEFAULT</varname>
     <initializer>65536</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:constructorsynopsis[1])" />
    <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>
    <varlistentry xml:id="eventdnsbase.constants.disable-when-inactive">
     <term>
      <constant>EventDnsBase::DISABLE_WHEN_INACTIVE</constant>
     </term>
     <listitem>
      <para>
       Do not prevent the libevent event loop from exiting when we have no active DNS requests.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="eventdnsbase.constants.initialize-nameservers">
     <term>
      <constant>EventDnsBase::INITIALIZE_NAMESERVERS</constant>
     </term>
     <listitem>
      <para>
       Process the <literal>resolv.conf</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="eventdnsbase.constants.nameservers-no-default">
     <term>
      <constant>EventDnsBase::NAMESERVERS_NO_DEFAULT</constant>
     </term>
     <listitem>
      <para>
       Do not add default nameserver if there are no nameservers in the <literal>resolv.conf</literal>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->
 </partintro>

 &reference.event.entities.eventdnsbase;

</reference>
<!-- 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
-->