Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::ResourceManager::FinishingQueue Class Reference

Collection of resource loading tasks that have been already been loaded by a loader thread and are waiting to be finished by the main thread. More...

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

Public Member Functions

bool empty () const
 Tells if the finishing queue has load tasks waiting to be finished. More...
 
void finishTask (size_t index)
 Completes the finishing part of the load task with the given index in the finishing queue. More...
 
string_view getTaskUrl (size_t index) const
 Returns the URL of the load task with the given index in the finishing queue. More...
 
size_t size () const
 Tells the number of load tasks in the finishing queue waiting to be finished. More...
 

Friends

class ResourceManager
 

Detailed Description

Collection of resource loading tasks that have been already been loaded by a loader thread and are waiting to be finished by the main thread.

You can override the Application::progressDeploymentQueueOverride and access the finishing queue with ResourceManager::getFinishingQueue to control when and which resources are deployed.

Member Function Documentation

size_t kanzi::ResourceManager::FinishingQueue::size ( ) const
inline

Tells the number of load tasks in the finishing queue waiting to be finished.

Returns
The number of load tasks in the finishing queue.
bool kanzi::ResourceManager::FinishingQueue::empty ( ) const
inline

Tells if the finishing queue has load tasks waiting to be finished.

Returns
True if the queue is empty; false otherwise.
string_view kanzi::ResourceManager::FinishingQueue::getTaskUrl ( size_t  index) const

Returns the URL of the load task with the given index in the finishing queue.

Parameters
indexIndex the load task.
Returns
The URL of the load task. Valid until the load task if completed.
void kanzi::ResourceManager::FinishingQueue::finishTask ( size_t  index)

Completes the finishing part of the load task with the given index in the finishing queue.

Note that this removes the task from the finishing queue and changes the indices of the remaining items.

Parameters
indexIndex the load task that should be finished.

Friends And Related Function Documentation

friend class ResourceManager
friend

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