qgsnetworkdiskcache.h

Go to the documentation of this file.

/***************************************************************************
 qgsnetworkdiskcache.h  -  Thread-safe interface for QNetworkDiskCache
    -------------------
    begin                : 2016-03-05
    copyright            : (C) 2016 by Juergen E. Fischer
    email                : jef at norbit dot de
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSNETWORKDISKCACHE_H
#define QGSNETWORKDISKCACHE_H
 
 
#include "qgis_core.h"
 
#include <QMutex>
#include <QNetworkDiskCache>
 
#define SIP_NO_FILE
 
class QNetworkDiskCache;

 
class ExpirableNetworkDiskCache : public QNetworkDiskCache
{
    Q_OBJECT
 
  public:
    explicit ExpirableNetworkDiskCache( QObject *parent = nullptr )
      : QNetworkDiskCache( parent )
    {}
    qint64 runExpire() { return QNetworkDiskCache::expire(); }
};


class CORE_EXPORT QgsNetworkDiskCache : public QNetworkDiskCache
{
    Q_OBJECT
 
  public:
    void insertPendingRequestHeaders( const QUrl &url, const QVariantMap &headers );

    bool hasPendingRequestForUrl( const QUrl &url ) const;

    void removePendingRequestForUrl( const QUrl &url ) const;

    bool hasInvalidMatchForRequest( const QNetworkRequest &request );

    QString cacheDirectory() const;

    void setCacheDirectory( const QString &cacheDir );

    qint64 maximumCacheSize() const;

    void setMaximumCacheSize( qint64 size );

    QNetworkCacheMetaData metaData( const QUrl &url ) override;

    void updateMetaData( const QNetworkCacheMetaData &metaData ) override;

    QIODevice *data( const QUrl &url ) override;

    bool remove( const QUrl &url ) override;

    qint64 cacheSize() const override;

    QIODevice *prepare( const QNetworkCacheMetaData &metaData ) override;

    void insert( QIODevice *device ) override;

    QNetworkCacheMetaData fileMetaData( const QString &fileName ) const;

    static qint64 smartCacheSize( const QString &path );
 
  public slots:
    void clear() override;
 
  protected:
    qint64 expire() override;
 
  private:
    explicit QgsNetworkDiskCache( QObject *parent );
 
    static ExpirableNetworkDiskCache sDiskCache;
    static QMutex sDiskCacheMutex;
 
    static QHash<QUrl, QVariantMap> sPendingRequestHeaders;
 
    friend class QgsNetworkAccessManager;
};
 
#endif // QGSNETWORKDISKCACHE_H