2 * Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1999-2002 Internet Software Consortium.
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 * PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: ncache.h,v 1.12.12.5 2004/03/08 09:04:37 marka Exp $ */
21 #define DNS_NCACHE_H 1
33 * The caller must ensure any required synchronization.
36 * No anticipated impact.
42 * No anticipated impact.
49 #include <isc/stdtime.h>
51 #include <dns/types.h>
57 * Omit DNSSEC records when rendering.
59 #define DNS_NCACHETOWIRE_OMITDNSSEC 0x0001
62 dns_ncache_add(dns_message_t *message, dns_db_t *cache, dns_dbnode_t *node,
63 dns_rdatatype_t covers, isc_stdtime_t now, dns_ttl_t maxttl,
64 dns_rdataset_t *addedrdataset);
66 * Convert the authority data from 'message' into a negative cache
67 * rdataset, and store it in 'cache' at 'node' with a TTL limited to
70 * The 'covers' argument is the RR type whose nonexistence we are caching,
71 * or dns_rdatatype_any when caching a NXDOMAIN response.
74 * If 'addedrdataset' is not NULL, then it will be attached to the added
75 * rdataset. See dns_db_addrdataset() for more details.
78 * 'message' is a valid message with a properly formatting negative cache
81 * The requirements of dns_db_addrdataset() apply to 'cache', 'node',
82 * 'now', and 'addedrdataset'.
88 * Any result code of dns_db_addrdataset() is a possible result code
89 * of dns_ncache_add().
93 dns_ncache_towire(dns_rdataset_t *rdataset, dns_compress_t *cctx,
94 isc_buffer_t *target, unsigned int options,
95 unsigned int *countp);
97 * Convert the negative caching rdataset 'rdataset' to wire format,
98 * compressing names as specified in 'cctx', and storing the result in
99 * 'target'. If 'omit_dnssec' is set, DNSSEC records will not
100 * be added to 'target'.
103 * The number of RRs added to target will be added to *countp.
106 * 'rdataset' is a valid negative caching rdataset.
108 * 'rdataset' is not empty.
110 * 'countp' is a valid pointer.
113 * On a return of ISC_R_SUCCESS, 'target' contains a wire format
114 * for the data contained in 'rdataset'. Any error return leaves
115 * the buffer unchanged.
117 * *countp has been incremented by the number of RRs added to
121 * ISC_R_SUCCESS - all ok
122 * ISC_R_NOSPACE - 'target' doesn't have enough room
124 * Any error returned by dns_rdata_towire(), dns_rdataset_next(),
129 dns_ncache_getrdataset(dns_rdataset_t *ncacherdataset, dns_name_t *name,
130 dns_rdatatype_t type, dns_rdataset_t *rdataset);
132 * Search the negative caching rdataset for an rdataset with the
133 * specified name and type.
136 * 'ncacherdataset' is a valid negative caching rdataset.
138 * 'ncacherdataset' is not empty.
140 * 'name' is a valid name.
142 * 'type' is not SIG, or a meta-RR type.
144 * 'rdataset' is a valid disassociated rdataset.
147 * On a return of ISC_R_SUCCESS, 'rdataset' is bound to the found
151 * ISC_R_SUCCESS - the rdataset was found.
152 * ISC_R_NOTFOUND - the rdataset was not found.
158 #endif /* DNS_NCACHE_H */