/contrib/bind9/lib/dns/include/dns/xfrin.h
https://bitbucket.org/freebsd/freebsd-head/ · C Header · 111 lines · 27 code · 18 blank · 66 comment · 0 complexity · ede901dc6c846955890f5dc231c007fa MD5 · raw file
- /*
- * Copyright (C) 2004-2007, 2009 Internet Systems Consortium, Inc. ("ISC")
- * Copyright (C) 1999-2001, 2003 Internet Software Consortium.
- *
- * Permission to use, copy, modify, and/or distribute this software for any
- * purpose with or without fee is hereby granted, provided that the above
- * copyright notice and this permission notice appear in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
- * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
- * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
- * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- * PERFORMANCE OF THIS SOFTWARE.
- */
- /* $Id: xfrin.h,v 1.30 2009/01/17 23:47:43 tbox Exp $ */
- #ifndef DNS_XFRIN_H
- #define DNS_XFRIN_H 1
- /*****
- ***** Module Info
- *****/
- /*! \file dns/xfrin.h
- * \brief
- * Incoming zone transfers (AXFR + IXFR).
- */
- /***
- *** Imports
- ***/
- #include <isc/lang.h>
- #include <dns/types.h>
- /***
- *** Types
- ***/
- /*%
- * A transfer in progress. This is an opaque type.
- */
- typedef struct dns_xfrin_ctx dns_xfrin_ctx_t;
- /***
- *** Functions
- ***/
- ISC_LANG_BEGINDECLS
- /*% see dns_xfrin_create2() */
- isc_result_t
- dns_xfrin_create(dns_zone_t *zone, dns_rdatatype_t xfrtype,
- isc_sockaddr_t *masteraddr, dns_tsigkey_t *tsigkey,
- isc_mem_t *mctx, isc_timermgr_t *timermgr,
- isc_socketmgr_t *socketmgr, isc_task_t *task,
- dns_xfrindone_t done, dns_xfrin_ctx_t **xfrp);
- isc_result_t
- dns_xfrin_create2(dns_zone_t *zone, dns_rdatatype_t xfrtype,
- isc_sockaddr_t *masteraddr, isc_sockaddr_t *sourceaddr,
- dns_tsigkey_t *tsigkey, isc_mem_t *mctx,
- isc_timermgr_t *timermgr, isc_socketmgr_t *socketmgr,
- isc_task_t *task, dns_xfrindone_t done,
- dns_xfrin_ctx_t **xfrp);
- /*%<
- * Attempt to start an incoming zone transfer of 'zone'
- * from 'masteraddr', creating a dns_xfrin_ctx_t object to
- * manage it. Attach '*xfrp' to the newly created object.
- *
- * Iff ISC_R_SUCCESS is returned, '*done' is guaranteed to be
- * called in the context of 'task', with 'zone' and a result
- * code as arguments when the transfer finishes.
- *
- * Requires:
- *\li 'xfrtype' is dns_rdatatype_axfr, dns_rdatatype_ixfr
- * or dns_rdatatype_soa (soa query followed by axfr if
- * serial is greater than current serial).
- *
- *\li If 'xfrtype' is dns_rdatatype_ixfr or dns_rdatatype_soa,
- * the zone has a database.
- */
- void
- dns_xfrin_shutdown(dns_xfrin_ctx_t *xfr);
- /*%<
- * If the zone transfer 'xfr' has already finished,
- * do nothing. Otherwise, abort it and cause it to call
- * its done callback with a status of ISC_R_CANCELED.
- */
- void
- dns_xfrin_detach(dns_xfrin_ctx_t **xfrp);
- /*%<
- * Detach a reference to a zone transfer object.
- * Caller to maintain external locking if required.
- */
- void
- dns_xfrin_attach(dns_xfrin_ctx_t *source, dns_xfrin_ctx_t **target);
- /*%<
- * Caller to maintain external locking if required.
- */
- ISC_LANG_ENDDECLS
- #endif /* DNS_XFRIN_H */