/*

[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

#ifndef DNS_FORWARD_H

[11] Fix | Delete

#define DNS_FORWARD_H 1

[12] Fix | Delete

[13] Fix | Delete

/*! \file dns/forward.h */

[14] Fix | Delete

[15] Fix | Delete

#include <isc/lang.h>

[16] Fix | Delete

#include <isc/result.h>

[17] Fix | Delete

#include <isc/sockaddr.h>

[18] Fix | Delete

[19] Fix | Delete

#include <dns/types.h>

[20] Fix | Delete

[21] Fix | Delete

ISC_LANG_BEGINDECLS

[22] Fix | Delete

[23] Fix | Delete

struct dns_forwarder {

[24] Fix | Delete

isc_sockaddr_t addr;

[25] Fix | Delete

isc_dscp_t dscp;

[26] Fix | Delete

ISC_LINK(dns_forwarder_t) link;

[27] Fix | Delete

};

[28] Fix | Delete

[29] Fix | Delete

typedef ISC_LIST(struct dns_forwarder) dns_forwarderlist_t;

[30] Fix | Delete

[31] Fix | Delete

struct dns_forwarders {

[32] Fix | Delete

dns_forwarderlist_t fwdrs;

[33] Fix | Delete

dns_fwdpolicy_t fwdpolicy;

[34] Fix | Delete

};

[35] Fix | Delete

[36] Fix | Delete

isc_result_t

[37] Fix | Delete

dns_fwdtable_create(isc_mem_t *mctx, dns_fwdtable_t **fwdtablep);

[38] Fix | Delete

/*%<

[39] Fix | Delete

* Creates a new forwarding table.

[40] Fix | Delete

*

[41] Fix | Delete

* Requires:

[42] Fix | Delete

* \li mctx is a valid memory context.

[43] Fix | Delete

* \li fwdtablep != NULL && *fwdtablep == NULL

[44] Fix | Delete

*

[45] Fix | Delete

* Returns:

[46] Fix | Delete

* \li #ISC_R_SUCCESS

[47] Fix | Delete

* \li #ISC_R_NOMEMORY

[48] Fix | Delete

*/

[49] Fix | Delete

[50] Fix | Delete

isc_result_t

[51] Fix | Delete

dns_fwdtable_addfwd(dns_fwdtable_t *fwdtable, dns_name_t *name,

[52] Fix | Delete

dns_forwarderlist_t *fwdrs, dns_fwdpolicy_t policy);

[53] Fix | Delete

isc_result_t

[54] Fix | Delete

dns_fwdtable_add(dns_fwdtable_t *fwdtable, dns_name_t *name,

[55] Fix | Delete

isc_sockaddrlist_t *addrs, dns_fwdpolicy_t policy);

[56] Fix | Delete

/*%<

[57] Fix | Delete

* Adds an entry to the forwarding table. The entry associates

[58] Fix | Delete

* a domain with a list of forwarders and a forwarding policy. The

[59] Fix | Delete

* addrs/fwdrs list is copied if not empty, so the caller should free

[60] Fix | Delete

* its copy.

[61] Fix | Delete

*

[62] Fix | Delete

* Requires:

[63] Fix | Delete

* \li fwdtable is a valid forwarding table.

[64] Fix | Delete

* \li name is a valid name

[65] Fix | Delete

* \li addrs/fwdrs is a valid list of isc_sockaddr/dns_forwarder

[66] Fix | Delete

* structures, which may be empty.

[67] Fix | Delete

*

[68] Fix | Delete

* Returns:

[69] Fix | Delete

* \li #ISC_R_SUCCESS

[70] Fix | Delete

* \li #ISC_R_NOMEMORY

[71] Fix | Delete

*/

[72] Fix | Delete

[73] Fix | Delete

isc_result_t

[74] Fix | Delete

dns_fwdtable_delete(dns_fwdtable_t *fwdtable, dns_name_t *name);

[75] Fix | Delete

/*%<

[76] Fix | Delete

* Removes an entry for 'name' from the forwarding table. If an entry

[77] Fix | Delete

* that exactly matches 'name' does not exist, ISC_R_NOTFOUND will be returned.

[78] Fix | Delete

*

[79] Fix | Delete

* Requires:

[80] Fix | Delete

* \li fwdtable is a valid forwarding table.

[81] Fix | Delete

* \li name is a valid name

[82] Fix | Delete

*

[83] Fix | Delete

* Returns:

[84] Fix | Delete

* \li #ISC_R_SUCCESS

[85] Fix | Delete

* \li #ISC_R_NOTFOUND

[86] Fix | Delete

*/

[87] Fix | Delete

[88] Fix | Delete

isc_result_t

[89] Fix | Delete

dns_fwdtable_find(dns_fwdtable_t *fwdtable, dns_name_t *name,

[90] Fix | Delete

dns_forwarders_t **forwardersp);

[91] Fix | Delete

/*%<

[92] Fix | Delete

* Finds a domain in the forwarding table. The closest matching parent

[93] Fix | Delete

* domain is returned.

[94] Fix | Delete

*

[95] Fix | Delete

* Requires:

[96] Fix | Delete

* \li fwdtable is a valid forwarding table.

[97] Fix | Delete

* \li name is a valid name

[98] Fix | Delete

* \li forwardersp != NULL && *forwardersp == NULL

[99] Fix | Delete

*

[100] Fix | Delete

* Returns:

[101] Fix | Delete

* \li #ISC_R_SUCCESS

[102] Fix | Delete

* \li #ISC_R_NOTFOUND

[103] Fix | Delete

*/

[104] Fix | Delete

[105] Fix | Delete

isc_result_t

[106] Fix | Delete

dns_fwdtable_find2(dns_fwdtable_t *fwdtable, dns_name_t *name,

[107] Fix | Delete

dns_name_t *foundname, dns_forwarders_t **forwardersp);

[108] Fix | Delete

/*%<

[109] Fix | Delete

* Finds a domain in the forwarding table. The closest matching parent

[110] Fix | Delete

* domain is returned.

[111] Fix | Delete

*

[112] Fix | Delete

* Requires:

[113] Fix | Delete

* \li fwdtable is a valid forwarding table.

[114] Fix | Delete

* \li name is a valid name

[115] Fix | Delete

* \li forwardersp != NULL && *forwardersp == NULL

[116] Fix | Delete

* \li foundname to be NULL or a valid name with buffer.

[117] Fix | Delete

*

[118] Fix | Delete

* Returns:

[119] Fix | Delete

* \li #ISC_R_SUCCESS

[120] Fix | Delete

* \li #ISC_R_NOTFOUND

[121] Fix | Delete

*/

[122] Fix | Delete

[123] Fix | Delete

void

[124] Fix | Delete

dns_fwdtable_destroy(dns_fwdtable_t **fwdtablep);

[125] Fix | Delete

/*%<

[126] Fix | Delete

* Destroys a forwarding table.

[127] Fix | Delete

*

[128] Fix | Delete

* Requires:

[129] Fix | Delete

* \li fwtablep != NULL && *fwtablep != NULL

[130] Fix | Delete

*

[131] Fix | Delete

* Ensures:

[132] Fix | Delete

* \li all memory associated with the forwarding table is freed.

[133] Fix | Delete

*/

[134] Fix | Delete

[135] Fix | Delete

ISC_LANG_ENDDECLS

[136] Fix | Delete

[137] Fix | Delete

#endif /* DNS_FORWARD_H */

[138] Fix | Delete

[139] Fix | Delete