<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>unbound: iterator/iter_hints.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_fb9f2b54f370aa6f4de91e34db18da16.html">iterator</a>
</div>
</div>
<div class="contents">
<h1>iter_hints.h File Reference</h1>This file contains functions to assist the iterator module.
<a href="#_details">More...</a>
<p>
<code>#include "<a class="el" href="dnstree_8h.html">util/storage/dnstree.h</a>"</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiter__hints.html">iter_hints</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterator hints structure. <a href="structiter__hints.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiter__hints__stub.html">iter_hints_stub</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterator hints for a particular stub. <a href="structiter__hints__stub.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structiter__hints.html">iter_hints</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="iter__hints_8h.html#f248b52e873bcaca7db8f1b0ffa3c45a">hints_create</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create hints. <a href="#f248b52e873bcaca7db8f1b0ffa3c45a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iter__hints_8h.html#cea0641625f87810b84d5153afda9dae">hints_delete</a> (struct <a class="el" href="structiter__hints.html">iter_hints</a> *hints)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete hints. <a href="#cea0641625f87810b84d5153afda9dae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iter__hints_8h.html#3b88d456a96bcc26daddb362ab0f2984">hints_apply_cfg</a> (struct <a class="el" href="structiter__hints.html">iter_hints</a> *hints, struct <a class="el" href="structconfig__file.html">config_file</a> *cfg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Process hints config. <a href="#3b88d456a96bcc26daddb362ab0f2984"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structdelegpt.html">delegpt</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="iter__hints_8h.html#b30fe2491008f02f382dc809b6260571">hints_lookup_root</a> (struct <a class="el" href="structiter__hints.html">iter_hints</a> *hints, uint16_t qclass)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find root hints for the given class. <a href="#b30fe2491008f02f382dc809b6260571"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structiter__hints__stub.html">iter_hints_stub</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="iter__hints_8h.html#08ae597db759e81ac9969baef559f179">hints_lookup_stub</a> (struct <a class="el" href="structiter__hints.html">iter_hints</a> *hints, uint8_t *qname, uint16_t qclass, struct <a class="el" href="structdelegpt.html">delegpt</a> *dp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Given a qname/qclass combination, and the delegation point from the cache for this qname/qclass, determine if this combination indicates that a stub hint exists and must be primed. <a href="#08ae597db759e81ac9969baef559f179"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="iter__hints_8h.html#a19a7928f7331de6964a07e53206f020">hints_get_mem</a> (struct <a class="el" href="structiter__hints.html">iter_hints</a> *hints)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get memory in use by hints. <a href="#a19a7928f7331de6964a07e53206f020"></a><br></td></tr>
</table>
<hr><h2>Detailed Description</h2>
This file contains functions to assist the iterator module.
<p>
Keep track of stub and root hints, and read those from config. <hr><h2>Function Documentation</h2>
<a class="anchor" name="f248b52e873bcaca7db8f1b0ffa3c45a"></a><!-- doxytag: member="iter_hints.h::hints_create" ref="f248b52e873bcaca7db8f1b0ffa3c45a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structiter__hints.html">iter_hints</a>* hints_create </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create hints.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>new hints or NULL on error. </dd></dl>
<p>References <a class="el" href="iter__hints_8c_source.html#l00067">hints_delete()</a>, <a class="el" href="iter__hints_8h_source.html#l00056">iter_hints::region</a>, and <a class="el" href="regional_8c_source.html#l00061">regional_create()</a>.</p>
<p>Referenced by <a class="el" href="iter__utils_8c_source.html#l00099">iter_apply_cfg()</a>.</p>
</div>
</div><p>
<a class="anchor" name="cea0641625f87810b84d5153afda9dae"></a><!-- doxytag: member="iter_hints.h::hints_delete" ref="cea0641625f87810b84d5153afda9dae" args="(struct iter_hints *hints)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hints_delete </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structiter__hints.html">iter_hints</a> * </td>
<td class="paramname"> <em>hints</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Delete hints.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hints,:</em> </td><td>to delete. </td></tr>
</table>
</dl>
<p>References <a class="el" href="iter__hints_8h_source.html#l00056">iter_hints::region</a>, and <a class="el" href="regional_8c_source.html#l00108">regional_destroy()</a>.</p>
<p>Referenced by <a class="el" href="iter__hints_8c_source.html#l00052">hints_create()</a>, and <a class="el" href="iterator_8c_source.html#l00083">iter_deinit()</a>.</p>
</div>
</div><p>
<a class="anchor" name="3b88d456a96bcc26daddb362ab0f2984"></a><!-- doxytag: member="iter_hints.h::hints_apply_cfg" ref="3b88d456a96bcc26daddb362ab0f2984" args="(struct iter_hints *hints, struct config_file *cfg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hints_apply_cfg </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structiter__hints.html">iter_hints</a> * </td>
<td class="paramname"> <em>hints</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structconfig__file.html">config_file</a> * </td>
<td class="paramname"> <em>cfg</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process hints config.
<p>
Sets default values for root hints if no config. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hints,:</em> </td><td>where to store. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cfg,:</em> </td><td>config options. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on error. </dd></dl>
<p>References <a class="el" href="iter__hints_8c_source.html#l00099">compile_time_root_prime()</a>, <a class="el" href="config__file_8h_source.html#l00069">config_file::do_ip4</a>, <a class="el" href="config__file_8h_source.html#l00071">config_file::do_ip6</a>, <a class="el" href="iter__hints_8c_source.html#l00144">hints_insert()</a>, <a class="el" href="iter__hints_8c_source.html#l00423">hints_lookup_root()</a>, <a class="el" href="dnstree_8c_source.html#l00074">name_tree_init()</a>, <a class="el" href="dnstree_8c_source.html#l00133">name_tree_init_parents()</a>, <a class="el" href="iter__hints_8c_source.html#l00375">read_root_hints_list()</a>, <a class="el" href="iter__hints_8c_source.html#l00238">read_stubs()</a>, <a class="el" href="iter__hints_8h_source.html#l00056">iter_hints::region</a>, <a class="el" href="regional_8c_source.html#l00090">regional_free_all()</a>, <a class="el" href="iter__hints_8h_source.html#l00065">iter_hints::tree</a>, <a class="el" href="log_8h_source.html#l00058">VERB_ALGO</a>, and <a class="el" href="ldns-testpkts_8c.html#a557e5b23b2833d7c1ec0415a1bdd2b1">verbose()</a>.</p>
<p>Referenced by <a class="el" href="iter__utils_8c_source.html#l00099">iter_apply_cfg()</a>.</p>
</div>
</div><p>
<a class="anchor" name="b30fe2491008f02f382dc809b6260571"></a><!-- doxytag: member="iter_hints.h::hints_lookup_root" ref="b30fe2491008f02f382dc809b6260571" args="(struct iter_hints *hints, uint16_t qclass)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structdelegpt.html">delegpt</a>* hints_lookup_root </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structiter__hints.html">iter_hints</a> * </td>
<td class="paramname"> <em>hints</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"> <em>qclass</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find root hints for the given class.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hints,:</em> </td><td>hint storage. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>qclass,:</em> </td><td>class for which root hints are requested. host order. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>: NULL if no hints, or a ptr to stored hints. </dd></dl>
<p>References <a class="el" href="iter__hints_8h_source.html#l00075">iter_hints_stub::dp</a>, <a class="el" href="dnstree_8c_source.html#l00159">name_tree_find()</a>, and <a class="el" href="iter__hints_8h_source.html#l00065">iter_hints::tree</a>.</p>
<p>Referenced by <a class="el" href="iter__hints_8c_source.html#l00394">hints_apply_cfg()</a>, <a class="el" href="iterator_8c_source.html#l00541">prime_root()</a>, and <a class="el" href="iterator_8c_source.html#l00827">processInitRequest()</a>.</p>
</div>
</div><p>
<a class="anchor" name="08ae597db759e81ac9969baef559f179"></a><!-- doxytag: member="iter_hints.h::hints_lookup_stub" ref="08ae597db759e81ac9969baef559f179" args="(struct iter_hints *hints, uint8_t *qname, uint16_t qclass, struct delegpt *dp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structiter__hints__stub.html">iter_hints_stub</a>* hints_lookup_stub </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structiter__hints.html">iter_hints</a> * </td>
<td class="paramname"> <em>hints</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"> <em>qname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"> <em>qclass</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structdelegpt.html">delegpt</a> * </td>
<td class="paramname"> <em>dp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Given a qname/qclass combination, and the delegation point from the cache for this qname/qclass, determine if this combination indicates that a stub hint exists and must be primed.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hints,:</em> </td><td>hint storage. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>qname,:</em> </td><td>The qname that generated the delegation point. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>qclass,:</em> </td><td>The qclass that generated the delegation point. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dp,:</em> </td><td>The cache generated delegation point. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>: A priming delegation point if there is a stub hint that must be primed, otherwise null. </dd></dl>
<p>References <a class="el" href="dname_8c_source.html#l00384">dname_count_size_labels()</a>, <a class="el" href="dname_8c_source.html#l00566">dname_strict_subdomain()</a>, <a class="el" href="iter__hints_8h_source.html#l00075">iter_hints_stub::dp</a>, <a class="el" href="iter__delegpt_8h_source.html#l00059">delegpt::name</a>, <a class="el" href="dnstree_8c_source.html#l00171">name_tree_lookup()</a>, <a class="el" href="iter__delegpt_8h_source.html#l00063">delegpt::namelabs</a>, <a class="el" href="iter__hints_8h_source.html#l00077">iter_hints_stub::noprime</a>, <a class="el" href="dname_8c_source.html#l00096">query_dname_compare()</a>, and <a class="el" href="iter__hints_8h_source.html#l00065">iter_hints::tree</a>.</p>
<p>Referenced by <a class="el" href="iterator_8c_source.html#l00600">prime_stub()</a>.</p>
</div>
</div><p>
<a class="anchor" name="a19a7928f7331de6964a07e53206f020"></a><!-- doxytag: member="iter_hints.h::hints_get_mem" ref="a19a7928f7331de6964a07e53206f020" args="(struct iter_hints *hints)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t hints_get_mem </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structiter__hints.html">iter_hints</a> * </td>
<td class="paramname"> <em>hints</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get memory in use by hints.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hints,:</em> </td><td>hint storage. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>bytes in use </dd></dl>
<p>References <a class="el" href="iter__hints_8h_source.html#l00056">iter_hints::region</a>, and <a class="el" href="regional_8c_source.html#l00214">regional_get_mem()</a>.</p>
<p>Referenced by <a class="el" href="iterator_8c_source.html#l02165">iter_get_mem()</a>.</p>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Oct 13 06:46:30 2009 for unbound by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
550bbe86d83a7870fdddc73c68e5d2b2
>
files
>
173
