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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
/* 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/>.
*/
/*!
* \file
*
* \brief A DNS traffic probe interface.
*
* \addtogroup probe
* @{
*/
#pragma once
#include "libknot/probe/data.h"
/*! A probe context. */
struct knot_probe;
typedef struct knot_probe knot_probe_t;
/*!
* Allocates a probe context.
*
* \return Probe context.
*/
knot_probe_t *knot_probe_alloc(void);
/*!
* \brief Deallocates a probe.
*
* \param probe Probe context.
*/
void knot_probe_free(knot_probe_t *probe);
/*!
* \brief Initializes one probe producer.
*
* \param probe Probe context.
* \param dir Unix socket directory.
* \param idx Probe ID (counted from 1).
*
* \retval KNOT_EOK Success.
* \retval KNOT_ECONN Initial connection failed.
* \return KNOT_E* If error.
*/
int knot_probe_set_producer(knot_probe_t *probe, const char *dir, uint16_t idx);
/*!
* \brief Initializes one probe consumer.
*
* \note The socket permissions are set to 0222!
*
* \param probe Probe context.
* \param dir Unix socket directory.
* \param idx Probe ID (counted from 1).
*
* \retval KNOT_EOK Success.
* \return KNOT_E* If error.
*/
int knot_probe_set_consumer(knot_probe_t *probe, const char *dir, uint16_t idx);
/*!
* \brief Returns file descriptor of the probe.
*
* \param probe Probe context.
*/
int knot_probe_fd(knot_probe_t *probe);
/*!
* \brief Sends data units to a probe.
*
* \note Data arrays of length > 1 are not supported yet.
*
* If send fails due to unconnected socket anf if not connected for at least
* 2 seconds, reconnection is attempted and if successful, the send operation
* is repeated.
*
* \param probe Probe context.
* \param data Array of data units.
* \param count Length of data unit array.
*
* \retval KNOT_EOK Success.
* \return KNOT_E* If error.
*/
int knot_probe_produce(knot_probe_t *probe, const knot_probe_data_t *data, uint8_t count);
/*!
* \brief Receives data units from a probe.
*
* This function blocks on poll until a data unit is received or timeout is hit.
*
* \param probe Probe context.
* \param data Array of data units.
* \param count Length of data unit array.
* \param timeout_ms Poll timeout in milliseconds (-1 means infinity).
*
* \retval >= 0 Number of data units received.
* \return KNOT_E* If error.
*/
int knot_probe_consume(knot_probe_t *probe, knot_probe_data_t *data, uint8_t count,
int timeout_ms);
/*! @} */
|
