File indexing completed on 2024-11-24 04:53:12

0001 /* Copyright (C) 2006 - 2014 Jan Kundrát <jkt@flaska.net>
0002 
0003    This file is part of the Trojita Qt IMAP e-mail client,
0004    http://trojita.flaska.net/
0005 
0006    This program is free software; you can redistribute it and/or
0007    modify it under the terms of the GNU General Public License as
0008    published by the Free Software Foundation; either version 2 of
0009    the License or (at your option) version 3 or any later version
0010    accepted by the membership of KDE e.V. (or its successor approved
0011    by the membership of KDE e.V.), which shall act as a proxy
0012    defined in Section 14 of version 3 of the license.
0013 
0014    This program is distributed in the hope that it will be useful,
0015    but WITHOUT ANY WARRANTY; without even the implied warranty of
0016    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0017    GNU General Public License for more details.
0018 
0019    You should have received a copy of the GNU General Public License
0020    along with this program.  If not, see <http://www.gnu.org/licenses/>.
0021 */
0022 
0023 #ifndef TROJITA_IMAP_NETWORKWATCHER_H
0024 #define TROJITA_IMAP_NETWORKWATCHER_H
0025 
0026 #include <QObject>
0027 #include "Imap/ConnectionState.h"
0028 #include "Imap/Model/NetworkPolicy.h"
0029 
0030 class QTimer;
0031 
0032 namespace Imap {
0033 class ImapAccess;
0034 namespace Mailbox {
0035 class Model;
0036 
0037 const int MIN_RECONNECT_TIMEOUT = 5*1000;
0038 const int MAX_RECONNECT_TIMEOUT = 5*60*1000;
0039 
0040 /** @short Provide network session management to the Model */
0041 class NetworkWatcher: public QObject
0042 {
0043     Q_OBJECT
0044 public:
0045     NetworkWatcher(ImapAccess *parent, Model *model);
0046 
0047     NetworkPolicy desiredNetworkPolicy() const;
0048     NetworkPolicy effectiveNetworkPolicy() const;
0049 
0050 public slots:
0051     virtual void setNetworkOffline();
0052     virtual void setNetworkExpensive();
0053     virtual void setNetworkOnline();
0054 
0055 signals:
0056     void effectiveNetworkPolicyChanged();
0057     void reconnectAttemptScheduled(const int timeout);
0058     void resetReconnectState();
0059     void desiredNetworkPolicyChanged(const Imap::Mailbox::NetworkPolicy policy);
0060 
0061 protected:
0062     virtual void setDesiredNetworkPolicy(const NetworkPolicy policy) = 0;
0063     ImapAccess *m_imapAccess;
0064     Model *m_model;
0065     NetworkPolicy m_desiredPolicy;
0066 
0067 protected slots:
0068     void attemptReconnect();
0069     void tryReconnect();
0070     void handleConnectionStateChanged(uint parserId, Imap::ConnectionState state);
0071 
0072 protected:
0073     void resetReconnectTimer();
0074 
0075     /** @short Single shot timer to trigger reconnect attempts with time-outs */
0076     QTimer *m_reconnectTimer;
0077 };
0078 
0079 }
0080 }
0081 
0082 #endif