QGIS API Documentation
4.3.0-Master (1c7cf7431bd)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
network
qgsnetworkcontentfetchertask.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsnetworkcontentfetchertask.h
3
-------------------
4
begin : March, 2018
5
copyright : (C) 2018 by Nyall Dawson
6
email : nyall dot dawson at gmail dot com
7
8
***************************************************************************/
9
10
/***************************************************************************
11
* *
12
* This program is free software; you can redistribute it and/or modify *
13
* it under the terms of the GNU General Public License as published by *
14
* the Free Software Foundation; either version 2 of the License, or *
15
* (at your option) any later version. *
16
* *
17
***************************************************************************/
18
19
20
#ifndef QGSNETWORKCONTENTFETCHERTASK_H
21
#define QGSNETWORKCONTENTFETCHERTASK_H
22
23
#include "qgis_core.h"
24
#include "
qgshttpheaders.h
"
25
#include "
qgstaskmanager.h
"
26
27
#include <QNetworkReply>
28
#include <QNetworkRequest>
29
30
class
QgsNetworkContentFetcher
;
31
49
class
CORE_EXPORT
QgsNetworkContentFetcherTask
:
public
QgsTask
50
{
51
Q_OBJECT
52
53
public
:
64
QgsNetworkContentFetcherTask
(
65
const
QUrl &url,
const
QString &authcfg = QString(),
QgsTask::Flags
flags
=
QgsTask::CanCancel
,
const
QString &
description
= QString(),
const
QgsHttpHeaders
&headers =
QgsHttpHeaders
()
66
);
67
78
QgsNetworkContentFetcherTask
(
79
const
QNetworkRequest &request,
const
QString &authcfg = QString(),
QgsTask::Flags
flags
=
QgsTask::CanCancel
,
const
QString &
description
= QString(),
const
QgsHttpHeaders
&headers =
QgsHttpHeaders
()
80
);
81
82
~QgsNetworkContentFetcherTask
()
override
;
83
84
bool
run
()
override
;
85
void
cancel
()
override
;
86
95
QNetworkReply *
reply
();
96
102
QString
contentDispositionFilename
()
const
;
103
112
QString
contentAsString
()
const
;
113
114
signals:
115
124
void
fetched
();
125
131
void
errorOccurred
( QNetworkReply::NetworkError code,
const
QString &errorMsg );
132
133
private
:
134
QNetworkRequest mRequest;
135
QString mAuthcfg;
136
QgsNetworkContentFetcher
*mFetcher =
nullptr
;
137
QString mMode;
138
QgsHttpHeaders
mHeaders;
139
};
140
141
#endif
//QGSNETWORKCONTENTFETCHERTASK_H
QgsHttpHeaders
Implements simple HTTP header management.
Definition
qgshttpheaders.h:41
QgsNetworkContentFetcherTask::QgsNetworkContentFetcherTask
QgsNetworkContentFetcherTask(const QUrl &url, const QString &authcfg=QString(), QgsTask::Flags flags=QgsTask::CanCancel, const QString &description=QString(), const QgsHttpHeaders &headers=QgsHttpHeaders())
Constructor for a QgsNetworkContentFetcherTask which fetches the specified url.
Definition
qgsnetworkcontentfetchertask.cpp:28
QgsNetworkContentFetcherTask::contentAsString
QString contentAsString() const
Returns the fetched content as a string.
Definition
qgsnetworkcontentfetchertask.cpp:104
QgsNetworkContentFetcherTask::contentDispositionFilename
QString contentDispositionFilename() const
Returns the associated filename from the reply's content disposition header, if present.
Definition
qgsnetworkcontentfetchertask.cpp:99
QgsNetworkContentFetcherTask::fetched
void fetched()
Emitted when the network content has been fetched, regardless of whether the fetch was successful or ...
QgsNetworkContentFetcherTask::reply
QNetworkReply * reply()
Returns the network reply.
Definition
qgsnetworkcontentfetchertask.cpp:94
QgsNetworkContentFetcherTask::errorOccurred
void errorOccurred(QNetworkReply::NetworkError code, const QString &errorMsg)
Emitted when an error with code error occurred while processing the request errorMsg is a textual des...
QgsNetworkContentFetcher
HTTP network content fetcher.
Definition
qgsnetworkcontentfetcher.h:43
QgsTask::flags
Flags flags() const
Returns the flags associated with the task.
Definition
qgstaskmanager.h:93
QgsTask::run
virtual bool run()=0
Performs the task's operation.
QgsTask::Flags
QFlags< Flag > Flags
Definition
qgstaskmanager.h:79
QgsTask::cancel
virtual void cancel()
Notifies the task that it should terminate.
Definition
qgstaskmanager.cpp:98
QgsTask::QgsTask
QgsTask(const QString &description=QString(), QgsTask::Flags flags=AllFlags)
Constructor for QgsTask.
Definition
qgstaskmanager.cpp:36
QgsTask::CanCancel
@ CanCancel
Task can be canceled.
Definition
qgstaskmanager.h:73
QgsTask::description
QString description() const
Returns the task's description.
Definition
qgstaskmanager.h:121
qgshttpheaders.h
qgstaskmanager.h
Generated on
for QGIS API Documentation by
1.17.0