QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
qgsnetworkaccessmanager.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsnetworkaccessmanager.h - description
3  -------------------
4  begin : 2010-05-08
5  copyright : (C) 2010 by Juergen E. Fischer
6  email : jef at norbit dot de
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSNETWORKACCESSMANAGER_H
19 #define QGSNETWORKACCESSMANAGER_H
20 
21 #include <QList>
22 #include <QStringList>
23 #include <QNetworkAccessManager>
24 #include <QNetworkProxy>
25 #include <QNetworkRequest>
26 
27 /*
28  * \class QgsNetworkAccessManager
29  * \brief network access manager for QGIS
30  * \ingroup core
31  * \since 1.5
32  *
33  * This class implements the QGIS network access manager. It's a singleton
34  * that can be used across QGIS.
35  *
36  * Plugins can insert proxy factories and thereby redirect requests to
37  * individual proxies.
38  *
39  * If no proxy factories are there or none returns a proxy for an URL a
40  * fallback proxy can be set. There's also a exclude list that defines URLs
41  * that the fallback proxy should not be used for, then no proxy will be used.
42  *
43  */
44 class CORE_EXPORT QgsNetworkAccessManager : public QNetworkAccessManager
45 {
46  Q_OBJECT
47 
48  public:
50  // and creates that instance on the first call.
51  static QgsNetworkAccessManager *instance();
52 
53  QgsNetworkAccessManager( QObject *parent = 0 );
54 
57 
59  void insertProxyFactory( QNetworkProxyFactory *factory );
60 
62  void removeProxyFactory( QNetworkProxyFactory *factory );
63 
65  const QList<QNetworkProxyFactory *> proxyFactories() const;
66 
68  const QNetworkProxy &fallbackProxy() const;
69 
71  const QStringList &excludeList() const;
72 
74  void setFallbackProxyAndExcludes( const QNetworkProxy &proxy, const QStringList &excludes );
75 
77  static QString cacheLoadControlName( QNetworkRequest::CacheLoadControl theControl );
78 
80  static QNetworkRequest::CacheLoadControl cacheLoadControlFromName( const QString &theName );
81 
83  void setupDefaultProxyAndCache();
84 
85  bool useSystemProxy() { return mUseSystemProxy; }
86 
87  signals:
88  void requestAboutToBeCreated( QNetworkAccessManager::Operation, const QNetworkRequest &, QIODevice * );
89  void requestCreated( QNetworkReply * );
90  void requestTimedOut( QNetworkReply * );
91 
92  private slots:
93  void abortRequest();
94 
95  protected:
96  virtual QNetworkReply *createRequest( QNetworkAccessManager::Operation op, const QNetworkRequest &req, QIODevice *outgoingData = 0 );
97 
98  private:
99  QList<QNetworkProxyFactory*> mProxyFactories;
100  QNetworkProxy mFallbackProxy;
101  QStringList mExcludedURLs;
102  bool mUseSystemProxy;
103 };
104 
105 #endif // QGSNETWORKACCESSMANAGER_H
106 
bool useSystemProxy()
Definition: qgsnetworkaccessmanager.h:85
Definition: qgsnetworkaccessmanager.h:44