Communi  3.5.0
A cross-platform IRC framework written with Qt
irccommandqueue.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2008-2016 The Communi Project
3 
4  You may use this file under the terms of BSD license as follows:
5 
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions are met:
8  * Redistributions of source code must retain the above copyright
9  notice, this list of conditions and the following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright
11  notice, this list of conditions and the following disclaimer in the
12  documentation and/or other materials provided with the distribution.
13  * Neither the name of the copyright holder nor the names of its
14  contributors may be used to endorse or promote products derived
15  from this software without specific prior written permission.
16 
17  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR
21  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28 
29 #ifndef IRCCOMMANDQUEUE_H
30 #define IRCCOMMANDQUEUE_H
31 
32 #include <IrcGlobal>
33 #include <QtCore/qobject.h>
34 #include <QtCore/qmetatype.h>
35 #include <QtCore/qscopedpointer.h>
36 
37 IRC_BEGIN_NAMESPACE
38 
39 class IrcConnection;
40 class IrcCommandQueuePrivate;
41 
42 class IRC_UTIL_EXPORT IrcCommandQueue : public QObject
43 {
44  Q_OBJECT
45  Q_PROPERTY(int batch READ batch WRITE setBatch)
46  Q_PROPERTY(int interval READ interval WRITE setInterval)
47  Q_PROPERTY(int size READ size NOTIFY sizeChanged)
48  Q_PROPERTY(IrcConnection* connection READ connection WRITE setConnection)
49 
50 public:
51  explicit IrcCommandQueue(QObject* parent = 0);
52  virtual ~IrcCommandQueue();
53 
54  int batch() const;
55  void setBatch(int batch);
56 
57  int interval() const;
58  void setInterval(int seconds);
59 
60  int size() const;
61 
62  IrcConnection* connection() const;
63  void setConnection(IrcConnection* connection);
64 
65 public Q_SLOTS:
66  void clear();
67  void flush();
68 
69 Q_SIGNALS:
70  void sizeChanged(int size);
71 
72 private:
73  QScopedPointer<IrcCommandQueuePrivate> d_ptr;
74  Q_DECLARE_PRIVATE(IrcCommandQueue)
75  Q_DISABLE_COPY(IrcCommandQueue)
76 
77  Q_PRIVATE_SLOT(d_func(), void _irc_updateTimer())
78  Q_PRIVATE_SLOT(d_func(), void _irc_sendBatch())
79 };
80 
81 IRC_END_NAMESPACE
82 
83 Q_DECLARE_METATYPE(IRC_PREPEND_NAMESPACE(IrcCommandQueue*))
84 
85 #endif // IRCCOMMANDQUEUE_H
Provides a flood protection queue for commands.
Definition: irccommandqueue.h:42
Provides means to establish a connection to an IRC server.
Definition: ircconnection.h:48