Skip to content
Entropy Documentation

EntropyCanvas::AssetOperationHandle

EntropyCanvas::AssetOperationHandle

Section titled “EntropyCanvas::AssetOperationHandle”

Handle for tracking async asset operations. More…

#include <AssetOperationHandle.h>

Public Types

Section titled “Public Types”
Name
using AssetOpState< T >StateType
using EntropyEngine::Core::RefObject< StateType >StateRef

Public Functions

Section titled “Public Functions”
Name
boolwaitFor(std::chrono::milliseconds timeout) const
voidwait() const
boolvalid() const
uint64_ttotalBytes() const
AssetOpStatusstatus() const
const std::optional< T > &result() const
const StateRef &ref() const
boolisDone() const
StateType *get() const
const AssetOpErrorInfo &error() const
uint64_tbytesTransferred() const
AssetOperationHandle() =default
AssetOperationHandle(StateRef state)

Detailed Description

Section titled “Detailed Description”
template <typename T >
class EntropyCanvas::AssetOperationHandle;

Handle for tracking async asset operations.

Wraps RefObject<AssetOpState> with convenience methods. Copyable - multiple handles can reference the same operation.

Usage:

auto handle = client.resolve(assetId);  // Returns immediately


// Option 1: Poll
while (!handle.isDone()) {
    // Do other work
}


// Option 2: Wait with timeout
if (handle.waitFor(5000ms)) {
    auto result = handle.result();
}


// Option 3: Block until complete
handle.wait();

Public Types Documentation

Section titled “Public Types Documentation”

using StateType

Section titled “using StateType”
using EntropyCanvas::AssetOperationHandle< T >::StateType = AssetOpState<T>;

using StateRef

Section titled “using StateRef”
using EntropyCanvas::AssetOperationHandle< T >::StateRef = EntropyEngine::Core::RefObject<StateType>;

Public Functions Documentation

Section titled “Public Functions Documentation”

function waitFor

Section titled “function waitFor”
inline bool waitFor(
    std::chrono::milliseconds timeout
) const

function wait

Section titled “function wait”
inline void wait() const

function valid

Section titled “function valid”
inline bool valid() const

function totalBytes

Section titled “function totalBytes”
inline uint64_t totalBytes() const

function status

Section titled “function status”
inline AssetOpStatus status() const

function result

Section titled “function result”
inline const std::optional< T > & result() const

function ref

Section titled “function ref”
inline const StateRef & ref() const

function isDone

Section titled “function isDone”
inline bool isDone() const

function get

Section titled “function get”
inline StateType * get() const

function error

Section titled “function error”
inline const AssetOpErrorInfo & error() const

function bytesTransferred

Section titled “function bytesTransferred”
inline uint64_t bytesTransferred() const

function AssetOperationHandle

Section titled “function AssetOperationHandle”
AssetOperationHandle() =default

function AssetOperationHandle

Section titled “function AssetOperationHandle”
inline explicit AssetOperationHandle(
    StateRef state
)

Updated on 2026-01-26 at 17:14:35 -0500