file_source.hpp

Go to the documentation of this file.

#pragma once
 
#include <mbgl/storage/resource_transform.hpp>
#include <mbgl/storage/response.hpp>
#include <mbgl/storage/resource_options.hpp>
#include <mbgl/util/client_options.hpp>
 
#include <mapbox/compatibility/value.hpp>
 
#include <functional>
#include <memory>
 
namespace mbgl {
 
class AsyncRequest;
class Resource;
 
// TODO: Rename to ResourceProviderType
enum FileSourceType : uint8_t {
    Asset,
    // TODO: split to separate types
    // - Cache for fast KV store (FASTER, LevelDB, RocksDB)
    // - Database for read-only offline use-cases
    Database,
    FileSystem,
    Network,
    Mbtiles,
    ResourceLoader 
};
 
// TODO: Rename to ResourceProvider to avoid confusion with
// GeoJSONSource, RasterSource, VectorSource, CustomGeometrySource and other *Sources.
class FileSource {
public:
    FileSource& operator=(const FileSource&) = delete;
    virtual ~FileSource() = default;
 
    using Callback = std::function<void (Response)>;
 
    virtual std::unique_ptr<AsyncRequest> request(const Resource&, Callback) = 0;
 
    //
    // NOLINTNEXTLINE(performance-unnecessary-value-param)
    virtual void forward(const Resource&, const Response&, std::function<void()>) {}
 
    virtual bool supportsCacheOnlyRequests() const { return false; }
 
    virtual bool canRequest(const Resource&) const = 0;
 
    virtual void pause() {}
 
    virtual void resume() {}
 
    virtual void setProperty(const std::string&, const mapbox::base::Value&){};
    virtual mapbox::base::Value getProperty(const std::string&) const { return {}; };
 
    virtual void setResourceTransform(ResourceTransform) {} // NOLINT(performance-unnecessary-value-param)
 
    virtual void setResourceOptions(ResourceOptions) = 0;
    virtual ResourceOptions getResourceOptions() = 0;
 
    virtual void setClientOptions(ClientOptions) = 0;
    virtual ClientOptions getClientOptions() = 0;
 
protected:
    FileSource() = default;
};
 
// Properties that may be supported by online file sources:
 
constexpr const char* API_KEY_KEY = "api-tkey";
 
constexpr const char* API_BASE_URL_KEY = "api-base-url";
 
constexpr const char* MAX_CONCURRENT_REQUESTS_KEY = "max-concurrent-requests";
 
// Properties that may be supported by database file sources:
 
constexpr const char* READ_ONLY_MODE_KEY = "read-only-mode";
 
} // namespace mbgl