control.h 2.83 KB
Newer Older
Brian Wellington's avatar
Brian Wellington committed
1
/*
Mark Andrews's avatar
Mark Andrews committed
2
 * Copyright (C) 2004-2006  Internet Systems Consortium, Inc. ("ISC")
Mark Andrews's avatar
Mark Andrews committed
3
 * Copyright (C) 2001-2003  Internet Software Consortium.
Brian Wellington's avatar
Brian Wellington committed
4 5 6 7 8
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
Mark Andrews's avatar
Mark Andrews committed
9 10 11 12 13 14 15
 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
Brian Wellington's avatar
Brian Wellington committed
16 17
 */

18
/* $Id: control.h,v 1.23 2006/12/04 01:52:45 marka Exp $ */
Brian Wellington's avatar
Brian Wellington committed
19

Brian Wellington's avatar
Brian Wellington committed
20 21 22
#ifndef NAMED_CONTROL_H
#define NAMED_CONTROL_H 1

23 24
/*! \file
 * \brief
25 26 27
 * The name server command channel.
 */

Brian Wellington's avatar
Brian Wellington committed
28 29
#include <isccc/types.h>

30 31
#include <isccfg/aclconf.h>

32
#include <named/types.h>
Brian Wellington's avatar
Brian Wellington committed
33 34 35 36 37 38

#define NS_CONTROL_PORT			953

#define NS_COMMAND_STOP		"stop"
#define NS_COMMAND_HALT		"halt"
#define NS_COMMAND_RELOAD	"reload"
39
#define NS_COMMAND_RECONFIG	"reconfig"
Brian Wellington's avatar
Brian Wellington committed
40
#define NS_COMMAND_REFRESH	"refresh"
41
#define NS_COMMAND_RETRANSFER	"retransfer"
Brian Wellington's avatar
Brian Wellington committed
42 43 44 45 46
#define NS_COMMAND_DUMPSTATS	"stats"
#define NS_COMMAND_QUERYLOG	"querylog"
#define NS_COMMAND_DUMPDB	"dumpdb"
#define NS_COMMAND_TRACE	"trace"
#define NS_COMMAND_NOTRACE	"notrace"
47
#define NS_COMMAND_FLUSH	"flush"
48
#define NS_COMMAND_FLUSHNAME	"flushname"
49
#define NS_COMMAND_STATUS	"status"
50 51
#define NS_COMMAND_TSIGLIST	"tsig-list"
#define NS_COMMAND_TSIGDELETE	"tsig-delete"
52 53
#define NS_COMMAND_FREEZE	"freeze"
#define NS_COMMAND_UNFREEZE	"unfreeze"
54
#define NS_COMMAND_THAW		"thaw"
55
#define NS_COMMAND_TIMERPOKE	"timerpoke"
56
#define NS_COMMAND_RECURSING	"recursing"
57
#define NS_COMMAND_NULL		"null"
58
#define NS_COMMAND_NOTIFY	"notify"
59
#define NS_COMMAND_VALIDATION	"validation"
Brian Wellington's avatar
Brian Wellington committed
60 61

isc_result_t
62
ns_controls_create(ns_server_t *server, ns_controls_t **ctrlsp);
63
/*%<
64 65 66 67 68
 * Create an initial, empty set of command channels for 'server'.
 */

void
ns_controls_destroy(ns_controls_t **ctrlsp);
69
/*%<
70 71 72 73 74
 * Destroy a set of command channels.
 *
 * Requires:
 *	Shutdown of the channels has completed.
 */
Brian Wellington's avatar
Brian Wellington committed
75 76

isc_result_t
77
ns_controls_configure(ns_controls_t *controls, const cfg_obj_t *config,
78
		      cfg_aclconfctx_t *aclconfctx);
79
/*%<
80 81 82 83 84
 * Configure zero or more command channels into 'controls'
 * as defined in the configuration parse tree 'config'.
 * The channels will evaluate ACLs in the context of
 * 'aclconfctx'.
 */
Brian Wellington's avatar
Brian Wellington committed
85 86

void
87
ns_controls_shutdown(ns_controls_t *controls);
88
/*%<
89 90
 * Initiate shutdown of all the command channels in 'controls'.
 */
Brian Wellington's avatar
Brian Wellington committed
91 92

isc_result_t
93
ns_control_docommand(isccc_sexpr_t *message, isc_buffer_t *text);
Brian Wellington's avatar
Brian Wellington committed
94 95

#endif /* NAMED_CONTROL_H */