Grok 20.3.2
grk::IFetcher Class Referenceabstract

#include <CurlFetcher.h>

Public Member Functions

virtual ~IFetcher ()=default
virtual void init (const std::string &path, const FetchAuth &auth)=0
virtual size_t read (uint8_t *buffer, size_t numBytes)=0
virtual bool seek (uint64_t offset)=0
virtual uint64_t size () const =0
virtual uint64_t offset () const =0
virtual std::future< bool > fetchTiles (const TPSEQ_VEC &allTileParts, std::set< uint16_t > &slated, void *user_data, TileFetchCallback callback)=0
virtual void onFetchTilesComplete (std::shared_ptr< TileFetchContext > context, bool success)=0
virtual void fetchChunks (std::shared_ptr< ChunkBuffer<> > chunkBuffer)=0
virtual void fetchChunks (std::shared_ptr< ChunkBuffer<> > chunkBuffer, std::shared_ptr< std::vector< ChunkRequest > > requests)=0
virtual std::vector< std::string > listDirectory (const std::string &path)=0
virtual bool getMetadata (const std::string &path, std::map< std::string, std::string > &metadata)=0
virtual void setFetchThrottle (std::function< bool()> throttle)=0
virtual void notifyThrottleRelease ()=0

Constructor & Destructor Documentation

◆ ~IFetcher()

virtual grk::IFetcher::~IFetcher ( )
virtualdefault

Member Function Documentation

◆ fetchChunks() [1/2]

virtual void grk::IFetcher::fetchChunks ( std::shared_ptr< ChunkBuffer<> > chunkBuffer)
pure virtual

◆ fetchChunks() [2/2]

virtual void grk::IFetcher::fetchChunks ( std::shared_ptr< ChunkBuffer<> > chunkBuffer,
std::shared_ptr< std::vector< ChunkRequest > > requests )
pure virtual

◆ fetchTiles()

virtual std::future< bool > grk::IFetcher::fetchTiles ( const TPSEQ_VEC & allTileParts,
std::set< uint16_t > & slated,
void * user_data,
TileFetchCallback callback )
pure virtual

◆ getMetadata()

virtual bool grk::IFetcher::getMetadata ( const std::string & path,
std::map< std::string, std::string > & metadata )
pure virtual

◆ init()

virtual void grk::IFetcher::init ( const std::string & path,
const FetchAuth & auth )
pure virtual

◆ listDirectory()

virtual std::vector< std::string > grk::IFetcher::listDirectory ( const std::string & path)
pure virtual

◆ notifyThrottleRelease()

virtual void grk::IFetcher::notifyThrottleRelease ( )
pure virtual

◆ offset()

virtual uint64_t grk::IFetcher::offset ( ) const
pure virtual

Referenced by seek().

◆ onFetchTilesComplete()

virtual void grk::IFetcher::onFetchTilesComplete ( std::shared_ptr< TileFetchContext > context,
bool success )
pure virtual

◆ read()

virtual size_t grk::IFetcher::read ( uint8_t * buffer,
size_t numBytes )
pure virtual

◆ seek()

virtual bool grk::IFetcher::seek ( uint64_t offset)
pure virtual

References offset().

◆ setFetchThrottle()

virtual void grk::IFetcher::setFetchThrottle ( std::function< bool()> throttle)
pure virtual

◆ size()

virtual uint64_t grk::IFetcher::size ( ) const
pure virtual

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