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
|
/*
*
* (C) 2014-22 - ntop.org
*
*
* 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, write to the Free Software Foundation,
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
*/
#ifndef _RECIPIENTS_
#define _RECIPIENTS_
#include "ntop_includes.h"
class Recipients {
private:
/* Per-recipient queues */
RecipientQueues* recipient_queues[MAX_NUM_RECIPIENTS];
Mutex m;
public:
Recipients();
~Recipients();
/**
* @brief Dequeues a notification from a `recipient_id` queue, given a certain priority
* @param recipient_id An integer recipient identifier
* @param notification The dequeued notification
*
* @return Boolean, true if the dequeue was successful and `notification` is populated correctly, false otherwise
*/
bool dequeue(u_int16_t recipient_id, RecipientNotificationPriority prio, AlertFifoItem *notification);
/**
* @brief Enqueues a notification to a `recipient_id` queue, depending on the priority
* @param recipient_id An integer recipient identifier
* @param prio The priority of the notification
* @param notification The notification to be enqueued
*
* @return True if the enqueue succeeded, false otherwise
*/
bool enqueue(u_int16_t recipient_id, RecipientNotificationPriority prio, const AlertFifoItem* const notification);
/**
* @brief Enqueues a notification to all available recipients
* @param prio The priority of the notification
* @param notification The notification to be enqueued
* @param alert_entity Indicates to enqueue the alert only to recipients responsible for `alert_entity` alerts
*
* @return True if the enqueue succeeded, false otherwise
*/
bool enqueue(RecipientNotificationPriority prio, const AlertFifoItem* const notification, AlertEntity alert_entity);
/**
* @brief Registers a recipient identified with `recipient_id` so its notification can be enqueued/dequeued
* @param recipient_id An integer recipient identifier
* @param minimum_severity The minimum severity for notifications to use this recipient
* @param enabled_categories A bitmap of notification categories to use this recipient
*
* @return
*/
void register_recipient(u_int16_t recipient_id, AlertLevel minimum_severity, u_int8_t enabled_categories);
/**
* @brief Sets all recipients responsible for flow alerts
* @param flow_recipients A bitmap of recipient ids responsible for flows
*
* @return
*/
void set_flow_recipients(u_int64_t flow_recipients);
/**
* @brief Sets all recipients responsible for host alerts
* @param host_recipients A bitmap of recipient ids responsible for hosts
*
* @return
*/
void set_host_recipients(u_int64_t host_recipients);
/**
* @brief Marks a recipient as deleted
* @param recipient_id An integer recipient identifier
*
* @return
*/
void delete_recipient(u_int16_t recipient_id);
/**
* @brief Returns status (drops and uses) of a given recipient
* @param recipient_id An integer recipient identifier
* @param vm A Lua VM instance
*
* @return
*/
void lua(u_int16_t recipient_id, lua_State* vm);
/**
* @brief Returns the last use (i.e., successful dequeue) of a given recipient
* @param recipient_id An integer recipient identifier
*
* @return An epoch with the last use, or 0 if never used.
*/
time_t last_use(u_int16_t recipient_id);
/**
* @brief Checks whether there are notifications queued in any of the recipients
*
* @return true if there are not notifications enqueued, false otherwise
*/
bool empty();
};
#endif /* _RECIPIENTS_ */
|
