Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::ResourceProfilingLoadTask Class Reference

Resource profiling wrapper for load task. More...

#include <kanzi/core.ui/resource/resource_profiling_load_task.hpp>

Inheritance diagram for kanzi::ResourceProfilingLoadTask:
[legend]

Public Member Functions

void finishFunction (const ResourceLoaderThreadContext *context) override
 Calls finishFunction() of the m_loadTask object and measures its execution time. More...
 
ResourceSharedPtr getResult () override
 Gets the deployed resource. More...
 
void loadFunction (const ResourceLoaderThreadContext *context) override
 Calls loadFunction() of the m_loadTask object and measures its execution time. More...
 
- Public Member Functions inherited from kanzi::ResourceManager::LoadTask
ResourceManagergetResourceManager () const
 Get the resource manager of a load task. More...
 
Type getType () const
 Get the type of a load task. More...
 
 LoadTask ()
 Constructor. More...
 
 LoadTask (const Type type)
 Constructor. More...
 
virtual ~LoadTask ()
 Destructor. More...
 

Static Public Member Functions

static ProfiledLoadTaskSharedPtr wrapTask (ResourceProfilingDataSampleSharedPtr profilingDataSample, ResourceManager::LoadTaskSharedPtr loadTask)
 Creates a new resource profiling load task. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::ResourceManager::LoadTask
enum  Type { Type::LoadAndFinish, Type::FinishOnly }
 The type of the load task. More...
 
- Protected Member Functions inherited from kanzi::ResourceManager::LoadTask
void enqueueDependencies (UrlContainer urls)
 Add resource dependencies for the load task. More...
 

Detailed Description

Resource profiling wrapper for load task.

Use this wrapper to measure the time that the loading task spends loading and deploying resources. The wrapper derives from ResourceManager::LoadTask and implements the load task interface. The original loading task object is passed to the constructor of this class and stored in m_loadTask. The loadFunction() and finishFunction() functions call the corresponding functions of the original object and measure the execution time which is then passed to the corresponding resource profiling contexts.

Member Function Documentation

static ProfiledLoadTaskSharedPtr kanzi::ResourceProfilingLoadTask::wrapTask ( ResourceProfilingDataSampleSharedPtr  profilingDataSample,
ResourceManager::LoadTaskSharedPtr  loadTask 
)
inlinestatic

Creates a new resource profiling load task.

Parameters
profilingDataSampleThe profiling data sample.
loadTaskThe original load task.
void kanzi::ResourceProfilingLoadTask::loadFunction ( const ResourceLoaderThreadContext context)
overridevirtual

Calls loadFunction() of the m_loadTask object and measures its execution time.

Parameters
contextThe context of the loading thread.

Implements kanzi::ResourceManager::LoadTask.

void kanzi::ResourceProfilingLoadTask::finishFunction ( const ResourceLoaderThreadContext context)
overridevirtual

Calls finishFunction() of the m_loadTask object and measures its execution time.

Parameters
contextThe context of the deploying thread.

Implements kanzi::ResourceManager::LoadTask.

ResourceSharedPtr kanzi::ResourceProfilingLoadTask::getResult ( )
overridevirtual

Gets the deployed resource.

Returns
The deployed resource.

Implements kanzi::ResourceManager::LoadTask.


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