src/network/access/qnetworkaccesscache_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtNetwork module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QNETWORKACCESSCACHE_P_H
  43 #define QNETWORKACCESSCACHE_P_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists for the convenience
  50 // of the Network Access API.  This header file may change from
  51 // version to version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include "QtCore/qobject.h"
  57 #include "QtCore/qbasictimer.h"
  58 #include "QtCore/qbytearray.h"
  59 #include "QtCore/qhash.h"
  60 #include "QtCore/qmetatype.h"
  61
  62 QT_BEGIN_NAMESPACE
  63
  64 class QNetworkRequest;
  65 class QUrl;
  66
  67 // this class is not about caching files but about
  68 // caching objects used by QNetworkAccessManager, e.g. existing TCP connections
  69 // or credentials.
  70 class QNetworkAccessCache: public QObject
  71 {
  72     Q_OBJECT
  73 public:
  74     struct Node;
  75     typedef QHash<QByteArray, Node> NodeHash;
  76
  77     class CacheableObject
  78     {
  79         friend class QNetworkAccessCache;
  80         QByteArray key;
  81         bool expires;
  82         bool shareable;
  83     public:
  84         CacheableObject();
  85         virtual ~CacheableObject();
  86         virtual void dispose() = 0;
  87         inline QByteArray cacheKey() const { return key; }
  88
  89     protected:
  90         void setExpires(bool enable);
  91         void setShareable(bool enable);
  92     };
  93
  94     QNetworkAccessCache();
  95     ~QNetworkAccessCache();
  96
  97     void clear();
  98
  99     void addEntry(const QByteArray &key, CacheableObject *entry);
 100     bool hasEntry(const QByteArray &key) const;
 101     bool requestEntry(const QByteArray &key, QObject *target, const char *member);
 102     CacheableObject *requestEntryNow(const QByteArray &key);
 103     void releaseEntry(const QByteArray &key);
 104     void removeEntry(const QByteArray &key);
 105
 106 signals:
 107     void entryReady(QNetworkAccessCache::CacheableObject *);
 108
 109 protected:
 110     void timerEvent(QTimerEvent *);
 111
 112 private:
 113     // idea copied from qcache.h
 114     NodeHash hash;
 115     Node *oldest;
 116     Node *newest;
 117
 118     QBasicTimer timer;
 119
 120     void linkEntry(const QByteArray &key);
 121     bool unlinkEntry(const QByteArray &key);
 122     void updateTimer();
 123     bool emitEntryReady(Node *node, QObject *target, const char *member);
 124 };
 125
 126 QT_END_NAMESPACE
 127
 128 Q_DECLARE_METATYPE(QNetworkAccessCache::CacheableObject*)
 129
 130 #endif