/contrib/bind9/bin/named/include/named/listenlist.h

  1/*
  2 * Copyright (C) 2004, 2005, 2007  Internet Systems Consortium, Inc. ("ISC")
  3 * Copyright (C) 2000, 2001  Internet Software Consortium.
  4 *
  5 * Permission to use, copy, modify, and/or distribute this software for any
  6 * purpose with or without fee is hereby granted, provided that the above
  7 * copyright notice and this permission notice appear in all copies.
  8 *
  9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 11 * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 15 * PERFORMANCE OF THIS SOFTWARE.
 16 */
 17
 18/* $Id: listenlist.h,v 1.15 2007/06/19 23:46:59 tbox Exp $ */
 19
 20#ifndef NAMED_LISTENLIST_H
 21#define NAMED_LISTENLIST_H 1
 22
 23/*****
 24 ***** Module Info
 25 *****/
 26
 27/*! \file
 28 * \brief
 29 * "Listen lists", as in the "listen-on" configuration statement.
 30 */
 31
 32/***
 33 *** Imports
 34 ***/
 35#include <isc/net.h>
 36
 37#include <dns/types.h>
 38
 39/***
 40 *** Types
 41 ***/
 42
 43typedef struct ns_listenelt ns_listenelt_t;
 44typedef struct ns_listenlist ns_listenlist_t;
 45
 46struct ns_listenelt {
 47	isc_mem_t *	       		mctx;
 48	in_port_t			port;
 49	dns_acl_t *	       		acl;
 50	ISC_LINK(ns_listenelt_t)	link;
 51};
 52
 53struct ns_listenlist {
 54	isc_mem_t *			mctx;
 55	int				refcount;
 56	ISC_LIST(ns_listenelt_t)	elts;
 57};
 58
 59/***
 60 *** Functions
 61 ***/
 62
 63isc_result_t
 64ns_listenelt_create(isc_mem_t *mctx, in_port_t port,
 65		    dns_acl_t *acl, ns_listenelt_t **target);
 66/*%
 67 * Create a listen-on list element.
 68 */
 69
 70void
 71ns_listenelt_destroy(ns_listenelt_t *elt);
 72/*%
 73 * Destroy a listen-on list element.
 74 */
 75
 76isc_result_t
 77ns_listenlist_create(isc_mem_t *mctx, ns_listenlist_t **target);
 78/*%
 79 * Create a new, empty listen-on list.
 80 */
 81
 82void
 83ns_listenlist_attach(ns_listenlist_t *source, ns_listenlist_t **target);
 84/*%
 85 * Attach '*target' to '*source'.
 86 */
 87
 88void
 89ns_listenlist_detach(ns_listenlist_t **listp);
 90/*%
 91 * Detach 'listp'.
 92 */
 93
 94isc_result_t
 95ns_listenlist_default(isc_mem_t *mctx, in_port_t port,
 96		      isc_boolean_t enabled, ns_listenlist_t **target);
 97/*%
 98 * Create a listen-on list with default contents, matching
 99 * all addresses with port 'port' (if 'enabled' is ISC_TRUE),
100 * or no addresses (if 'enabled' is ISC_FALSE).
101 */
102
103#endif /* NAMED_LISTENLIST_H */
104
105