2 * Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1999-2001, 2003 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: master.h,v 1.31.2.4 2004/03/09 06:11:17 marka Exp $ */
21 #define DNS_MASTER_H 1
31 #include <dns/types.h>
34 * Flags to be passed in the 'options' argument in the functions below.
36 #define DNS_MASTER_AGETTL 0x00000001 /* Age the ttl based on $DATE. */
37 #define DNS_MASTER_MANYERRORS 0x00000002 /* Continue processing on errors. */
38 #define DNS_MASTER_NOINCLUDE 0x00000004 /* Disallow $INCLUDE directives. */
39 #define DNS_MASTER_ZONE 0x00000008 /* Loading a zone master file. */
40 #define DNS_MASTER_SLAVE 0x00000020 /* Loading a slave master file. */
49 dns_master_loadfile(const char *master_file,
52 dns_rdataclass_t zclass,
54 dns_rdatacallbacks_t *callbacks,
58 dns_master_loadstream(FILE *stream,
61 dns_rdataclass_t zclass,
63 dns_rdatacallbacks_t *callbacks,
67 dns_master_loadbuffer(isc_buffer_t *buffer,
70 dns_rdataclass_t zclass,
72 dns_rdatacallbacks_t *callbacks,
76 dns_master_loadfileinc(const char *master_file,
79 dns_rdataclass_t zclass,
81 dns_rdatacallbacks_t *callbacks,
83 dns_loaddonefunc_t done, void *done_arg,
84 dns_loadctx_t **ctxp, isc_mem_t *mctx);
87 dns_master_loadstreaminc(FILE *stream,
90 dns_rdataclass_t zclass,
92 dns_rdatacallbacks_t *callbacks,
94 dns_loaddonefunc_t done, void *done_arg,
95 dns_loadctx_t **ctxp, isc_mem_t *mctx);
98 dns_master_loadbufferinc(isc_buffer_t *buffer,
101 dns_rdataclass_t zclass,
102 unsigned int options,
103 dns_rdatacallbacks_t *callbacks,
105 dns_loaddonefunc_t done, void *done_arg,
106 dns_loadctx_t **ctxp, isc_mem_t *mctx);
109 * Loads a RFC 1305 master file from a file, stream, or buffer into rdatasets
110 * and then calls 'callbacks->commit' to commit the rdatasets. Rdata memory
111 * belongs to dns_master_load and will be reused / released when the callback
112 * completes. dns_load_master will abort if callbacks->commit returns
113 * any value other than ISC_R_SUCCESS.
115 * If 'DNS_MASTER_AGETTL' is set and the master file contains one or more
116 * $DATE directives, the TTLs of the data will be aged accordingly.
118 * 'callbacks->commit' is assumed to call 'callbacks->error' or
119 * 'callbacks->warn' to generate any error messages required.
121 * 'done' is called with 'done_arg' and a result code when the loading
122 * is completed or has failed. If the initial setup fails 'done' is
126 * 'master_file' points to a valid string.
127 * 'top' points to a valid name.
128 * 'origin' points to a valid name.
129 * 'callbacks->commit' points to a valid function.
130 * 'callbacks->error' points to a valid function.
131 * 'callbacks->warn' points to a valid function.
132 * 'mctx' points to a valid memory context.
133 * 'task' and 'done' to be valid.
134 * 'lmgr' to be valid.
135 * 'ctxp != NULL && ctxp == NULL'.
138 * ISC_R_SUCCESS upon successfully loading the master file.
139 * ISC_R_SEENINCLUDE upon successfully loading the master file with
140 * a $INCLUDE statement.
141 * ISC_R_NOMEMORY out of memory.
142 * ISC_R_UNEXPECTEDEND expected to be able to read a input token and
145 * DNS_R_NOOWNER failed to specify a ownername.
146 * DNS_R_NOTTL failed to specify a ttl.
147 * DNS_R_BADCLASS record class did not match zone class.
148 * DNS_R_CONTINUE load still in progress (dns_master_load*inc() only).
149 * Any dns_rdata_fromtext() error code.
150 * Any error code from callbacks->commit().
154 dns_loadctx_detach(dns_loadctx_t **ctxp);
156 * Detach from the load context.
159 * '*ctxp' to be valid.
166 dns_loadctx_attach(dns_loadctx_t *source, dns_loadctx_t **target);
168 * Attach to the load context.
171 * 'source' to be valid.
172 * 'target != NULL && *target == NULL'.
176 dns_loadctx_cancel(dns_loadctx_t *ctx);
178 * Cancel loading the zone file associated with this load context.
186 #endif /* DNS_MASTER_H */