summaryrefslogtreecommitdiffstats
path: root/src/utils/common/signal.h
blob: 0955c9dc3d3ac9dd38ce960bef67bea68c3d33f7 (plain)
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
/*  Copyright (C) 2023 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 "knot/journal/knot_lmdb.h"

/*!
 * \brief Data passed to the signal handler.
 */
typedef struct {
	knot_lmdb_db_t *close_db; // LMDB database to be closed
	bool color;               // do a terminal color reset
} signal_ctx_t;

/*!
 * \brief Prepares a signal handler for a clean shutdown.
 *
 * \note  Configures common break signals to initiate close of confdb
 *        and of another LMDB database defined by the global variable
 *        signal_ctx_t signal_ctx. If set to NULL, only confdb
 *        is closed.
 */
void signal_init_std(void);