lwres_config.html revision 75c0816e8295e180f4bc7f10db3d0d880383bc1c
43b4c41fbb07705c9df321221ab9cb9832460407Christian Maeder<!--
c63ebf815c8a874525cf18670ad74847f7fc7b26Christian Maeder - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
7d170078860d52494588609be44be963c416ecf6Christian Maeder - Copyright (C) 2000, 2001 Internet Software Consortium.
25cc5fbba63f84b47e389af749f55abbbde71c8cChristian Maeder -
5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder - Permission to use, copy, modify, and distribute this software for any
43b4c41fbb07705c9df321221ab9cb9832460407Christian Maeder - purpose with or without fee is hereby granted, provided that the above
5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder - copyright notice and this permission notice appear in all copies.
5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder -
5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
43b4c41fbb07705c9df321221ab9cb9832460407Christian Maeder - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
f4a2a20e49f41b2afa657e5e64d9e349c7faa091Christian Maeder - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
f2f9df2e17e70674f0bf426ed1763c973ee4cde0Christian Maeder - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
c9a7e6af169a2adfb92f42331cd578065ed83a2bChristian Maeder - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
c9a7e6af169a2adfb92f42331cd578065ed83a2bChristian Maeder - PERFORMANCE OF THIS SOFTWARE.
5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder-->
5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<!-- $Id: lwres_config.html,v 1.13 2005/05/13 03:14:12 marka Exp $ -->
5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<html>
a53841f6d6e86ac751c12a33dc8aadf53f59d977Klaus Luettich<head>
a53841f6d6e86ac751c12a33dc8aadf53f59d977Klaus Luettich<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
a53841f6d6e86ac751c12a33dc8aadf53f59d977Klaus Luettich<title>lwres_config</title>
a53841f6d6e86ac751c12a33dc8aadf53f59d977Klaus Luettich<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
a737caf82de97c1907027c03e4b4509eb492b4b8Christian Maeder</head>
68d10d143f29fcff3c637ba24f90e983995ceae6Christian Maeder<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
96646aed2ae087b942ae23f15bbe729a8f7c43d3Christian Maeder<a name="id2456836"></a><div class="titlepage"></div>
01e383014b555bbcf639c0ca60c5810b3eff83c0Christian Maeder<div class="refnamediv">
3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski<h2>Name</h2>
9dac90ec2be2a72e03893095461960d483fe2fc2Christian Maeder<p>lwres_conf_init, lwres_conf_clear, lwres_conf_parse, lwres_conf_print, lwres_conf_get &#8212; lightweight resolver configuration</p>
5e5d3e82af3bc2834f8718a52d9f45da80220273Dominik Luecke</div>
124c859ba4741d5e36d5d98634886b430b7af093Christian Maeder<div class="refsynopsisdiv">
ce8b15da31cd181b7e90593cbbca98f47eda29d6Till Mossakowski<h2>Synopsis</h2>
e7757995211bd395dc79d26fe017d99375f7d2a6Christian Maeder<div class="funcsynopsis">
e7757995211bd395dc79d26fe017d99375f7d2a6Christian Maeder<pre class="funcsynopsisinfo">#include &lt;lwres/lwres.h&gt;</pre>
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder<td><code class="funcdef">
a1ed34933c266ce85066acb0d7b20c90cb8eb213Christian Maedervoid
c0c2380bced8159ff0297ece14eba948bd236471Christian Maeder<b class="fsfunc">lwres_conf_init</b>(</code></td>
404166b9366552e9ec5abb87a37c76ec8a815fb7Klaus Luettich<td>lwres_context_t *�</td>
b1f59a4ea7c96f4c03a4d7cfcb9c5e66871cfbbbChristian Maeder<td>
ad270004874ce1d0697fb30d7309f180553bb315Christian Maeder<var class="pdparam">ctx</var><code>)</code>;</td>
4d56f2fa72e4aec20eb827c11ed49c8cbb7014bdChristian Maeder</tr></table>
4cb215739e9ab13447fa21162482ebe485b47455Christian Maeder<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr>
8ef75f1cc0437656bf622cec5ac9e8ea221da8f2Christian Maeder<td><code class="funcdef">
404166b9366552e9ec5abb87a37c76ec8a815fb7Klaus Luettichvoid
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder<b class="fsfunc">lwres_conf_clear</b>(</code></td>
74eed04be26f549d2f7ca35c370e1c03879b28b1Christian Maeder<td>lwres_context_t *�</td>
d23b0cc79c0d204e6ec758dff8d0ba71c9f693f7Christian Maeder<td>
8d97ef4f234681b11bb5924bd4d03adef858d2d2Christian Maeder<var class="pdparam">ctx</var><code>)</code>;</td>
f4a2a20e49f41b2afa657e5e64d9e349c7faa091Christian Maeder</tr></table>
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
e593b89bfd4952698dc37feced21cefe869d87a2Christian Maeder<tr>
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder<td><code class="funcdef">
f38b3687c5558128515e34fb85d8b466d22dc300Christian Maederlwres_result_t
5191fa24c532d1f67e7a642e9aece65efb8a0975Christian Maeder<b class="fsfunc">lwres_conf_parse</b>(</code></td>
7cc09dd93962a2155c34d209d1d4cd7d7b838264Christian Maeder<td>lwres_context_t *�</td>
1aee4aaddde105264c1faf394d88e302c05094ffChristian Maeder<td>
1aee4aaddde105264c1faf394d88e302c05094ffChristian Maeder<var class="pdparam">ctx</var>, </td>
51d769d55d88dfa88bdf54bee78d8fa85a2deba8Christian Maeder</tr>
f041c9a6bda23de33a38490e35b831ae18d96b45Christian Maeder<tr>
7cc09dd93962a2155c34d209d1d4cd7d7b838264Christian Maeder<td>�</td>
51d769d55d88dfa88bdf54bee78d8fa85a2deba8Christian Maeder<td>const char *�</td>
1aee4aaddde105264c1faf394d88e302c05094ffChristian Maeder<td>
1aee4aaddde105264c1faf394d88e302c05094ffChristian Maeder<var class="pdparam">filename</var><code>)</code>;</td>
c3053d57f642ca507cdf79512e604437c4546cb9Christian Maeder</tr>
dcbd32289a7bdf1e6edd06c6ab0698c6a9dbf37aChristian Maeder</table>
f4a2a20e49f41b2afa657e5e64d9e349c7faa091Christian Maeder<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
f4a2a20e49f41b2afa657e5e64d9e349c7faa091Christian Maeder<tr>
dcbd32289a7bdf1e6edd06c6ab0698c6a9dbf37aChristian Maeder<td><code class="funcdef">
d0279930f87bf39843e0bd2992a4789322662144Christian Maederlwres_result_t
8be81a0578b59f08641da7fad1479e1f9e83c6e9Kristina Sojakova<b class="fsfunc">lwres_conf_print</b>(</code></td>
1aee4aaddde105264c1faf394d88e302c05094ffChristian Maeder<td>lwres_context_t *�</td>
8b767d09a78927b111f5596fdff9ca7d2c1a439fChristian Maeder<td>
8b767d09a78927b111f5596fdff9ca7d2c1a439fChristian Maeder<var class="pdparam">ctx</var>, </td>
8b767d09a78927b111f5596fdff9ca7d2c1a439fChristian Maeder</tr>
8b767d09a78927b111f5596fdff9ca7d2c1a439fChristian Maeder<tr>
8b767d09a78927b111f5596fdff9ca7d2c1a439fChristian Maeder<td>�</td>
8b767d09a78927b111f5596fdff9ca7d2c1a439fChristian Maeder<td>FILE *�</td>
d54cd08a4cfa26256c38d8ed12c343adbfe1a0e3Christian Maeder<td>
ea06324815fff0b73f7524f11af3672c2389f7ecChristian Maeder<var class="pdparam">fp</var><code>)</code>;</td>
8cacad2a09782249243b80985f28e9387019fe40Christian Maeder</tr>
363939beade943a02b31004cea09dec34fa8a6d9Christian Maeder</table>
a7c27282e71cf4505026645f96d4f5cb8a284e32Christian Maeder<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr>
363939beade943a02b31004cea09dec34fa8a6d9Christian Maeder<td><code class="funcdef">
8a28707e9155465c6f2236a06eac6580a65c7025Christian Maederlwres_conf_t *
f04e8f3ff56405901be968fd4c6e9769239f1a9bKlaus Luettich<b class="fsfunc">lwres_conf_get</b>(</code></td>
797ccd67cb8ae127be097cd43448801b673e3b69Christian Maeder<td>lwres_context_t *�</td>
797ccd67cb8ae127be097cd43448801b673e3b69Christian Maeder<td>
431d34c7007a787331c4e5ec997badb0f8190fc7Christian Maeder<var class="pdparam">ctx</var><code>)</code>;</td>
f1541d4a151dbd08002dbd14e7eb1d5dde253689Christian Maeder</tr></table>
498aa48bdb931ab50990d3b74318a5db2312186cChristian Maeder</div>
f1541d4a151dbd08002dbd14e7eb1d5dde253689Christian Maeder</div>
6dc9bc98d0854fe2e3dd3bfc4275096a0c28ee1cChristian Maeder<div class="refsect1" lang="en">
6dc9bc98d0854fe2e3dd3bfc4275096a0c28ee1cChristian Maeder<a name="id2514266"></a><h2>DESCRIPTION</h2>
6dc9bc98d0854fe2e3dd3bfc4275096a0c28ee1cChristian Maeder<p><code class="function">lwres_conf_init()</code>
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder creates an empty
61fa0ac06ede811c7aad54ec4c4202346727368eChristian Maeder <span class="type">lwres_conf_t</span>
c0c2380bced8159ff0297ece14eba948bd236471Christian Maeder structure for lightweight resolver context
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder <em class="parameter"><code>ctx</code></em>.
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder </p>
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder<p><code class="function">lwres_conf_clear()</code>
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder frees up all the internal memory used by
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder that
9e748851c150e1022fb952bab3315e869aaf0214Christian Maeder <span class="type">lwres_conf_t</span>
6a79849bed67264c396dddb3e9c184bdfc1a1bc9Christian Maeder structure in resolver context
6a79849bed67264c396dddb3e9c184bdfc1a1bc9Christian Maeder <em class="parameter"><code>ctx</code></em>.
6a79849bed67264c396dddb3e9c184bdfc1a1bc9Christian Maeder </p>
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder<p><code class="function">lwres_conf_parse()</code>
ca074a78b8dcccbb8c419586787882f98d0c6163Christian Maeder opens the file
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder <em class="parameter"><code>filename</code></em>
6a79849bed67264c396dddb3e9c184bdfc1a1bc9Christian Maeder and parses it to initialise the resolver context
a5e5b8c3e5c11177e5034ef2423813a5d28979edChristian Maeder <em class="parameter"><code>ctx</code></em>'s
bc8cbf12aa172bf5673b92a9e7a0151d4aa4c315Christian Maeder <span class="type">lwres_conf_t</span>
2d130d212db7208777ca896a7ecad619a8944971Christian Maeder structure.
2d130d212db7208777ca896a7ecad619a8944971Christian Maeder </p>
51d769d55d88dfa88bdf54bee78d8fa85a2deba8Christian Maeder<p><code class="function">lwres_conf_print()</code>
a5e5b8c3e5c11177e5034ef2423813a5d28979edChristian Maeder prints the
2d130d212db7208777ca896a7ecad619a8944971Christian Maeder <span class="type">lwres_conf_t</span>
bc8cbf12aa172bf5673b92a9e7a0151d4aa4c315Christian Maeder structure for resolver context
2d130d212db7208777ca896a7ecad619a8944971Christian Maeder <em class="parameter"><code>ctx</code></em>
f4a2a20e49f41b2afa657e5e64d9e349c7faa091Christian Maeder to the
2d130d212db7208777ca896a7ecad619a8944971Christian Maeder <span class="type">FILE</span>
2d130d212db7208777ca896a7ecad619a8944971Christian Maeder <em class="parameter"><code>fp</code></em>.
6a79849bed67264c396dddb3e9c184bdfc1a1bc9Christian Maeder </p>
6ff7a91875597d6e4dfaa68c79187d01473e8341Christian Maeder</div>
6ff7a91875597d6e4dfaa68c79187d01473e8341Christian Maeder<div class="refsect1" lang="en">
6a79849bed67264c396dddb3e9c184bdfc1a1bc9Christian Maeder<a name="id2514333"></a><h2>RETURN VALUES</h2>
6a79849bed67264c396dddb3e9c184bdfc1a1bc9Christian Maeder<p><code class="function">lwres_conf_parse()</code>
4017ebc0f692820736d796af3110c3b3018c108aChristian Maeder returns <span class="errorcode">LWRES_R_SUCCESS</span>
a9b59eb2ce961014974276cdae0e9df4419bd212Christian Maeder if it successfully read and parsed
6a79849bed67264c396dddb3e9c184bdfc1a1bc9Christian Maeder <em class="parameter"><code>filename</code></em>.
6a79849bed67264c396dddb3e9c184bdfc1a1bc9Christian Maeder It returns <span class="errorcode">LWRES_R_FAILURE</span>
6a79849bed67264c396dddb3e9c184bdfc1a1bc9Christian Maeder if <em class="parameter"><code>filename</code></em>
6a79849bed67264c396dddb3e9c184bdfc1a1bc9Christian Maeder could not be opened or contained incorrect
6a79849bed67264c396dddb3e9c184bdfc1a1bc9Christian Maeder resolver statements.
a3c6d8e0670bf2aa71bc8e2a3b1f45d56dd65e4cChristian Maeder </p>
dc679edd4ca027663212afdf00926ae2ce19b555Christian Maeder<p><code class="function">lwres_conf_print()</code>
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder returns <span class="errorcode">LWRES_R_SUCCESS</span>
ca074a78b8dcccbb8c419586787882f98d0c6163Christian Maeder unless an error occurred when converting the network addresses to a
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder numeric host address string.
ca074a78b8dcccbb8c419586787882f98d0c6163Christian Maeder If this happens, the function returns
ca074a78b8dcccbb8c419586787882f98d0c6163Christian Maeder <span class="errorcode">LWRES_R_FAILURE</span>.
ca074a78b8dcccbb8c419586787882f98d0c6163Christian Maeder </p>
4017ebc0f692820736d796af3110c3b3018c108aChristian Maeder</div>
b568982efd0997d877286faa592d81b03c8c67b8Christian Maeder<div class="refsect1" lang="en">
ca074a78b8dcccbb8c419586787882f98d0c6163Christian Maeder<a name="id2514371"></a><h2>SEE ALSO</h2>
0be0db405c49906bd7057255069bf6df53395ac9Klaus Luettich<p><span class="citerefentry"><span class="refentrytitle">stdio</span>(3)</span>,
ca074a78b8dcccbb8c419586787882f98d0c6163Christian Maeder <span class="citerefentry"><span class="refentrytitle">resolver</span>(5)</span>.
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder </p>
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder</div>
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder<div class="refsect1" lang="en">
f2f9df2e17e70674f0bf426ed1763c973ee4cde0Christian Maeder<a name="id2514396"></a><h2>FILES</h2>
d946c1bfdd7d58aa7c023efe864d5999eb44a61bChristian Maeder<p><code class="filename">/etc/resolv.conf</code>
d946c1bfdd7d58aa7c023efe864d5999eb44a61bChristian Maeder </p>
d946c1bfdd7d58aa7c023efe864d5999eb44a61bChristian Maeder</div>
d946c1bfdd7d58aa7c023efe864d5999eb44a61bChristian Maeder</div></body>
d946c1bfdd7d58aa7c023efe864d5999eb44a61bChristian Maeder</html>
63f0e65a37b95621334db9ee4ba0cd9d826f5c0fChristian Maeder