Files
MapLibreParticleLab/include/mbgl/storage/file_source_manager.hpp
Alexander Shalamov 879c44f661 [core] Modularize FileSource codebase (#15768)
* [core] Introduce FileSourceManager and use it for default platform impl

  - Add `FileSourceManager` interface that provides access to `FileSource`
    instances and means of registering / unregistering `FileSource` factories
  - Split `DefaultFileSource` into smaller parts
  - Add `DatabaseFileSource` interface and it's default implementation
  - Remove inter-dependencies between concrete `FileSource` classes

* [build] Add files to next build system

* [core] Add generic property setters / getters

* [core] Remove setOnlineStatus from OnlineFileSource interface

* [core] Hide threading implementation details from DatabaseFileSource interface

* [core] Make DB file source methods virtual

* [core] Add documentation for DatabaseFileSource and rename one method

* [core] Use simple callback instead of ActorRef

* [core] Remove ActorRef from OnlineFileSource public header

* [core] Add callback to FileSource::forward async API

* [core] Pass OfflineRegionDefinition by value

* [core] Update tests to use modular file sources

* [core] Update unit tests

* [core] Update unit tests after rebase

* [core] Backport low prio fix for cached requests

* [core] Backport pack database

* [core] Return removed factory from unRegisterFileSourceFactory

* [core] Rename shadowed args in onlinefilesource

* [core] Remove simple std::function callback aliases

* [core] Expose online file source property keys in public header file

* [test-runner] Add proxy file source test runner

* [cache] Update mbgl-cache utility to use new file source

* [metrics] Rebaseline binary size metrics

* [offline] Update offline utility

* [core] Update changelog
2020-01-13 10:57:23 +02:00

51 lines
1.7 KiB
C++

#pragma once
#include <mbgl/storage/file_source.hpp>
namespace mbgl {
class ResourceOptions;
/**
* @brief A singleton class responsible for managing file sources.
*
* The FileSourceManager provides following functionality:
*
* - provides access to file sources of a specific type and configuration
* - caches previously created file sources of a (type, configuration) tuples
* - allows to register and unregister file source factories
*/
class FileSourceManager {
public:
using FileSourceFactory = std::function<std::unique_ptr<FileSource>(const ResourceOptions&)>;
/**
* @brief A singleton getter.
*
* @return FileSourceManager*
*/
static FileSourceManager* get() noexcept;
// Returns shared instance of a file source for (type, options) tuple.
// Creates new instance via registered factory if needed. If new instance cannot be
// created, nullptr would be returned.
std::shared_ptr<FileSource> getFileSource(FileSourceType, const ResourceOptions&) noexcept;
// Registers file source factory for a provided FileSourceType type. If factory for the
// same type was already registered, will unregister previously registered factory.
// Provided factory must not be null.
virtual void registerFileSourceFactory(FileSourceType, FileSourceFactory&&) noexcept;
// Unregisters file source factory. If there are no registered factories for a FileSourceType
// invocation has no effect.
virtual FileSourceFactory unRegisterFileSourceFactory(FileSourceType) noexcept;
protected:
FileSourceManager();
class Impl;
std::unique_ptr<Impl> impl;
virtual ~FileSourceManager();
};
} // namespace mbgl