1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the QtNetwork module of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    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