Diarkis C++Client Library API Document
Diarkis::System Namespace Reference

Classes

class  DiarkisThread
 Interface class for Diarkis thread. More...
 
class  DiarkisThreadParams
 Parameters for thread startup. More...
 
struct  DiarkisThreadScheduler
 Thread scheduler. More...
 
struct  Result
 Contains information about a specific result value. Can be compared against another Result structure. Can also be printed as text for better debugging experience. More...
 

Typedefs

using ThreadFunc = std::function< Diarkis::System::Result(void *)>
 
using NativeThreadHandle = std::thread::native_handle_type
 

Enumerations

enum  ResultStatus : uint8_t { NONE, TEMPORARY, FATAL }
 Indicates whether result value is temporary or definitive. More...
 
enum  DiarkisThreadPriority : std::uint8_t {
  DiarkisThreadPriority::PRIORITY_HIGHEST = 0, DiarkisThreadPriority::PRIORITY_ABOVE_NORMAL, DiarkisThreadPriority::PRIORITY_NORMAL, DiarkisThreadPriority::PRIORITY_BELOW_NORMAL,
  DiarkisThreadPriority::PRIORITY_LOWEST
}
 Represent thread priority. More...
 
enum  DiarkisThreadPolicy : std::uint8_t { DiarkisThreadPolicy::STANDARD = 0, DiarkisThreadPolicy::ROUNDROBIN, DiarkisThreadPolicy::FIFO }
 Thread scheduling policy. More...
 

Typedef Documentation

◆ ThreadFunc

using Diarkis::System::ThreadFunc = typedef std::function<Diarkis::System::Result(void*)>

◆ NativeThreadHandle

using Diarkis::System::NativeThreadHandle = typedef std::thread::native_handle_type

Enumeration Type Documentation

◆ ResultStatus

Indicates whether result value is temporary or definitive.

Enumerator
NONE 

問題なし

TEMPORARY 

一時的。

FATAL 

致命的な状態

◆ DiarkisThreadPriority

enum Diarkis::System::DiarkisThreadPriority : std::uint8_t
strong

Represent thread priority.

Enumerator
PRIORITY_HIGHEST 
PRIORITY_ABOVE_NORMAL 
PRIORITY_NORMAL 
PRIORITY_BELOW_NORMAL 
PRIORITY_LOWEST 

◆ DiarkisThreadPolicy

enum Diarkis::System::DiarkisThreadPolicy : std::uint8_t
strong

Thread scheduling policy.

Configurable only on Linux systems; specifying it has no effect on Windows.

Enumerator
STANDARD 

Default.

ROUNDROBIN 

Round-robin scheduling.

FIFO 

First in-first out scheduling.