src/client/backlogrequester.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 by the Quassel Project                          *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef BACKLOGREQUESTER_H
  22 #define BACKLOGREQUESTER_H
  23
  24 #include <QList>
  25
  26 #include "client.h"
  27 #include "message.h"
  28 #include "networkmodel.h"
  29 #include "types.h"
  30
  31 class ClientBacklogManager;
  32
  33 class BacklogRequester {
  34 public:
  35   enum RequesterTypes {
  36     InvalidRequester = 0,
  37     PerBufferFixed,
  38     PerBufferUnread,
  39     GlobalUnread
  40   };
  41
  42   BacklogRequester(bool buffering, ClientBacklogManager *backlogManger);
  43   virtual inline ~BacklogRequester() {}
  44
  45   inline bool isBuffering() { return _isBuffering; }
  46   inline const QList<Message> &bufferedMessages() { return _bufferedMessages; }
  47
  48   inline int buffersWaiting() const { return _buffersWaiting.count(); }
  49   inline int totalBuffers() const { return _totalBuffers; }
  50   //! returns false if it was the last missing backlogpart
  51   bool buffer(BufferId bufferId, const MessageList &messages);
  52
  53   virtual void requestBacklog() = 0;
  54
  55 protected:
  56   inline QList<BufferId> allBufferIds() const { return Client::networkModel()->allBufferIds(); }
  57   inline void setWaitingBuffers(const QList<BufferId> &buffers) { setWaitingBuffers(buffers.toSet()); }
  58   void setWaitingBuffers(const QSet<BufferId> &buffers);
  59   void addWaitingBuffer(BufferId buffer);
  60
  61   ClientBacklogManager *backlogManager;
  62
  63 private:
  64   bool _isBuffering;
  65   MessageList _bufferedMessages;
  66   int _totalBuffers;
  67   QSet<BufferId> _buffersWaiting;
  68 };
  69
  70 // ========================================
  71 //  FIXED BACKLOG REQUESTER
  72 // ========================================
  73 class FixedBacklogRequester : public BacklogRequester {
  74 public:
  75   FixedBacklogRequester(ClientBacklogManager *backlogManager);
  76   virtual void requestBacklog();
  77
  78 private:
  79   int _backlogCount;
  80 };
  81
  82 // ========================================
  83 //  GLOBAL UNREAD BACKLOG REQUESTER
  84 // ========================================
  85 class GlobalUnreadBacklogRequester : public BacklogRequester {
  86 public:
  87   GlobalUnreadBacklogRequester(ClientBacklogManager *backlogManager);
  88   virtual void requestBacklog();
  89
  90 private:
  91   int _limit;
  92   int _additional;
  93 };
  94
  95 // ========================================
  96 //  PER BUFFER UNREAD BACKLOG REQUESTER
  97 // ========================================
  98 class PerBufferUnreadBacklogRequester : public BacklogRequester {
  99 public:
 100   PerBufferUnreadBacklogRequester(ClientBacklogManager *backlogManager);
 101   virtual void requestBacklog();
 102
 103 private:
 104   int _limit;
 105   int _additional;
 106 };
 107
 108 #endif //BACKLOGREQUESTER_H