src/Imap/Model/NetworkWatcher.h

   1 /* Copyright (C) 2006 - 2014 Jan Kundrát <jkt@flaska.net>
   2
   3    This file is part of the Trojita Qt IMAP e-mail client,
   4    http://trojita.flaska.net/
   5
   6    This program is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU General Public License as
   8    published by the Free Software Foundation; either version 2 of
   9    the License or (at your option) version 3 or any later version
  10    accepted by the membership of KDE e.V. (or its successor approved
  11    by the membership of KDE e.V.), which shall act as a proxy
  12    defined in Section 14 of version 3 of the license.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #ifndef TROJITA_IMAP_NETWORKWATCHER_H
  24 #define TROJITA_IMAP_NETWORKWATCHER_H
  25
  26 #include <QObject>
  27 #include "Imap/ConnectionState.h"
  28 #include "Imap/Model/NetworkPolicy.h"
  29
  30 class QTimer;
  31
  32 namespace Imap {
  33 class ImapAccess;
  34 namespace Mailbox {
  35 class Model;
  36
  37 const int MIN_RECONNECT_TIMEOUT = 5*1000;
  38 const int MAX_RECONNECT_TIMEOUT = 5*60*1000;
  39
  40 /** @short Provide network session management to the Model */
  41 class NetworkWatcher: public QObject
  42 {
  43     Q_OBJECT
  44 public:
  45     NetworkWatcher(ImapAccess *parent, Model *model);
  46
  47     NetworkPolicy desiredNetworkPolicy() const;
  48     NetworkPolicy effectiveNetworkPolicy() const;
  49
  50 public slots:
  51     virtual void setNetworkOffline();
  52     virtual void setNetworkExpensive();
  53     virtual void setNetworkOnline();
  54
  55 signals:
  56     void effectiveNetworkPolicyChanged();
  57     void reconnectAttemptScheduled(const int timeout);
  58     void resetReconnectState();
  59     void desiredNetworkPolicyChanged(const Imap::Mailbox::NetworkPolicy policy);
  60
  61 protected:
  62     virtual void setDesiredNetworkPolicy(const NetworkPolicy policy) = 0;
  63     ImapAccess *m_imapAccess;
  64     Model *m_model;
  65     NetworkPolicy m_desiredPolicy;
  66
  67 protected slots:
  68     void attemptReconnect();
  69     void tryReconnect();
  70     void handleConnectionStateChanged(uint parserId, Imap::ConnectionState state);
  71
  72 protected:
  73     void resetReconnectTimer();
  74
  75     /** @short Single shot timer to trigger reconnect attempts with time-outs */
  76     QTimer *m_reconnectTimer;
  77 };
  78
  79 }
  80 }
  81
  82 #endif