mirror of
https://github.com/swift-project/pilotclient.git
synced 2026-03-23 23:45:35 +08:00
5004db1885
The timer is not required by all classes and the deep inheritance makes it hard to see where it is actually used. Use composition instead.
130 lines
4.6 KiB
C++
130 lines
4.6 KiB
C++
// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
|
|
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
|
|
|
|
//! \file
|
|
|
|
#ifndef SWIFT_CORE_THREADED_READER_H
|
|
#define SWIFT_CORE_THREADED_READER_H
|
|
|
|
#include <atomic>
|
|
|
|
#include <QDateTime>
|
|
#include <QObject>
|
|
#include <QPair>
|
|
#include <QReadWriteLock>
|
|
#include <QString>
|
|
#include <QtGlobal>
|
|
|
|
#include "core/swiftcoreexport.h"
|
|
#include "core/vatsim/vatsimsettings.h"
|
|
#include "misc/logcategories.h"
|
|
#include "misc/network/urlloglist.h"
|
|
#include "misc/worker.h"
|
|
|
|
class QNetworkReply;
|
|
class QTimer;
|
|
|
|
namespace swift::core
|
|
{
|
|
//! Support for threaded based reading and parsing tasks such
|
|
//! as data files via http, or file system and parsing (such as FSX models)
|
|
//! Usage: Create a subclass, call start() and dispatch a call to the thread of the reader.
|
|
//! See protected functions for helpers (e.g. doWorkCheck() to check if the work should be continued)
|
|
class SWIFT_CORE_EXPORT CThreadedReader : public swift::misc::CContinuousWorker
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
//! Log categories
|
|
static const QStringList &getLogCategories();
|
|
|
|
//! Destructor
|
|
virtual ~CThreadedReader() = default;
|
|
|
|
//! Thread safe, get update timestamp
|
|
//! \threadsafe
|
|
QDateTime getUpdateTimestamp() const;
|
|
|
|
//! Thread safe, set update timestamp
|
|
//! \threadsafe
|
|
void setUpdateTimestamp(const QDateTime &updateTimestamp = QDateTime::currentDateTimeUtc());
|
|
|
|
//! Is marked as read failed
|
|
//! \threadsafe
|
|
//! \deprecated likely to be removed
|
|
bool isMarkedAsFailed() const;
|
|
|
|
//! Set marker for read failed
|
|
//! \threadsafe
|
|
//! \deprecated 2017-09 likely to be removed, using m_urlReadLog in future
|
|
void setMarkedAsFailed(bool failed);
|
|
|
|
//! Get the read log
|
|
//! \threadsafe
|
|
swift::misc::network::CUrlLogList getReadLog() const;
|
|
|
|
//! Used in unit test
|
|
//! \remark needs to be done before started in different thread
|
|
void markAsUsedInUnitTest() { m_unitTest = true; }
|
|
|
|
//! Get the URL log list
|
|
//! \threadsafe
|
|
swift::misc::network::CUrlLogList getUrlLogList() const;
|
|
|
|
//! Max./current bytes
|
|
QPair<qint64, qint64> getNetworkReplyBytes() const;
|
|
|
|
protected:
|
|
mutable QReadWriteLock m_lock {
|
|
QReadWriteLock::Recursive
|
|
}; //!< lock which can be used from the derived classes
|
|
std::atomic_int m_networkReplyProgress; //!< Progress percentage 0...100
|
|
std::atomic_llong m_networkReplyCurrent; //!< current bytes
|
|
std::atomic_llong m_networkReplyMax; //!< max bytes
|
|
|
|
//! Constructor
|
|
CThreadedReader(QObject *owner, const QString &name);
|
|
|
|
//! When was reply last modified, -1 if N/A
|
|
qint64 lastModifiedMsSinceEpoch(QNetworkReply *nwReply) const;
|
|
|
|
//! Make sure everything runs correctly in own thread
|
|
void threadAssertCheck() const;
|
|
|
|
//! Stores new content hash and returns if content changed (based on hash value
|
|
//! \threadsafe
|
|
bool didContentChange(const QString &content, int startPosition = -1);
|
|
|
|
//! Still enabled etc.?
|
|
//! \threadsafe under normal conditions
|
|
bool doWorkCheck() const;
|
|
|
|
//! Get request from network, and log with m_urlReadLog
|
|
//! \threadsafe read log access is thread safe
|
|
QNetworkReply *getFromNetworkAndLog(const swift::misc::network::CUrl &url,
|
|
const swift::misc::CSlot<void(QNetworkReply *)> &callback);
|
|
|
|
//! Network request progress
|
|
virtual void networkReplyProgress(int logId, qint64 current, qint64 max, const QUrl &url);
|
|
|
|
//! Network reply received, mark in m_urlReadLog
|
|
//! \threadsafe
|
|
void logNetworkReplyReceived(QNetworkReply *reply);
|
|
|
|
//! Use this to log inconsistent data
|
|
//! \remark here in a single function severity / format can be adjusted
|
|
static void logInconsistentData(const swift::misc::CStatusMessage &msg, const char *funcInfo = nullptr);
|
|
|
|
private:
|
|
static constexpr int OutdatedPendingCallMs = 30 * 1000; //!< when is a call considered "outdated"
|
|
|
|
QDateTime m_updateTimestamp; //!< when file/resource was read
|
|
size_t m_contentHash = 0; //!< has of the content given
|
|
std::atomic_bool m_markedAsFailed { false }; //!< marker if reading failed
|
|
bool m_unitTest { false }; //!< mark as unit test
|
|
swift::misc::network::CUrlLogList m_urlReadLog; //!< URL based reading can be logged
|
|
};
|
|
} // namespace swift::core
|
|
|
|
#endif // SWIFT_CORE_THREADED_READER_H
|