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
|
<?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
-->
|
