Files
MapLibreParticleLab/src/mbgl/tile/tile_loader.hpp
2024-05-30 10:08:53 -07:00

71 lines
2.1 KiB
C++

#pragma once
#include <mbgl/storage/resource.hpp>
#include <mbgl/tile/tile.hpp>
#include <atomic>
#include <mutex>
#include <shared_mutex>
namespace mbgl {
class FileSource;
class AsyncRequest;
class Response;
class Tileset;
class TileParameters;
template <typename T>
class TileLoader {
public:
TileLoader(const TileLoader&) = delete;
TileLoader& operator=(const TileLoader&) = delete;
TileLoader(T&, const OverscaledTileID&, const TileParameters&, const Tileset&);
~TileLoader();
void setNecessity(TileNecessity newNecessity);
void setUpdateParameters(const TileUpdateParameters&);
private:
// called when the tile is one of the ideal tiles that we want to show
// definitely. the tile source should try to make every effort (e.g. fetch
// from internet, or revalidate existing resources).
void makeRequired();
// called when the zoom level no longer corresponds to the displayed one, but
// we're still interested in retaining the tile, e.g. for backfill.
// subclassed TileSources should cancel actions they are taking to provide
// an up-to-date version or load new data
void makeOptional();
void loadFromCache();
void loadedData(const Response&);
void loadFromNetwork();
bool hasPendingNetworkRequest() const {
return resource.loadingMethod == Resource::LoadingMethod::NetworkOnly && request;
}
T& tile;
TileNecessity necessity;
Resource resource;
std::shared_ptr<FileSource> fileSource;
std::unique_ptr<AsyncRequest> request;
TileUpdateParameters updateParameters{Duration::zero(), false};
/// @brief It's possible for async requests in flight to mess with the request
/// object at the same time as the loader's destructor. This construct is shared
/// with the request lambdas to ensure more tightly controlled synchronization
/// to prevent this from happening.
struct Shared {
std::shared_mutex requestLock;
std::atomic_bool aborted{false};
};
// Allocated as a `shared_ptr` so either the loader or
// request can outlive the other and still see this.
std::shared_ptr<Shared> shared;
};
} // namespace mbgl