Happy New Year!
[quassel.git] / src / client / backlogrequester.h
index af7696a..7192aba 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-2015 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -15,7 +15,7 @@
  *   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.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
 #ifndef BACKLOGREQUESTER_H
 
 class ClientBacklogManager;
 
-class BacklogRequester {
+class BacklogRequester
+{
 public:
-  enum RequesterTypes {
-    InvalidRequester = 0,
-    GlobalUnread,
-    PerBufferUnread,
-    PerBufferFixed
-  };
+    enum RequesterType {
+        InvalidRequester = 0,
+        PerBufferFixed,
+        PerBufferUnread,
+        GlobalUnread
+    };
 
-  BacklogRequester(bool buffering, ClientBacklogManager *backlogManger);
-  virtual inline ~BacklogRequester() {}
+    BacklogRequester(bool buffering, RequesterType requesterType, ClientBacklogManager *backlogManger);
+    virtual inline ~BacklogRequester() {}
 
-  inline bool isBuffering() { return _isBuffering; }
-  inline const QList<Message> &bufferedMessages() { return _bufferedMessages; }
+    inline bool isBuffering() { return _isBuffering; }
+    inline RequesterType type() { return _requesterType; }
+    inline const QList<Message> &bufferedMessages() { return _bufferedMessages; }
 
-  //! returns false if it was the last missing backlogpart
-  bool buffer(BufferId bufferId, const MessageList &messages);
-  
-  virtual void requestBacklog() = 0;
+    inline int buffersWaiting() const { return _buffersWaiting.count(); }
+    inline int totalBuffers() const { return _totalBuffers; }
+
+    bool buffer(BufferId bufferId, const MessageList &messages); //! returns false if it was the last missing backlogpart
+
+    virtual void requestBacklog(const BufferIdList &bufferIds) = 0;
+    virtual inline void requestInitialBacklog() { requestBacklog(allBufferIds()); }
+
+    virtual void flushBuffer();
 
 protected:
-  inline QList<BufferId> allBufferIds() const { return Client::networkModel()->allBufferIds(); }
-  inline void setWaitingBuffers(const QList<BufferId> &buffers) { _buffersWaiting = buffers.toSet(); }
-  inline void setWaitingBuffers(const QSet<BufferId> &buffers) { _buffersWaiting = buffers; }
-  inline void addWaitingBuffer(BufferId buffer) { _buffersWaiting << buffer; }
+    BufferIdList allBufferIds() const;
+    inline void setWaitingBuffers(const QList<BufferId> &buffers) { setWaitingBuffers(buffers.toSet()); }
+    void setWaitingBuffers(const QSet<BufferId> &buffers);
+    void addWaitingBuffer(BufferId buffer);
 
-  ClientBacklogManager *backlogManager;
+    ClientBacklogManager *backlogManager;
 
 private:
-  bool _isBuffering;
-  MessageList _bufferedMessages;
-  QSet<BufferId> _buffersWaiting;
+    bool _isBuffering;
+    RequesterType _requesterType;
+    MessageList _bufferedMessages;
+    int _totalBuffers;
+    QSet<BufferId> _buffersWaiting;
 };
 
+
 // ========================================
 //  FIXED BACKLOG REQUESTER
 // ========================================
-class FixedBacklogRequester : public BacklogRequester {
+class FixedBacklogRequester : public BacklogRequester
+{
+public:
+    FixedBacklogRequester(ClientBacklogManager *backlogManager);
+    virtual void requestBacklog(const BufferIdList &bufferIds);
+
+private:
+    int _backlogCount;
+};
+
+
+// ========================================
+//  GLOBAL UNREAD BACKLOG REQUESTER
+// ========================================
+class GlobalUnreadBacklogRequester : public BacklogRequester
+{
+public:
+    GlobalUnreadBacklogRequester(ClientBacklogManager *backlogManager);
+    virtual void requestInitialBacklog();
+    virtual void requestBacklog(const BufferIdList &) {}
+
+private:
+    int _limit;
+    int _additional;
+};
+
+
+// ========================================
+//  PER BUFFER UNREAD BACKLOG REQUESTER
+// ========================================
+class PerBufferUnreadBacklogRequester : public BacklogRequester
+{
 public:
-  FixedBacklogRequester(ClientBacklogManager *backlogManager);
-  virtual void requestBacklog();
+    PerBufferUnreadBacklogRequester(ClientBacklogManager *backlogManager);
+    virtual void requestBacklog(const BufferIdList &bufferIds);
 
 private:
-  int _backlogCount;
+    int _limit;
+    int _additional;
 };