Fix: race-conditions in GUI updates when downloading HTTP files
(cherry picked from commit 56c6df4702015fda7cc7a05b67bfe90b3ede1ad0) See: https://github.com/OpenTTD/OpenTTD/issues/11636 See: https://github.com/OpenTTD/OpenTTD/pull/11639wip-string
parent
673a0dc5de
commit
6e7c92e3af
@ -0,0 +1,124 @@
|
|||||||
|
/*
|
||||||
|
* This file is part of OpenTTD.
|
||||||
|
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
|
||||||
|
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
||||||
|
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file http.h Shared functions for implementations of HTTP requests.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef NETWORK_CORE_HTTP_SHARED_H
|
||||||
|
#define NETWORK_CORE_HTTP_SHARED_H
|
||||||
|
|
||||||
|
#include "http.h"
|
||||||
|
|
||||||
|
#include <condition_variable>
|
||||||
|
#include <mutex>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
/** Converts a HTTPCallback to a Thread-Safe variant. */
|
||||||
|
class HTTPThreadSafeCallback {
|
||||||
|
private:
|
||||||
|
/** Entries on the queue for later handling. */
|
||||||
|
class Callback {
|
||||||
|
public:
|
||||||
|
Callback(const char *data, size_t length) : data(data), length(length), failure(false) {}
|
||||||
|
Callback() : data(nullptr), length(0), failure(true) {}
|
||||||
|
|
||||||
|
const char *data;
|
||||||
|
size_t length;
|
||||||
|
bool failure;
|
||||||
|
};
|
||||||
|
|
||||||
|
public:
|
||||||
|
/**
|
||||||
|
* Similar to HTTPCallback::OnFailure, but thread-safe.
|
||||||
|
*/
|
||||||
|
void OnFailure()
|
||||||
|
{
|
||||||
|
std::lock_guard<std::mutex> lock(this->mutex);
|
||||||
|
this->queue.emplace_back();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Similar to HTTPCallback::OnReceiveData, but thread-safe.
|
||||||
|
*/
|
||||||
|
void OnReceiveData(const char *data, size_t length)
|
||||||
|
{
|
||||||
|
std::lock_guard<std::mutex> lock(this->mutex);
|
||||||
|
this->queue.emplace_back(data, length);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Process everything on the queue.
|
||||||
|
*
|
||||||
|
* Should be called from the Game Thread.
|
||||||
|
*/
|
||||||
|
void HandleQueue()
|
||||||
|
{
|
||||||
|
this->cancelled = callback->IsCancelled();
|
||||||
|
|
||||||
|
std::lock_guard<std::mutex> lock(this->mutex);
|
||||||
|
|
||||||
|
for (auto &item : this->queue) {
|
||||||
|
if (item.failure) {
|
||||||
|
this->callback->OnFailure();
|
||||||
|
} else {
|
||||||
|
this->callback->OnReceiveData(item.data, item.length);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
this->queue.clear();
|
||||||
|
this->queue_cv.notify_all();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Wait till the queue is dequeued.
|
||||||
|
*/
|
||||||
|
void WaitTillEmpty()
|
||||||
|
{
|
||||||
|
std::unique_lock<std::mutex> lock(this->mutex);
|
||||||
|
|
||||||
|
while (!queue.empty()) {
|
||||||
|
this->queue_cv.wait(lock);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if the queue is empty.
|
||||||
|
*/
|
||||||
|
bool IsQueueEmpty()
|
||||||
|
{
|
||||||
|
std::lock_guard<std::mutex> lock(this->mutex);
|
||||||
|
return this->queue.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
HTTPThreadSafeCallback(HTTPCallback *callback) : callback(callback) {}
|
||||||
|
|
||||||
|
~HTTPThreadSafeCallback()
|
||||||
|
{
|
||||||
|
std::lock_guard<std::mutex> lock(this->mutex);
|
||||||
|
|
||||||
|
/* Free all data that was not handled. */
|
||||||
|
for (auto &item : this->queue) {
|
||||||
|
if (!item.failure) {
|
||||||
|
free(item.data);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
queue.clear();
|
||||||
|
queue_cv.notify_all();
|
||||||
|
}
|
||||||
|
|
||||||
|
std::atomic<bool> cancelled = false;
|
||||||
|
|
||||||
|
private:
|
||||||
|
HTTPCallback *callback; ///< The callback to send data back on.
|
||||||
|
std::mutex mutex; ///< Mutex to protect the queue.
|
||||||
|
std::vector<Callback> queue; ///< Queue of data to send back.
|
||||||
|
std::condition_variable queue_cv; ///< Condition variable to wait for the queue to be empty.
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif /* NETWORK_CORE_HTTP_SHARED_H */
|
Loading…
Reference in New Issue