construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="eventdnsbase.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>EventDnsBase::__construct</refname>
  <refpurpose>Constructs EventDnsBase object</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis role="EventDnsBase">
   <modifier>public</modifier>
   <methodname>EventDnsBase::__construct</methodname>
   <methodparam>
    <type>EventBase</type>
    <parameter>base</parameter>
   </methodparam>
   <methodparam>
    <type class="union"><type>int</type><type>bool</type></type>
    <parameter>initialize</parameter>
   </methodparam>
  </constructorsynopsis>
  <para>
   Constructs EventDnsBase object.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term>
     <parameter>base</parameter>
    </term>
    <listitem>
     <para>
      Event base.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>initialize</parameter>
    </term>
    <listitem>
     <para>
      If <parameter>initialize</parameter> is &true;,
      it attempts to use the underlying operating system defaults to configure
      the DNS base senibly.
      If it is &false;, the DNS base is left unconfigured, with no nameservers or options set.
      In the latter case the DNS base should be configured manually, e.g. with
      <methodname>EventDnsBase::parseResolvConf</methodname>.
     </para>
     <para>
      If <parameter>initialize</parameter> is an integer, it must be one of the following flags:
      <informaltable>
       <tgroup cols="2">
        <thead>
         <row>
          <entry valign="top">Flag</entry>
          <entry valign="top">&Description;</entry>
         </row>
        </thead>
        <tbody>
         <row>
          <entry valign="top"><constant>EventDnsBase::DISABLE_WHEN_INACTIVE</constant></entry>
          <entry valign="top">
           Do not prevent the libevent event loop from exiting when we have no active DNS requests.
          </entry>
         </row>
         <row>
          <entry valign="top"><constant>EventDnsBase::INITIALIZE_NAMESERVERS</constant></entry>
          <entry valign="top">
           Process the <literal>resolv.conf</literal>.
          </entry>
         </row>
         <row>
          <entry valign="top"><constant>EventDnsBase::NAMESERVERS_NO_DEFAULT</constant></entry>
          <entry valign="top">
           Do not add default nameserver if there are no nameservers in the <literal>resolv.conf</literal>.
          </entry>
         </row>
        </tbody>
       </tgroup>
      </informaltable>
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   If <parameter>initialize</parameter> has a type other than
   <type class="union"><type>int</type><type>bool</type></type>,
   a <exceptionname>TypeError</exceptionname> is thrown.
  </para>
  <para>
   If the value of <parameter>initialize</parameter> is invalid,
   a <exceptionname>EventException</exceptionname> is thrown.
  </para>
 </refsect1>
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>PECL event 3.1.3</entry>
       <entry>
        If <parameter>initialize</parameter> has a type other than
        <type class="union"><type>int</type><type>bool</type></type>,
        a <exceptionname>TypeError</exceptionname> is thrown.
       </entry>
      </row>
      <row>
       <entry>PECL event 3.1.0RC1</entry>
       <entry>
        The type of the <parameter>initialize</parameter> parameter has been changed from <type>bool</type>
        to <type>mixed</type>. The value can be either <type>bool</type> (preserving the previous meaning)
        or one of the following constants:
        <constant>EventDnsBase::DISABLE_WHEN_INACTIVE</constant>,
        <constant>EventDnsBase::INITIALIZE_NAMESERVERS</constant>,
        or <constant>EventDnsBase::NAMESERVERS_NO_DEFAULT</constant>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </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
-->