fsdk/html/_i_async_context_8h_source.html

#pragma once

#include <cstdint>

#include <fsdk/Def.h>

#include <fsdk/IRefCounted.h>

#include <fsdk/Types.h>


namespace fsdk {


#ifndef DOXYGEN_SHOULD_SKIP_THIS

    DECLARE_SMARTPTR(IAsyncContext);

#endif


    struct IAsyncContext : IRefCounted {

        virtual int8_t threads() const noexcept = 0;


        virtual bool valid() const noexcept = 0;


        virtual bool clearTaskQueue() noexcept = 0;


        virtual bool resize(const int8_t newThreadCount) noexcept = 0;


        virtual bool stop() noexcept = 0;

    };


} // namespace fsdk

DECLARE_SMARTPTR
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition Def.h:56

fsdk
SDK namespace.
Definition IAGSEstimator.h:8

fsdk::IAsyncContext
Interface for running tasks asynchronously.
Definition IAsyncContext.h:24

fsdk::IAsyncContext::resize
virtual bool resize(const int8_t newThreadCount) noexcept=0
Resizes internal thread pool to some new size param newThreadCount New size of thread pool....

fsdk::IAsyncContext::valid
virtual bool valid() const noexcept=0
Tells validness of internal state.

fsdk::IAsyncContext::clearTaskQueue
virtual bool clearTaskQueue() noexcept=0
Clears tasks not yet taken by any thread.

fsdk::IAsyncContext::threads
virtual int8_t threads() const noexcept=0
Returns size of underlying thread pool.

fsdk::IAsyncContext::stop
virtual bool stop() noexcept=0
Waits for all already running tasks to complete, then stops every thread. Do not use threadpool after...

fsdk::IRefCounted
Base strong reference counted object interface.
Definition IRefCounted.h:37