Current File : //proc/thread-self/root/proc/thread-self/root/usr/include/bind9/dns/dbtable.h
/*
* Copyright (C) Internet Systems Consortium, Inc. ("ISC")
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, you can obtain one at https://mozilla.org/MPL/2.0/.
*
* See the COPYRIGHT file distributed with this work for additional
* information regarding copyright ownership.
*/
#ifndef DNS_DBTABLE_H
#define DNS_DBTABLE_H 1
/*****
***** Module Info
*****/
/*! \file dns/dbtable.h
* \brief
* DNS DB Tables
*
* XXX TBS XXX
*
* MP:
*\li The module ensures appropriate synchronization of data structures it
* creates and manipulates.
*
* Reliability:
*\li No anticipated impact.
*
* Resources:
*\li None.
*
* Security:
*\li No anticipated impact.
*
* Standards:
*\li None.
*/
#include <isc/lang.h>
#include <dns/types.h>
#define DNS_DBTABLEFIND_NOEXACT 0x01
ISC_LANG_BEGINDECLS
isc_result_t
dns_dbtable_create(isc_mem_t *mctx, dns_rdataclass_t rdclass,
dns_dbtable_t **dbtablep);
/*%<
* Make a new dbtable of class 'rdclass'
*
* Requires:
*\li mctx != NULL
* \li dbtablep != NULL && *dptablep == NULL
*\li 'rdclass' is a valid class
*
* Returns:
*\li #ISC_R_SUCCESS
*\li #ISC_R_NOMEMORY
*\li #ISC_R_UNEXPECTED
*/
void
dns_dbtable_attach(dns_dbtable_t *source, dns_dbtable_t **targetp);
/*%<
* Attach '*targetp' to 'source'.
*
* Requires:
*
*\li 'source' is a valid dbtable.
*
*\li 'targetp' points to a NULL dns_dbtable_t *.
*
* Ensures:
*
*\li *targetp is attached to source.
*/
void
dns_dbtable_detach(dns_dbtable_t **dbtablep);
/*%<
* Detach *dbtablep from its dbtable.
*
* Requires:
*
*\li '*dbtablep' points to a valid dbtable.
*
* Ensures:
*
*\li *dbtablep is NULL.
*
*\li If '*dbtablep' is the last reference to the dbtable,
* all resources used by the dbtable will be freed
*/
isc_result_t
dns_dbtable_add(dns_dbtable_t *dbtable, dns_db_t *db);
/*%<
* Add 'db' to 'dbtable'.
*
* Requires:
*\li 'dbtable' is a valid dbtable.
*
*\li 'db' is a valid database with the same class as 'dbtable'
*/
void
dns_dbtable_remove(dns_dbtable_t *dbtable, dns_db_t *db);
/*%<
* Remove 'db' from 'dbtable'.
*
* Requires:
*\li 'db' was previously added to 'dbtable'.
*/
void
dns_dbtable_adddefault(dns_dbtable_t *dbtable, dns_db_t *db);
/*%<
* Use 'db' as the result of a dns_dbtable_find() if no better match is
* available.
*/
void
dns_dbtable_getdefault(dns_dbtable_t *dbtable, dns_db_t **db);
/*%<
* Get the 'db' used as the result of a dns_dbtable_find()
* if no better match is available.
*/
void
dns_dbtable_removedefault(dns_dbtable_t *dbtable);
/*%<
* Remove the default db from 'dbtable'.
*/
isc_result_t
dns_dbtable_find(dns_dbtable_t *dbtable, dns_name_t *name,
unsigned int options, dns_db_t **dbp);
/*%<
* Find the deepest match to 'name' in the dbtable, and return it
*
* Notes:
*\li If the DNS_DBTABLEFIND_NOEXACT option is set, the best partial
* match (if any) to 'name' will be returned.
*
* Returns:
* \li #ISC_R_SUCCESS on success
*\li something else: no default and match
*/
ISC_LANG_ENDDECLS
#endif /* DNS_DBTABLE_H */
Mini Shell