MapLibre Native Core
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mbgl::FileSourceManager Class Reference

A singleton class responsible for managing file sources. More...

#include <file_source_manager.hpp>

Public Types

using FileSourceFactory = std::function< std::unique_ptr< FileSource >(const ResourceOptions &, const ClientOptions &)>
 

Public Member Functions

std::shared_ptr< FileSource > getFileSource (FileSourceType, const ResourceOptions &, const ClientOptions &=ClientOptions()) noexcept
 
virtual void registerFileSourceFactory (FileSourceType, FileSourceFactory &&) noexcept
 
virtual FileSourceFactory unRegisterFileSourceFactory (FileSourceType) noexcept
 

Static Public Member Functions

static FileSourceManager * get () noexcept
 A singleton getter. More...
 

Protected Member Functions

 FileSourceManager ()
 
virtual ~FileSourceManager ()
 

Protected Attributes

std::unique_ptr< Impl > impl
 

Detailed Description

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

Definition at line 19 of file file_source_manager.hpp.

Member Typedef Documentation

◆ FileSourceFactory

using mbgl::FileSourceManager::FileSourceFactory = std::function<std::unique_ptr<FileSource>(const ResourceOptions&, const ClientOptions&)>

Definition at line 21 of file file_source_manager.hpp.

Constructor & Destructor Documentation

◆ FileSourceManager()

mbgl::FileSourceManager::FileSourceManager ( )
protected

◆ ~FileSourceManager()

virtual mbgl::FileSourceManager::~FileSourceManager ( )
protectedvirtual

Member Function Documentation

◆ get()

static FileSourceManager* mbgl::FileSourceManager::get ( )
staticnoexcept

A singleton getter.

Returns
FileSourceManager*

◆ getFileSource()

std::shared_ptr<FileSource> mbgl::FileSourceManager::getFileSource ( FileSourceType  ,
const ResourceOptions &  ,
const ClientOptions &  = ClientOptions() 
)
noexcept

◆ registerFileSourceFactory()

virtual void mbgl::FileSourceManager::registerFileSourceFactory ( FileSourceType  ,
FileSourceFactory &&   
)
virtualnoexcept

◆ unRegisterFileSourceFactory()

virtual FileSourceFactory mbgl::FileSourceManager::unRegisterFileSourceFactory ( FileSourceType  )
virtualnoexcept

Member Data Documentation

◆ impl

std::unique_ptr<Impl> mbgl::FileSourceManager::impl
protected

Definition at line 47 of file file_source_manager.hpp.

The documentation for this class was generated from the following file: