summaryrefslogtreecommitdiff
path: root/syslogd/backend.h
blob: 5880ee361115d7d6b6c22e2e9cbc59bce377bcae (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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/* SPDX-License-Identifier: GPL-3.0-or-later */
/*
 * Copyright (C) 2018 - David Oberhollenzer
 *
 * 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/>.
 */
#ifndef LOGFILE_H
#define LOGFILE_H

#include "proto.h"

enum {
	/*
	  Rotate log data in a way that we still generate a continuous stream
	  of log data. E.g. in the case of log files, move the current log file
	  to one suffixed with a timestamp. We don't lose any log data.
	 */
	LOG_ROTATE_CONTINUOUS = 0x00,

	/*
	  Rotate log data by overwriting old data with more recent data.
	  E.g. in the case of log files, move the current log file to one
	  with a constant prefix, overwriting any existing data.
	 */
	LOG_ROTATE_OVERWRITE = 0x01,

	/*
	  Automatically do a log rotatation if a log stream reaches a preset
	  size limit.
	 */
	LOG_ROTATE_SIZE_LIMIT = 0x10,
};

typedef struct log_backend_t {
	int (*init)(struct log_backend_t *log, int flags, size_t sizelimit);

	void (*cleanup)(struct log_backend_t *log);

	int (*write)(struct log_backend_t *log, const syslog_msg_t *msg);

	void (*rotate)(struct log_backend_t *log);
} log_backend_t;


extern log_backend_t *logmgr;


#endif /* LOGFILE_H */