QGIS API Documentation 3.34.0-Prizren (ffbdd678812)
|
Tile download manager handles downloads of map tiles for the purpose of map rendering. More...
#include <qgstiledownloadmanager.h>
Classes | |
class | Stats |
Encapsulates any statistics we would like to keep about requests. More... | |
Public Member Functions | |
QgsTileDownloadManager () | |
~QgsTileDownloadManager () | |
QgsTileDownloadManagerReply * | get (const QNetworkRequest &request) |
Starts a request. | |
bool | hasPendingRequests () const |
Returns whether there are any pending requests in the queue. | |
bool | hasWorkerThreadRunning () const |
Returns whether the worker thread is running currently (it may be stopped if there were no requests recently. | |
void | resetStatistics () |
Resets statistics of numbers of queries handled by this class. | |
void | setIdleThreadTimeout (int timeoutMs) |
Sets after how many milliseconds the idle worker therad should terminate. | |
void | shutdown () |
Asks the worker thread to stop and blocks until it is not stopped. | |
Stats | statistics () const |
Returns basic statistics of the queries handled by this class. | |
bool | waitForPendingRequests (int msec=-1) const |
Blocks the current thread until the queue is empty. | |
Friends | |
class | QgsTileDownloadManagerReply |
class | QgsTileDownloadManagerReplyWorkerObject |
class | QgsTileDownloadManagerWorker |
Tile download manager handles downloads of map tiles for the purpose of map rendering.
The purpose of this class is to handle a couple of situations that may happen:
At this point, it is not recommended to use this class for other scenarios than map rendering: using it elsewhere could slow down map rendering or have some unexpected negative effects.
How do things work:
Definition at line 202 of file qgstiledownloadmanager.h.
QgsTileDownloadManager::QgsTileDownloadManager | ( | ) |
Definition at line 188 of file qgstiledownloadmanager.cpp.
QgsTileDownloadManager::~QgsTileDownloadManager | ( | ) |
Definition at line 207 of file qgstiledownloadmanager.cpp.
QgsTileDownloadManagerReply * QgsTileDownloadManager::get | ( | const QNetworkRequest & | request | ) |
Starts a request.
Returns a new object that should be deleted by the caller when not needed anymore.
Definition at line 213 of file qgstiledownloadmanager.cpp.
bool QgsTileDownloadManager::hasPendingRequests | ( | ) | const |
Returns whether there are any pending requests in the queue.
Definition at line 265 of file qgstiledownloadmanager.cpp.
bool QgsTileDownloadManager::hasWorkerThreadRunning | ( | ) | const |
Returns whether the worker thread is running currently (it may be stopped if there were no requests recently.
Definition at line 315 of file qgstiledownloadmanager.cpp.
void QgsTileDownloadManager::resetStatistics | ( | ) |
Resets statistics of numbers of queries handled by this class.
Definition at line 320 of file qgstiledownloadmanager.cpp.
|
inline |
Sets after how many milliseconds the idle worker therad should terminate.
This function is meant mainly for unit testing.
Definition at line 275 of file qgstiledownloadmanager.h.
void QgsTileDownloadManager::shutdown | ( | ) |
Asks the worker thread to stop and blocks until it is not stopped.
Definition at line 290 of file qgstiledownloadmanager.cpp.
|
inline |
Returns basic statistics of the queries handled by this class.
Definition at line 278 of file qgstiledownloadmanager.h.
bool QgsTileDownloadManager::waitForPendingRequests | ( | int | msec = -1 | ) | const |
Blocks the current thread until the queue is empty.
This should not be used in production code, it is however useful for auto tests
Definition at line 272 of file qgstiledownloadmanager.cpp.
|
friend |
Definition at line 284 of file qgstiledownloadmanager.h.
|
friend |
Definition at line 285 of file qgstiledownloadmanager.h.
|
friend |
Definition at line 283 of file qgstiledownloadmanager.h.