Kanzi Connect  3.9.9
Kanzi Connect C++ API
kanzi::connect::FileLoader Class Reference

Class to load files from a server or remote service over the connection adapters. More...

#include <file_loader.hpp>

Inheritance diagram for kanzi::connect::FileLoader:

Public Member Functions

 FileLoader (ClientSharedPtr client)
 Constructor. More...
 
size_t getUsedBlockCount () const
 Get the block count used in the last load. More...
 
int getUsedBlockSize () const
 Get the block size used in the last load. More...
 
virtual ~FileLoader () override
 dtor More...
 

Static Public Member Functions

static bool loadResource (const string &uri, shared_ptr< FileLoader > me, vector< char > &outFile, chrono::milliseconds initialResponseTimeout)
 Utility function for downloading a file outside Kanzi main thread. More...
 

Protected Member Functions

virtual void startResourceSubscription (const string &uri)
 Request a resource from the server. More...
 

Detailed Description

Class to load files from a server or remote service over the connection adapters.

Constructor & Destructor Documentation

◆ FileLoader()

kanzi::connect::FileLoader::FileLoader ( ClientSharedPtr  client)
explicit

Constructor.

Parameters
clientAccess to server, message dispatcher and task queue

◆ ~FileLoader()

virtual kanzi::connect::FileLoader::~FileLoader ( )
overridevirtual

dtor

Member Function Documentation

◆ getUsedBlockCount()

size_t kanzi::connect::FileLoader::getUsedBlockCount ( ) const

Get the block count used in the last load.

Returns
Block count

◆ getUsedBlockSize()

int kanzi::connect::FileLoader::getUsedBlockSize ( ) const

Get the block size used in the last load.

Returns
Block size in bytes

◆ loadResource()

static bool kanzi::connect::FileLoader::loadResource ( const string &  uri,
shared_ptr< FileLoader me,
vector< char > &  outFile,
chrono::milliseconds  initialResponseTimeout 
)
static

Utility function for downloading a file outside Kanzi main thread.

Blocks until file has been loaded or timeout

Parameters
uriUnique resource identifier.
meInstance of content loader to be used.
outFileMemory buffer to write the data.
initialResponseTimeoutTimeout to wait for response from server

◆ startResourceSubscription()

virtual void kanzi::connect::FileLoader::startResourceSubscription ( const string &  uri)
protectedvirtual

Request a resource from the server.

Parameters
uriIdentifies the resource to request

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