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
117
118
119
120
121
122
123
124
125
|
/*
*
* (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 _RECIPIENT_QUEUES_
#define _RECIPIENT_QUEUES_
#include "ntop_includes.h"
class RecipientQueues {
private:
AlertFifoQueue *queues_by_prio[RECIPIENT_NOTIFICATION_MAX_NUM_PRIORITIES];
/* Counters for the number of drops occurred when enqueuing */
u_int64_t drops_by_prio[RECIPIENT_NOTIFICATION_MAX_NUM_PRIORITIES];
/* Counters for the number of enqueues */
time_t uses_by_prio[RECIPIENT_NOTIFICATION_MAX_NUM_PRIORITIES];
/* Timestamp of the last dequeue, regardless of queue priority */
time_t last_use;
/* Minimum severity for notifications enqueued to this recipient */
AlertLevel minimum_severity;
/* Only enable enqueue/dequeue for notifications falling into these categories */
u_int8_t enabled_categories; /* MUST be large enough to contain MAX_NUM_SCRIPT_CATEGORIES */
/* Booleans indicating whether this is a flow/host recipient */
bool flow_recipient, host_recipient;
public:
RecipientQueues();
~RecipientQueues();
/**
* @brief Dequeues a notification from a `recipient_id` queue, given a certain priority
* @param prio The priority of the notification
* @param notification The dequeued notification
*
* @return Boolean, true if the dequeue was successful and `notification` is populated correctly, false otherwise
*/
bool dequeue(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 A string containing the notification
*
* @return True if the enqueue succeeded, false otherwise
*/
bool enqueue(RecipientNotificationPriority prio, const AlertFifoItem* const notification);
/**
* @brief Sets the minimum severity for notifications to use this recipient
* @param minimum_severity The minimum severity for notifications to use this recipient
*
* @return
*/
inline void setMinimumSeverity(AlertLevel _minimum_severity) { minimum_severity = _minimum_severity; };
/**
* @brief Sets enabled notification categories to use this recipient
* @param enabled_categories A bitmap of notification categories to use this recipient
*
* @return
*/
inline void setEnabledCategories(u_int8_t _enabled_categories) { enabled_categories = _enabled_categories; };
/**
* @brief Marks/unmarks this recipient as a flow recipient, depending on the input boolean
*
* @return
*/
inline void setFlowRecipient(u_int8_t _enabled) { flow_recipient = _enabled; };
/**
* @brief Marks/unmarks this recipient as a host recipient, depending on the input boolean
*
* @return
*/
inline void setHostRecipient(u_int8_t _enabled) { host_recipient = _enabled; };
/**
* @brief Returns queue status (drops and uses)
* @param vm A Lua VM instance
*
* @return
*/
void lua(lua_State* vm);
/**
* @brief Returns true if the recipient has no notifications enqueued
*
* @return A boolean
*/
bool empty();
/**
* @brief Returns queue last use
*
* @return An epoch with the last use, or 0 if never used.
*/
inline time_t get_last_use() const { return last_use; };
/**
* @brief Returns true if the recipient is a flow recipient
*
* @return A boolean
*/
inline bool isFlowRecipient() const { return flow_recipient; };
/**
* @brief Returns true if the recipient is a host recipient
*
* @return A boolean
*/
inline bool isHostRecipient() const { return host_recipient; };
};
#endif /* _RECIPIENT_QUEUES_ */
|
