forward.h revision 8a713ca49ddddb36e432d4717800f9258a5c2ea9
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington/*
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews * Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
499b34cea04a46823d003d4c0520c8b03e8513cbBrian Wellington * Copyright (C) 2000, 2001 Internet Software Consortium.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Permission to use, copy, modify, and distribute this software for any
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * purpose with or without fee is hereby granted, provided that the above
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * copyright notice and this permission notice appear in all copies.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews * PERFORMANCE OF THIS SOFTWARE.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington */
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
8a713ca49ddddb36e432d4717800f9258a5c2ea9Mark Andrews/* $Id: forward.h,v 1.4 2005/03/16 03:50:47 marka Exp $ */
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington#ifndef DNS_FORWARD_H
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington#define DNS_FORWARD_H 1
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington#include <isc/lang.h>
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington#include <isc/result.h>
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington#include <dns/types.h>
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian WellingtonISC_LANG_BEGINDECLS
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtonstruct dns_forwarders {
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington isc_sockaddrlist_t addrs;
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington dns_fwdpolicy_t fwdpolicy;
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington};
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtonisc_result_t
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtondns_fwdtable_create(isc_mem_t *mctx, dns_fwdtable_t **fwdtablep);
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington/*
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Creates a new forwarding table.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Requires:
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * mctx is a valid memory context.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * fwdtablep != NULL && *fwdtablep == NULL
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Returns:
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * ISC_R_SUCCESS
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * ISC_R_NOMEMORY
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington */
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtonisc_result_t
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtondns_fwdtable_add(dns_fwdtable_t *fwdtable, dns_name_t *name,
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington isc_sockaddrlist_t *addrs, dns_fwdpolicy_t policy);
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington/*
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Adds an entry to the forwarding table. The entry associates
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * a domain with a list of forwarders and a forwarding policy. The
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * addrs list is copied if not empty, so the caller should free its copy.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Requires:
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * fwdtable is a valid forwarding table.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * name is a valid name
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * addrs is a valid list of sockaddrs, which may be empty.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Returns:
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * ISC_R_SUCCESS
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * ISC_R_NOMEMORY
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington */
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtonisc_result_t
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtondns_fwdtable_find(dns_fwdtable_t *fwdtable, dns_name_t *name,
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington dns_forwarders_t **forwardersp);
8a713ca49ddddb36e432d4717800f9258a5c2ea9Mark Andrews
8a713ca49ddddb36e432d4717800f9258a5c2ea9Mark Andrewsisc_result_t
8a713ca49ddddb36e432d4717800f9258a5c2ea9Mark Andrewsdns_fwdtable_find2(dns_fwdtable_t *fwdtable, dns_name_t *name,
8a713ca49ddddb36e432d4717800f9258a5c2ea9Mark Andrews dns_name_t *foundname, dns_forwarders_t **forwardersp);
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington/*
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Finds a domain in the forwarding table. The closest matching parent
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * domain is returned.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Requires:
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * fwdtable is a valid forwarding table.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * name is a valid name
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * forwardersp != NULL && *forwardersp == NULL
8a713ca49ddddb36e432d4717800f9258a5c2ea9Mark Andrews * foundname to be NULL or a valid name with buffer.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Returns:
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * ISC_R_SUCCESS
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * ISC_R_NOTFOUND
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington */
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtonvoid
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellingtondns_fwdtable_destroy(dns_fwdtable_t **fwdtablep);
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington/*
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Destroys a forwarding table.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Requires:
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * fwtablep != NULL && *fwtablep != NULL
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington *
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * Ensures:
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington * all memory associated with the forwarding table is freed.
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington */
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian WellingtonISC_LANG_ENDDECLS
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington
30e6ea9dedbe0738f9729833b1b59042dbebc4dfBrian Wellington#endif /* DNS_FORWARD_H */