/*

[0] Fix | Delete

* Copyright (C) Internet Systems Consortium, Inc. ("ISC")

[1] Fix | Delete

*

[2] Fix | Delete

* This Source Code Form is subject to the terms of the Mozilla Public

[3] Fix | Delete

* License, v. 2.0. If a copy of the MPL was not distributed with this

[4] Fix | Delete

* file, you can obtain one at https://mozilla.org/MPL/2.0/.

[5] Fix | Delete

*

[6] Fix | Delete

* See the COPYRIGHT file distributed with this work for additional

[7] Fix | Delete

* information regarding copyright ownership.

[8] Fix | Delete

*/

[9] Fix | Delete

[10] Fix | Delete

[11] Fix | Delete

#ifndef DNS_XFRIN_H

[12] Fix | Delete

#define DNS_XFRIN_H 1

[13] Fix | Delete

[14] Fix | Delete

/*****

[15] Fix | Delete

***** Module Info

[16] Fix | Delete

*****/

[17] Fix | Delete

[18] Fix | Delete

/*! \file dns/xfrin.h

[19] Fix | Delete

* \brief

[20] Fix | Delete

* Incoming zone transfers (AXFR + IXFR).

[21] Fix | Delete

*/

[22] Fix | Delete

[23] Fix | Delete

/***

[24] Fix | Delete

*** Imports

[25] Fix | Delete

***/

[26] Fix | Delete

[27] Fix | Delete

#include <isc/lang.h>

[28] Fix | Delete

[29] Fix | Delete

#include <dns/types.h>

[30] Fix | Delete

[31] Fix | Delete

/***

[32] Fix | Delete

*** Types

[33] Fix | Delete

***/

[34] Fix | Delete

[35] Fix | Delete

/*%

[36] Fix | Delete

* A transfer in progress. This is an opaque type.

[37] Fix | Delete

*/

[38] Fix | Delete

typedef struct dns_xfrin_ctx dns_xfrin_ctx_t;

[39] Fix | Delete

[40] Fix | Delete

/***

[41] Fix | Delete

*** Functions

[42] Fix | Delete

***/

[43] Fix | Delete

[44] Fix | Delete

ISC_LANG_BEGINDECLS

[45] Fix | Delete

[46] Fix | Delete

/*% see dns_xfrin_create2() */

[47] Fix | Delete

isc_result_t

[48] Fix | Delete

dns_xfrin_create(dns_zone_t *zone, dns_rdatatype_t xfrtype,

[49] Fix | Delete

isc_sockaddr_t *masteraddr, dns_tsigkey_t *tsigkey,

[50] Fix | Delete

isc_mem_t *mctx, isc_timermgr_t *timermgr,

[51] Fix | Delete

isc_socketmgr_t *socketmgr, isc_task_t *task,

[52] Fix | Delete

dns_xfrindone_t done, dns_xfrin_ctx_t **xfrp);

[53] Fix | Delete

[54] Fix | Delete

isc_result_t

[55] Fix | Delete

dns_xfrin_create2(dns_zone_t *zone, dns_rdatatype_t xfrtype,

[56] Fix | Delete

isc_sockaddr_t *masteraddr, isc_sockaddr_t *sourceaddr,

[57] Fix | Delete

dns_tsigkey_t *tsigkey, isc_mem_t *mctx,

[58] Fix | Delete

isc_timermgr_t *timermgr, isc_socketmgr_t *socketmgr,

[59] Fix | Delete

isc_task_t *task, dns_xfrindone_t done,

[60] Fix | Delete

dns_xfrin_ctx_t **xfrp);

[61] Fix | Delete

[62] Fix | Delete

isc_result_t

[63] Fix | Delete

dns_xfrin_create3(dns_zone_t *zone, dns_rdatatype_t xfrtype,

[64] Fix | Delete

isc_sockaddr_t *masteraddr, isc_sockaddr_t *sourceaddr,

[65] Fix | Delete

isc_dscp_t dscp, dns_tsigkey_t *tsigkey, isc_mem_t *mctx,

[66] Fix | Delete

isc_timermgr_t *timermgr, isc_socketmgr_t *socketmgr,

[67] Fix | Delete

isc_task_t *task, dns_xfrindone_t done,

[68] Fix | Delete

dns_xfrin_ctx_t **xfrp);

[69] Fix | Delete

/*%<

[70] Fix | Delete

* Attempt to start an incoming zone transfer of 'zone'

[71] Fix | Delete

* from 'masteraddr', creating a dns_xfrin_ctx_t object to

[72] Fix | Delete

* manage it. Attach '*xfrp' to the newly created object.

[73] Fix | Delete

*

[74] Fix | Delete

* Iff ISC_R_SUCCESS is returned, '*done' is guaranteed to be

[75] Fix | Delete

* called in the context of 'task', with 'zone' and a result

[76] Fix | Delete

* code as arguments when the transfer finishes.

[77] Fix | Delete

*

[78] Fix | Delete

* Requires:

[79] Fix | Delete

*\li 'xfrtype' is dns_rdatatype_axfr, dns_rdatatype_ixfr

[80] Fix | Delete

* or dns_rdatatype_soa (soa query followed by axfr if

[81] Fix | Delete

* serial is greater than current serial).

[82] Fix | Delete

*

[83] Fix | Delete

*\li If 'xfrtype' is dns_rdatatype_ixfr or dns_rdatatype_soa,

[84] Fix | Delete

* the zone has a database.

[85] Fix | Delete

*/

[86] Fix | Delete

[87] Fix | Delete

void

[88] Fix | Delete

dns_xfrin_shutdown(dns_xfrin_ctx_t *xfr);

[89] Fix | Delete

/*%<

[90] Fix | Delete

* If the zone transfer 'xfr' has already finished,

[91] Fix | Delete

* do nothing. Otherwise, abort it and cause it to call

[92] Fix | Delete

* its done callback with a status of ISC_R_CANCELED.

[93] Fix | Delete

*/

[94] Fix | Delete

[95] Fix | Delete

void

[96] Fix | Delete

dns_xfrin_detach(dns_xfrin_ctx_t **xfrp);

[97] Fix | Delete

/*%<

[98] Fix | Delete

* Detach a reference to a zone transfer object.

[99] Fix | Delete

* Caller to maintain external locking if required.

[100] Fix | Delete

*/

[101] Fix | Delete

[102] Fix | Delete

void

[103] Fix | Delete

dns_xfrin_attach(dns_xfrin_ctx_t *source, dns_xfrin_ctx_t **target);

[104] Fix | Delete

/*%<

[105] Fix | Delete

* Caller to maintain external locking if required.

[106] Fix | Delete

*/

[107] Fix | Delete

[108] Fix | Delete

ISC_LANG_ENDDECLS

[109] Fix | Delete

[110] Fix | Delete

#endif /* DNS_XFRIN_H */

[111] Fix | Delete

[112] Fix | Delete