1/****************************************************************************
2**
3** Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt3D module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QT3DCORE_QDOWNLOADHELPERSERVICE_P_H
41#define QT3DCORE_QDOWNLOADHELPERSERVICE_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists for the convenience
48// of other Qt classes. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QSharedPointer>
55#include <QObject>
56#include <QUrl>
57
58#include <Qt3DCore/qaspectjob.h>
59#include <Qt3DCore/qt3dcore_global.h>
60#include <Qt3DCore/private/qservicelocator_p.h>
61
62QT_BEGIN_NAMESPACE
63
64class QThread;
65class QNetworkAccessManager;
66class QNetworkReply;
67
68namespace Qt3DCore {
69
70class QAspectEngine;
71class QDownloadNetworkWorker;
72class QDownloadHelperService;
73class QDownloadHelperServicePrivate;
74
75class Q_3DCORESHARED_EXPORT QDownloadRequest
76{
77public:
78 QDownloadRequest(const QUrl &url);
79 virtual ~QDownloadRequest();
80
81 QUrl url() const { return m_url; }
82 bool succeeded() const { return m_succeeded; }
83 bool cancelled() const { return m_cancelled; }
84
85 virtual void onDownloaded(); // this is called in dl thread
86 virtual void onCompleted() = 0; // this is called in the aspect thread
87
88protected:
89 QUrl m_url;
90 QByteArray m_data;
91
92private:
93 friend class QDownloadNetworkWorker;
94 friend class QDownloadHelperService;
95 bool m_succeeded;
96 bool m_cancelled;
97};
98
99typedef QSharedPointer<QDownloadRequest> QDownloadRequestPtr;
100
101
102class Q_3DCORESHARED_EXPORT QDownloadHelperService : public QAbstractServiceProvider
103{
104 Q_OBJECT
105public:
106 explicit QDownloadHelperService(const QString &description = QString());
107 ~QDownloadHelperService();
108
109 void submitRequest(const QDownloadRequestPtr &request);
110 void cancelRequest(const QDownloadRequestPtr &request);
111 void cancelAllRequests();
112
113 static QString urlToLocalFileOrQrc(const QUrl &url);
114 static bool isLocal(const QUrl &url);
115 static QDownloadHelperService *getService(QAspectEngine *engine);
116
117private:
118 Q_DECLARE_PRIVATE(QDownloadHelperService)
119 Q_PRIVATE_SLOT(d_func(), void _q_onRequestCompleted(const Qt3DCore::QDownloadRequestPtr &))
120};
121
122typedef QSharedPointer<QDownloadHelperService> QDownloadHelperServicePtr;
123
124} // namespace Qt3DCore
125
126QT_END_NAMESPACE
127
128Q_DECLARE_METATYPE(Qt3DCore::QDownloadRequestPtr) // LCOV_EXCL_LINE
129
130#endif // QT3DCORE_QDOWNLOADHELPERSERVICE_P_H
131

source code of qt3d/src/core/services/qdownloadhelperservice_p.h