2 * Copyright (C) 2004, 2006 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: xfrin.h,v 1.18.136.4 2006/07/20 01:10:29 marka Exp $ */
28 * Incoming zone transfers (AXFR + IXFR).
37 #include <dns/types.h>
44 * A transfer in progress. This is an opaque type.
46 typedef struct dns_xfrin_ctx dns_xfrin_ctx_t;
55 dns_xfrin_create(dns_zone_t *zone, dns_rdatatype_t xfrtype,
56 isc_sockaddr_t *masteraddr, dns_tsigkey_t *tsigkey,
57 isc_mem_t *mctx, isc_timermgr_t *timermgr,
58 isc_socketmgr_t *socketmgr, isc_task_t *task,
59 dns_xfrindone_t done, dns_xfrin_ctx_t **xfrp);
62 dns_xfrin_create2(dns_zone_t *zone, dns_rdatatype_t xfrtype,
63 isc_sockaddr_t *masteraddr, isc_sockaddr_t *sourceaddr,
64 dns_tsigkey_t *tsigkey, isc_mem_t *mctx,
65 isc_timermgr_t *timermgr, isc_socketmgr_t *socketmgr,
66 isc_task_t *task, dns_xfrindone_t done,
67 dns_xfrin_ctx_t **xfrp);
69 * Attempt to start an incoming zone transfer of 'zone'
70 * from 'masteraddr', creating a dns_xfrin_ctx_t object to
71 * manage it. Attach '*xfrp' to the newly created object.
73 * Iff ISC_R_SUCCESS is returned, '*done' is guaranteed to be
74 * called in the context of 'task', with 'zone' and a result
75 * code as arguments when the transfer finishes.
78 * 'xfrtype' is dns_rdatatype_axfr, dns_rdatatype_ixfr
79 * or dns_rdatatype_soa (soa query followed by axfr if
80 * serial is greater than current serial).
82 * If 'xfrtype' is dns_rdatatype_ixfr or dns_rdatatype_soa,
83 * the zone has a database.
87 dns_xfrin_shutdown(dns_xfrin_ctx_t *xfr);
89 * If the zone transfer 'xfr' has already finished,
90 * do nothing. Otherwise, abort it and cause it to call
91 * its done callback with a status of ISC_R_CANCELLED.
95 dns_xfrin_detach(dns_xfrin_ctx_t **xfrp);
97 * Detach a reference to a zone transfer object.
98 * Caller to maintain external locking if required.
102 dns_xfrin_attach(dns_xfrin_ctx_t *source, dns_xfrin_ctx_t **target);
104 * Caller to maintain external locking if required.
109 #endif /* DNS_XFRIN_H */