Face Engine SDK  5.8.0
A face detection, recognition and tracking engine.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
IAsyncContext.h
Go to the documentation of this file.
1 #pragma once
2 
9 #include <cstdint>
10 #include "Def.h"
11 #include "IRefCounted.h"
12 #include "Types.h"
13 
14 namespace fsdk {
15 
16  #ifndef DOXYGEN_SHOULD_SKIP_THIS
17  DECLARE_SMARTPTR(IAsyncContext);
18  #endif
19 
24  struct IAsyncContext
25  : IRefCounted {
30  virtual int8_t threads() const noexcept = 0;
31 
36  virtual bool valid() const noexcept = 0;
37 
42  virtual bool clearTaskQueue() noexcept = 0;
43 
49  virtual bool resize(const int8_t newThreadCount) noexcept = 0;
50 
56  virtual bool stop() noexcept = 0;
57  };
58 
59 }
60 
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...
DECLARE_SMARTPTR
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:59
Types.h
Common data types and structures.
fsdk::IRefCounted
Base strong reference counted object interface.
Definition: IRefCounted.h:36
fsdk::IAsyncContext
Interface for running tasks asynchronously.
Definition: IAsyncContext.h:24
fsdk::IAsyncContext::threads
virtual int8_t threads() const noexcept=0
Returns size of underlying thread pool.
Def.h
Common SDK definitions.
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.
IRefCounted.h
Reference counted object interface.