home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _fdfdba76c3f11436007303339e5a110c < prev    next >
Text File  |  2000-03-23  |  18KB  |  433 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Net::DNS::Resolver - DNS resolver class</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Net::DNS::Resolver - DNS resolver class</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#methods">METHODS</A></LI>
  26.     <UL>
  27.  
  28.         <LI><A HREF="#new">new</A></LI>
  29.         <LI><A HREF="#print">print</A></LI>
  30.         <LI><A HREF="#string">string</A></LI>
  31.         <LI><A HREF="#searchlist">searchlist</A></LI>
  32.         <LI><A HREF="#nameservers">nameservers</A></LI>
  33.         <LI><A HREF="#port">port</A></LI>
  34.         <LI><A HREF="#search">search</A></LI>
  35.         <LI><A HREF="#query">query</A></LI>
  36.         <LI><A HREF="#send">send</A></LI>
  37.         <LI><A HREF="#bgsend">bgsend</A></LI>
  38.         <LI><A HREF="#bgread">bgread</A></LI>
  39.         <LI><A HREF="#bgisready">bgisready</A></LI>
  40.         <LI><A HREF="#axfr">axfr</A></LI>
  41.         <LI><A HREF="#tcp_timeout">tcp_timeout</A></LI>
  42.         <LI><A HREF="#retrans">retrans</A></LI>
  43.         <LI><A HREF="#retry">retry</A></LI>
  44.         <LI><A HREF="#recurse">recurse</A></LI>
  45.         <LI><A HREF="#defnames">defnames</A></LI>
  46.         <LI><A HREF="#dnsrch">dnsrch</A></LI>
  47.         <LI><A HREF="#debug">debug</A></LI>
  48.         <LI><A HREF="#usevc">usevc</A></LI>
  49.         <LI><A HREF="#igntc">igntc</A></LI>
  50.         <LI><A HREF="#errorstring">errorstring</A></LI>
  51.         <LI><A HREF="#answerfrom">answerfrom</A></LI>
  52.         <LI><A HREF="#answersize">answersize</A></LI>
  53.     </UL>
  54.  
  55.     <LI><A HREF="#environment">ENVIRONMENT</A></LI>
  56.     <UL>
  57.  
  58.         <LI><A HREF="#res_nameservers">RES_NAMESERVERS</A></LI>
  59.         <LI><A HREF="#res_searchlist">RES_SEARCHLIST</A></LI>
  60.         <LI><A HREF="#localdomain">LOCALDOMAIN</A></LI>
  61.         <LI><A HREF="#res_options">RES_OPTIONS</A></LI>
  62.     </UL>
  63.  
  64.     <LI><A HREF="#bugs">BUGS</A></LI>
  65.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  66.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  67. </UL>
  68. <!-- INDEX END -->
  69.  
  70. <HR>
  71. <P>
  72. <H1><A NAME="name">NAME</A></H1>
  73. <P>Net::DNS::Resolver - DNS resolver class</P>
  74. <P>
  75. <HR>
  76. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  77. <UL>
  78. <LI>Linux</LI>
  79. <LI>Solaris</LI>
  80. <LI>Windows</LI>
  81. </UL>
  82. <HR>
  83. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  84. <P><CODE>use Net::DNS::Resolver;</CODE></P>
  85. <P>
  86. <HR>
  87. <H1><A NAME="description">DESCRIPTION</A></H1>
  88. <P>Instances of the <CODE>Net::DNS::Resolver</CODE> class represent resolver objects.
  89. A program can have multiple resolver objects, each maintaining its
  90. own state information such as the nameservers to be queried, whether
  91. recursion is desired, etc.</P>
  92. <P>Resolver configuration is read from the following files, in the
  93. order indicated:</P>
  94. <PRE>
  95.     /etc/resolv.conf
  96.     $HOME/.resolv.conf
  97.     ./.resolv.conf</PRE>
  98. <P>The following keywords are recognized in resolver configuration files:</P>
  99. <DL>
  100. <DT><STRONG><A NAME="item_domain"><STRONG>domain</STRONG></A></STRONG><BR>
  101. <DD>
  102. The default domain.
  103. <P></P>
  104. <DT><STRONG><A NAME="item_search"><STRONG>search</STRONG></A></STRONG><BR>
  105. <DD>
  106. A space-separated list of domains to put in the search list.
  107. <P></P>
  108. <DT><STRONG><A NAME="item_nameserver"><STRONG>nameserver</STRONG></A></STRONG><BR>
  109. <DD>
  110. A space-separated list of nameservers to query.
  111. <P></P></DL>
  112. <P>Files except for <EM>/etc/resolv.conf</EM> must be owned by the effective
  113. userid running the program or they won't be read.  In addition, several
  114. environment variables can also contain configuration information;
  115. see <A HREF="#environment">ENVIRONMENT</A>.</P>
  116. <P>
  117. <HR>
  118. <H1><A NAME="methods">METHODS</A></H1>
  119. <P>
  120. <H2><A NAME="new">new</A></H2>
  121. <PRE>
  122.     $res = new Net::DNS::Resolver;</PRE>
  123. <P>Creates a new DNS resolver object.</P>
  124. <P>
  125. <H2><A NAME="print">print</A></H2>
  126. <PRE>
  127.     $res->print;</PRE>
  128. <P>Prints the resolver state on the standard output.</P>
  129. <P>
  130. <H2><A NAME="string">string</A></H2>
  131. <PRE>
  132.     print $res->string;</PRE>
  133. <P>Returns a string representation of the resolver state.</P>
  134. <P>
  135. <H2><A NAME="searchlist">searchlist</A></H2>
  136. <PRE>
  137.     @searchlist = $res->searchlist;
  138.     $res->searchlist("foo.com", "bar.com", "baz.org");</PRE>
  139. <P>Gets or sets the resolver search list.</P>
  140. <P>
  141. <H2><A NAME="nameservers">nameservers</A></H2>
  142. <PRE>
  143.     @nameservers = $res->nameservers;
  144.     $res->nameservers("192.168.1.1", "192.168.2.2", "192.168.3.3");</PRE>
  145. <P>Gets or sets the nameservers to be queried.</P>
  146. <P>
  147. <H2><A NAME="port">port</A></H2>
  148. <PRE>
  149.     print "sending queries to port ", $res->port, "\n";
  150.     $res->port(9732);</PRE>
  151. <P>Gets or sets the port to which we send queries.  This can be useful
  152. for testing a nameserver running on a non-standard port.  The
  153. default is port 53.</P>
  154. <P>
  155. <H2><A NAME="search">search</A></H2>
  156. <PRE>
  157.     $packet = $res->search("mailhost");
  158.     $packet = $res->search("mailhost.foo.com");
  159.     $packet = $res->search("192.168.1.1");
  160.     $packet = $res->search("foo.com", "MX");
  161.     $packet = $res->search("user.passwd.foo.com", "TXT", "HS");</PRE>
  162. <P>Performs a DNS query for the given name, applying the searchlist
  163. if appropriate.  The search algorithm is as follows:</P>
  164. <OL>
  165. <LI>
  166. If the name contains at least one dot, try it as is.
  167. <P></P>
  168. <LI>
  169. If the name doesn't end in a dot then append each item in
  170. the search list to the name.  This is only done if <STRONG>dnsrch</STRONG>
  171. is true.
  172. <P></P>
  173. <LI>
  174. If the name doesn't contain any dots, try it as is.
  175. <P></P></OL>
  176. <P>The record type and class can be omitted; they default to A and
  177. IN.  If the name looks like an IP address (4 dot-separated numbers),
  178. then an appropriate PTR query will be performed.</P>
  179. <P>Returns a <CODE>Net::DNS::Packet</CODE> object, or <A HREF="../../../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> if no answers
  180. were found.</P>
  181. <P>
  182. <H2><A NAME="query">query</A></H2>
  183. <PRE>
  184.     $packet = $res->query("mailhost");
  185.     $packet = $res->query("mailhost.foo.com");
  186.     $packet = $res->query("192.168.1.1");
  187.     $packet = $res->query("foo.com", "MX");
  188.     $packet = $res->query("user.passwd.foo.com", "TXT", "HS");</PRE>
  189. <P>Performs a DNS query for the given name; the search list is not
  190. applied.  If the name doesn't contain any dots and <STRONG>defnames</STRONG>
  191. is true then the default domain will be appended.</P>
  192. <P>The record type and class can be omitted; they default to A and
  193. IN.  If the name looks like an IP address (4 dot-separated numbers),
  194. then an appropriate PTR query will be performed.</P>
  195. <P>Returns a <CODE>Net::DNS::Packet</CODE> object, or <A HREF="../../../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> if no answers
  196. were found.</P>
  197. <P>
  198. <H2><A NAME="send">send</A></H2>
  199. <PRE>
  200.     $packet = $res->send($packet_object);
  201.     $packet = $res->send("mailhost.foo.com");
  202.     $packet = $res->send("foo.com", "MX");
  203.     $packet = $res->send("user.passwd.foo.com", "TXT", "HS");</PRE>
  204. <P>Performs a DNS query for the given name.  Neither the searchlist
  205. nor the default domain will be appended.</P>
  206. <P>The argument list can be either a <CODE>Net::DNS::Packet</CODE> object or a list
  207. of strings.  The record type and class can be omitted; they default to
  208. A and IN.  If the name looks like an IP address (4 dot-separated numbers),
  209. then an appropriate PTR query will be performed.</P>
  210. <P>Returns a <CODE>Net::DNS::Packet</CODE> object whether there were any answers or not.
  211. Use <CODE>$packet</CODE>-><CODE>header</CODE>-><CODE>ancount</CODE> or <CODE>$packet</CODE>-><CODE>answer</CODE> to find out
  212. if there were any records in the answer section.  Returns <A HREF="../../../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> if there
  213. was an error.</P>
  214. <P>
  215. <H2><A NAME="bgsend">bgsend</A></H2>
  216. <PRE>
  217.     $socket = $res->bgsend($packet_object);
  218.     $socket = $res->bgsend("mailhost.foo.com");
  219.     $socket = $res->bgsend("foo.com", "MX");
  220.     $socket = $res->bgsend("user.passwd.foo.com", "TXT", "HS");</PRE>
  221. <P>Performs a background DNS query for the given name, i.e., sends a
  222. query packet to the first nameserver listed in <CODE>$res</CODE>-><CODE>nameservers</CODE>
  223. and returns immediately without waiting for a response.  The program
  224. can then perform other tasks while waiting for a response from the 
  225. nameserver.</P>
  226. <P>The argument list can be either a <CODE>Net::DNS::Packet</CODE> object or a list
  227. of strings.  The record type and class can be omitted; they default to
  228. A and IN.  If the name looks like an IP address (4 dot-separated numbers),
  229. then an appropriate PTR query will be performed.</P>
  230. <P>Returns an <CODE>IO::Socket</CODE> object.  The program must determine when
  231. the socket is ready for reading and call <CODE>$res</CODE>-><CODE>bgread</CODE> to get
  232. the response packet.  You can use <CODE>$res</CODE>-><CODE>bgisready</CODE> or <CODE>IO::Select</CODE>
  233. to find out if the socket is ready before reading it.</P>
  234. <P>
  235. <H2><A NAME="bgread">bgread</A></H2>
  236. <PRE>
  237.     $packet = $res->bgread($socket);
  238.     undef $socket;</PRE>
  239. <P>Reads the answer from a background query (see <A HREF="#bgsend">bgsend</A>).  The argument
  240. is an <CODE>IO::Socket</CODE> object returned by <CODE>bgsend</CODE>.</P>
  241. <P>Returns a <CODE>Net::DNS::Packet</CODE> object or <A HREF="../../../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> on error.</P>
  242. <P>The programmer should close or destroy the socket object after reading it.</P>
  243. <P>
  244. <H2><A NAME="bgisready">bgisready</A></H2>
  245. <PRE>
  246.     $socket = $res->bgsend("foo.bar.com");
  247.     until ($res->bgisready($socket)) {
  248.         # do some other processing
  249.     }
  250.     $packet = $res->bgread($socket);
  251.     $socket = undef;</PRE>
  252. <P>Determines whether a socket is ready for reading.  The argument is
  253. an <CODE>IO::Socket</CODE> object returned by <CODE>$res</CODE>-><CODE>bgsend</CODE>.</P>
  254. <P>Returns true if the socket is ready, false if not.</P>
  255. <P>
  256. <H2><A NAME="axfr">axfr</A></H2>
  257. <PRE>
  258.     @zone = $res->axfr;
  259.     @zone = $res->axfr("foo.com");
  260.     @zone = $res->axfr("passwd.foo.com", "HS");</PRE>
  261. <P>Performs a zone transfer from the first nameserver listed in <CODE>nameservers</CODE>.
  262. If the zone is omitted, it defaults to the first zone listed in the resolver's
  263. search list.  If the class is omitted, it defaults to IN.</P>
  264. <P>Returns a list of <CODE>Net::DNS::RR</CODE> objects, or <A HREF="../../../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> if the zone
  265. transfer failed.</P>
  266. <P>The redundant SOA record that terminates the zone transfer is not
  267. returned to the caller.</P>
  268. <P>Here's an example that uses a timeout:</P>
  269. <PRE>
  270.     $res->tcp_timeout(10);
  271.     @zone = $res->axfr("foo.com");
  272.     if (@zone) {
  273.         foreach $rr (@zone) {
  274.             $rr->print;
  275.         }
  276.     }
  277.     else {
  278.         print "Zone transfer failed: ", $res->errorstring, "\n";
  279.     }</PRE>
  280. <P>
  281. <H2><A NAME="tcp_timeout">tcp_timeout</A></H2>
  282. <PRE>
  283.     print "TCP timeout: ", $res->tcp_timeout, "\n";
  284.     $res->tcp_timeout(10);</PRE>
  285. <P>Get or set the TCP timeout in seconds.  A timeout of <A HREF="../../../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> means
  286. indefinite.  The default is 120 seconds (2 minutes).</P>
  287. <P>
  288. <H2><A NAME="retrans">retrans</A></H2>
  289. <PRE>
  290.     print "retrans interval: ", $res->retrans, "\n";
  291.     $res->retrans(3);</PRE>
  292. <P>Get or set the retransmission interval.  The default is 5.</P>
  293. <P>
  294. <H2><A NAME="retry">retry</A></H2>
  295. <PRE>
  296.     print "number of tries: ", $res->retry, "\n";
  297.     $res->retry(2);</PRE>
  298. <P>Get or set the number of times to try the query.  The default is 4.</P>
  299. <P>
  300. <H2><A NAME="recurse">recurse</A></H2>
  301. <PRE>
  302.     print "recursion flag: ", $res->recurse, "\n";
  303.     $res->recurse(0);</PRE>
  304. <P>Get or set the recursion flag.  If this is true, nameservers will
  305. be requested to perform a recursive query.  The default is true.</P>
  306. <P>
  307. <H2><A NAME="defnames">defnames</A></H2>
  308. <PRE>
  309.     print "defnames flag: ", $res->defnames, "\n";
  310.     $res->defnames(0);</PRE>
  311. <P>Get or set the defnames flag.  If this is true, calls to <STRONG>query</STRONG> will
  312. append the default domain to names that contain no dots.  The default
  313. is true.</P>
  314. <P>
  315. <H2><A NAME="dnsrch">dnsrch</A></H2>
  316. <PRE>
  317.     print "dnsrch flag: ", $res->dnsrch, "\n";
  318.     $res->dnsrch(0);</PRE>
  319. <P>Get or set the dnsrch flag.  If this is true, calls to <STRONG>search</STRONG> will
  320. apply the search list.  The default is true.</P>
  321. <P>
  322. <H2><A NAME="debug">debug</A></H2>
  323. <PRE>
  324.     print "debug flag: ", $res->debug, "\n";
  325.     $res->debug(1);</PRE>
  326. <P>Get or set the debug flag.  If set, calls to <STRONG>search</STRONG>, <STRONG>query</STRONG>,
  327. and <STRONG>send</STRONG> will print debugging information on the standard output.
  328. The default is false.</P>
  329. <P>
  330. <H2><A NAME="usevc">usevc</A></H2>
  331. <PRE>
  332.     print "usevc flag: ", $res->usevc, "\n";
  333.     $res->usevc(1);</PRE>
  334. <P>Get or set the usevc flag.  If true, then queries will be performed
  335. using virtual circuits (TCP) instead of datagrams (UDP).  The default
  336. is false.</P>
  337. <P>
  338. <H2><A NAME="igntc">igntc</A></H2>
  339. <PRE>
  340.     print "igntc flag: ", $res->igntc, "\n";
  341.     $res->igntc(1);</PRE>
  342. <P>Get or set the igntc flag.  If true, truncated packets will be
  343. ignored.  If false, truncated packets will cause the query to
  344. be retried using TCP.  The default is false.</P>
  345. <P>
  346. <H2><A NAME="errorstring">errorstring</A></H2>
  347. <PRE>
  348.     print "query status: ", $res->errorstring, "\n";</PRE>
  349. <P>Returns a string containing the status of the most recent query.</P>
  350. <P>
  351. <H2><A NAME="answerfrom">answerfrom</A></H2>
  352. <PRE>
  353.     print "last answer was from: ", $res->answerfrom, "\n";</PRE>
  354. <P>Returns the IP address from which we received the last answer in
  355. response to a query.</P>
  356. <P>
  357. <H2><A NAME="answersize">answersize</A></H2>
  358. <PRE>
  359.     print "size of last answer: ", $res->answersize, "\n";</PRE>
  360. <P>Returns the size in bytes of the last answer we received in
  361. response to a query.</P>
  362. <P>
  363. <HR>
  364. <H1><A NAME="environment">ENVIRONMENT</A></H1>
  365. <P>The following environment variables can also be used to configure
  366. the resolver:</P>
  367. <P>
  368. <H2><A NAME="res_nameservers">RES_NAMESERVERS</A></H2>
  369. <PRE>
  370.     # Bourne Shell
  371.     RES_NAMESERVERS="192.168.1.1 192.168.2.2 192.168.3.3"
  372.     export RES_NAMESERVERS</PRE>
  373. <PRE>
  374.     # C Shell
  375.     setenv RES_NAMESERVERS "192.168.1.1 192.168.2.2 192.168.3.3"</PRE>
  376. <P>A space-separated list of nameservers to query.</P>
  377. <P>
  378. <H2><A NAME="res_searchlist">RES_SEARCHLIST</A></H2>
  379. <PRE>
  380.     # Bourne Shell
  381.     RES_SEARCHLIST="foo.com bar.com baz.org"
  382.     export RES_SEARCHLIST</PRE>
  383. <PRE>
  384.     # C Shell
  385.     setenv RES_SEARCHLIST "foo.com bar.com baz.org"</PRE>
  386. <P>A space-separated list of domains to put in the search list.</P>
  387. <P>
  388. <H2><A NAME="localdomain">LOCALDOMAIN</A></H2>
  389. <PRE>
  390.     # Bourne Shell
  391.     LOCALDOMAIN=foo.com
  392.     export LOCALDOMAIN</PRE>
  393. <PRE>
  394.     # C Shell
  395.     setenv LOCALDOMAIN foo.com</PRE>
  396. <P>The default domain.</P>
  397. <P>
  398. <H2><A NAME="res_options">RES_OPTIONS</A></H2>
  399. <PRE>
  400.     # Bourne Shell
  401.     RES_OPTIONS="retrans:3 retry:2 debug"
  402.     export RES_OPTIONS</PRE>
  403. <PRE>
  404.     # C Shell
  405.     setenv RES_OPTIONS "retrans:3 retry:2 debug"</PRE>
  406. <P>A space-separated list of resolver options to set.  Options that
  407. take values are specified as <EM>option</EM>:<EM>value</EM>.</P>
  408. <P>
  409. <HR>
  410. <H1><A NAME="bugs">BUGS</A></H1>
  411. <P>Error reporting and handling needs to be improved.</P>
  412. <P>
  413. <HR>
  414. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  415. <P>Copyright (c) 1997 Michael Fuhr.  All rights reserved.  This program is free
  416. software; you can redistribute it and/or modify it under the same terms as
  417. Perl itself.</P>
  418. <P>
  419. <HR>
  420. <H1><A NAME="see also">SEE ALSO</A></H1>
  421. <P><EM>perl(1)</EM>, <A HREF="../../../../site/lib/Net/DNS.html">the Net::DNS manpage</A>, <A HREF="../../../../site/lib/Net/DNS/Packet.html">the Net::DNS::Packet manpage</A>, <A HREF="../../../../site/lib/Net/DNS/Update.html">the Net::DNS::Update manpage</A>,
  422. <A HREF="../../../../site/lib/Net/DNS/Header.html">the Net::DNS::Header manpage</A>, <A HREF="../../../../site/lib/Net/DNS/Question.html">the Net::DNS::Question manpage</A>, <A HREF="../../../../site/lib/Net/DNS/RR.html">the Net::DNS::RR manpage</A>,
  423. <EM>resolver(5)</EM>, RFC 1035, RFC 1034 Section 4.3.5</P>
  424. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  425. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  426. <STRONG><P CLASS=block> Net::DNS::Resolver - DNS resolver class</P></STRONG>
  427. </TD></TR>
  428. </TABLE>
  429.  
  430. </BODY>
  431.  
  432. </HTML>
  433.