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
|
/*******************************************************************************
* shroudBNC - an object-oriented framework for IRC *
* Copyright (C) 2005-2014 Gunnar Beutner *
* *
* 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 2 *
* 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 FLOODCONTROL_H
#define FLOODCONTROL_H
#define FLOODMSG "SBNCFLOODCHECK"
#define FLOODBYTES 1024
/**
* irc_queue_t
*
* A queue which has been attached to a CFloodControl object.
*/
typedef struct queue_s {
int Priority; /**< the priority of the queue (0 = highest) */
CQueue *Queue; /**< the queue object */
} irc_queue_t;
/**
* CFloodControl
*
* A queue which tries to avoid "Excess Flood" errors.
*/
class SBNCAPI CFloodControl {
CVector<irc_queue_t> m_Queues; /**< a list of queues which have been
attached to this object */
size_t m_BytesSent; /**< the number of bytes which have recently been sent */
bool m_Enabled; /**< determines whether this object is delaying the output */
bool m_Plugged; /**< determines whether the queue is plugged */
void ScheduleItem(void);
public:
#ifndef SWIG
CFloodControl(void);
#endif /* SWIG */
RESULT<char *> DequeueItem(bool Peek = false);
int GetQueueSize(void);
void Clear(void);
void AttachInputQueue(CQueue *Queue, int Priority);
int GetRealLength(void) const;
void Plug(void);
void Unplug(void);
void Enable(void);
void Disable(void);
};
#endif /* FLOODCONTROL_H */
|