unbound/iterator/iter_hints.h

2  * iterator/iter_hints.h - iterative resolver module stub and root hints.
40  * Keep track of stub and root hints, and read those from config.
52  * Iterator hints structure
71  * Iterator hints for a particular stub.
83  * Create hints
84  * @return new hints or NULL on error.
89  * Delete hints.
90  * @param hints: to delete.
92 void hints_delete(struct iter_hints* hints);
95  * Process hints config. Sets default values for root hints if no config.
96  * @param hints: where to store.
100 int hints_apply_cfg(struct iter_hints* hints, struct config_file* cfg);
103  * Find hints for the given class.
104  * The return value is contents of the hints structure.
105  * Caller should lock and unlock a readlock on the hints structure if nolock
107  * Otherwise caller should unlock the readlock on the hints structure if a
109  * @param hints: hint storage.
111  * @param qclass: class for which root hints are requested. host order.
113  * @return: NULL if no hints, or a ptr to stored hints.
115 struct delegpt* hints_find(struct iter_hints* hints, uint8_t* qname,
120  * @param hints: hint storage.
121  * @param qclass: class for which root hints are requested. host order.
123  * @return: NULL if no hints, or a ptr to stored hints.
125 struct delegpt* hints_find_root(struct iter_hints* hints,
129  * Find next root hints (to cycle through all root hints).
131  * should lock and unlock a readlock on the hints structure.
132  * @param hints: hint storage
133  * @param qclass: class for which root hints are sought.
134  * 	0 means give the first available root hints class.
141 int hints_next_root(struct iter_hints* hints, uint16_t* qclass, int nolock);
147  * The return value is contents of the hints structure.
148  * Caller should lock and unlock a readlock on the hints structure if nolock
150  * Otherwise caller should unlock the readlock on the hints structure if a
153  * @param hints: hint storage.
161 struct iter_hints_stub* hints_lookup_stub(struct iter_hints* hints,
165  * Get memory in use by hints
167  * @param hints: hint storage.
170 size_t hints_get_mem(struct iter_hints* hints);
173  * Add stub to hints structure. For external use since it recalcs
176  * should lock and unlock a writelock on the hints structure.
177  * @param hints: the hints data structure
180  *	hints stub. malloced.
185 int hints_add_stub(struct iter_hints* hints, uint16_t c, struct delegpt* dp,
189  * Remove stub from hints structure. For external use since it
192  * should lock and unlock a writelock on the hints structure.
193  * @param hints: the hints data structure
198 void hints_delete_stub(struct iter_hints* hints, uint16_t c,