1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
/* Copyright (C) 2022 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#pragma once
#include "utils/knotc/commands.h"
#define DEFAULT_CTL_TIMEOUT_MS (60 * 1000)
/*! Utility command line parameters. */
typedef struct {
const char *orig_config;
const char *orig_confdb;
const char *config;
const char *confdb;
size_t max_conf_size;
const char *socket;
bool verbose;
bool extended;
bool force;
bool blocking;
int timeout;
bool color;
bool color_force;
} params_t;
/*!
* Prepares a proper configuration according to the specified command.
*
* \param[in] desc Utility command descriptor.
* \param[in] params Utility parameters.
*
* \return Error code, KNOT_EOK if successful.
*/
int set_config(const cmd_desc_t *desc, params_t *params);
/*!
* Establishes a control interface if necessary.
*
* \param[in] ctl Control context.
* \param[in] socket Control socket path.
* \param[in] timeout Control socket timeout.
* \param[in] desc Utility command descriptor.
*
* \return Error code, KNOT_EOK if successful.
*/
int set_ctl(knot_ctl_t **ctl, const char *socket, int timeout, const cmd_desc_t *desc);
/*!
* Cleans up the control context.
*
* \param[in] ctl Control context.
*/
void unset_ctl(knot_ctl_t *ctl);
/*!
* Processes the given utility command.
*
* \param[in] argc Number of command arguments.
* \param[in] argv Command arguments.
* \param[in] params Utility parameters.
*
* \return Error code, KNOT_EOK if successful.
*/
int process_cmd(int argc, const char **argv, params_t *params);
|
