Asynchronous engine primitives. More...

Namespaces
namespace	io
	Low-level asynchronous I/O interfaces.

Classes
class	ConditionVariable
	std::condition_variable replacement for asynchronous tasks More...

class	Deadline
	Internal representation of a deadline time point. More...

class	Future
	std::future replacement for asynchronous tasks that works in pair with engine::Promise More...

class	Mutex
	std::mutex replacement for asynchronous tasks More...

class	Promise
	std::promise replacement for asynchronous tasks that works in pair with engine::Future More...

class	Promise< void >

class	Semaphore
	Class that allows up to `max_simultaneous_locks` concurrent accesses to the critical section. More...

class	SemaphoreLock
	A replacement for std::shared_lock that accepts Deadline arguments. More...

class	SharedMutex
	std::shared_mutex replacement for asynchronous tasks More...

class	SharedTaskWithResult

class	SingleConsumerEvent
	A multiple-producers, single-consumer event. More...

class	SingleThreadedTaskProcessorsPool

class	SingleUseEvent
	A single-producer, single-consumer event. More...

class	SingleWaitingTaskMutex
	Lighter version of Mutex with not more than 1 waiting task. More...

class	Task
	Asynchronous task. More...

class	TaskCancellationBlocker

class	TaskCancellationToken
	Cancellation token to given task object. More...

class	TaskCancelledException
	Thrown if a `TaskWithResult`, for which we were waiting, got cancelled. More...

class	TaskInheritedVariable
	TaskInheritedVariable is a per-coroutine variable of arbitrary type. More...

class	TaskLocalVariable
	TaskLocalVariable is a per-coroutine variable of arbitrary type. More...

struct	TaskProcessorPoolsConfig
	A lightweight TaskProcessor config for engine::RunStandalone. More...

class	TaskWithResult

class	UnreachableSemaphoreLockError

class	WaitInterruptedException

Typedefs
template<typename T >
using	MpscQueue = concurrent::MpscQueue< T >

Enumerations
enum class	CvStatus { kNoTimeout , kTimeout , kCancelled }
	std::condition_variable state extended with "cancelled" state More...

enum class	FutureStatus { kReady , kTimeout , kCancelled }
	std::future state extended with "cancelled" state More...

enum class	TaskCancellationReason { kNone , kUserRequest , kDeadline , kOverload , kAbandoned , kShutdown }
	Task cancellation reason. More...

Functions
template<typename Function , typename... Args>
auto	AsyncNoSpan (TaskProcessor &task_processor, Function &&f, Args &&... args)
	Runs an asynchronous function call using specified task processor.

template<typename Function , typename... Args>
auto	SharedAsyncNoSpan (TaskProcessor &task_processor, Function &&f, Args &&... args)
	Runs an asynchronous function call using specified task processor.

template<typename Function , typename... Args>
auto	AsyncNoSpan (TaskProcessor &task_processor, Deadline deadline, Function &&f, Args &&... args)

template<typename Function , typename... Args>
auto	SharedAsyncNoSpan (TaskProcessor &task_processor, Deadline deadline, Function &&f, Args &&... args)

template<typename Function , typename... Args>
auto	AsyncNoSpan (Function &&f, Args &&... args)
	Runs an asynchronous function call using task processor of the caller.

template<typename Function , typename... Args>
auto	SharedAsyncNoSpan (Function &&f, Args &&... args)
	Runs an asynchronous function call using task processor of the caller.

template<typename Function , typename... Args>
auto	AsyncNoSpan (Deadline deadline, Function &&f, Args &&... args)

template<typename Function , typename... Args>
auto	SharedAsyncNoSpan (Deadline deadline, Function &&f, Args &&... args)

template<typename Function , typename... Args>
auto	CriticalAsyncNoSpan (TaskProcessor &task_processor, Function &&f, Args &&... args)
	Runs an asynchronous function call that will start regardless of cancellations using specified task processor.

template<typename Function , typename... Args>
auto	SharedCriticalAsyncNoSpan (TaskProcessor &task_processor, Function &&f, Args &&... args)
	Runs an asynchronous function call that will start regardless of cancellations using specified task processor.

template<typename Function , typename... Args>
auto	CriticalAsyncNoSpan (Function &&f, Args &&... args)
	Runs an asynchronous function call that will start regardless of cancellations using task processor of the caller.

template<typename Function , typename... Args>
auto	SharedCriticalAsyncNoSpan (Function &&f, Args &&... args)
	Runs an asynchronous function call that will start regardless of cancellations using task processor of the caller.

template<typename Function , typename... Args>
auto	CriticalAsyncNoSpan (Deadline deadline, Function &&f, Args &&... args)
	Runs an asynchronous function call that will start regardless of cancellations, using task processor of the caller, with deadline.

template<typename... Tasks>
auto	GetAll (Tasks &... tasks)
	Waits for the successful completion of all of the specified tasks or the cancellation of the caller.

void	RunStandalone (std::function< void()> payload)
	Runs a payload in a temporary coroutine engine instance.

void	RunStandalone (std::size_t worker_threads, std::function< void()> payload)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	RunStandalone (std::size_t worker_threads, const TaskProcessorPoolsConfig &config, std::function< void()> payload)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	Yield ()
	Suspends execution for a brief period of time, possibly allowing other tasks to execute.

template<typename Rep , typename Period >
void	InterruptibleSleepFor (const std::chrono::duration< Rep, Period > &duration)

template<typename Clock , typename Duration >
void	InterruptibleSleepUntil (const std::chrono::time_point< Clock, Duration > &time_point)

template<typename Rep , typename Period >
void	SleepFor (const std::chrono::duration< Rep, Period > &duration)
	Suspends execution for at least a specified amount of time.

template<typename Clock , typename Duration >
void	SleepUntil (const std::chrono::time_point< Clock, Duration > &time_point)
	Suspends execution until the specified time point is reached.

std::string	ToString (TaskCancellationReason reason)
	Returns a string representation of a cancellation reason.

template<typename... Tasks>
void	WaitAllChecked (Tasks &... tasks)
	Waits for the successful completion of all of the specified tasks or for the cancellation of the caller.

template<typename... Tasks, typename Rep , typename Period >
FutureStatus	WaitAllCheckedFor (const std::chrono::duration< Rep, Period > &duration, Tasks &... tasks)

template<typename... Tasks, typename Clock , typename Duration >
FutureStatus	WaitAllCheckedUntil (const std::chrono::time_point< Clock, Duration > &until, Tasks &... tasks)

template<typename... Tasks>
FutureStatus	WaitAllCheckedUntil (Deadline deadline, Tasks &... tasks)

template<typename... Tasks>
std::optional< std::size_t >	WaitAny (Tasks &... tasks)
	Waits for the completion of any of the specified tasks or the cancellation of the caller.

template<typename... Tasks, typename Rep , typename Period >
std::optional< std::size_t >	WaitAnyFor (const std::chrono::duration< Rep, Period > &duration, Tasks &... tasks)

template<typename... Tasks, typename Clock , typename Duration >
std::optional< std::size_t >	WaitAnyUntil (const std::chrono::time_point< Clock, Duration > &until, Tasks &... tasks)

template<typename... Tasks>
std::optional< std::size_t >	WaitAnyUntil (Deadline, Tasks &... tasks)

Detailed Description

Asynchronous engine primitives.

Typedef Documentation

◆ MpscQueue

template<typename T >

using engine::MpscQueue = typedef concurrent::MpscQueue<T>

Definition at line 9 of file mpsc_queue.hpp.

Enumeration Type Documentation

◆ CvStatus

enum class engine::CvStatus

strong

std::condition_variable state extended with "cancelled" state

Definition at line 11 of file condition_variable_status.hpp.

◆ FutureStatus

enum class engine::FutureStatus

strong

std::future state extended with "cancelled" state

Enumerator
kReady	the future is ready
kTimeout	the wait operation timed out
kCancelled	the wait operation was interrupted by task cancellation

Definition at line 11 of file future_status.hpp.

◆ TaskCancellationReason

enum class engine::TaskCancellationReason

strong

Task cancellation reason.

Enumerator
kNone	Not cancelled.
kUserRequest	User request.
kDeadline	Deadline.
kOverload	Task processor overload.
kAbandoned	Task destruction before finish.
kShutdown	Task processor shutdown.

Definition at line 20 of file cancel.hpp.

Function Documentation

◆ AsyncNoSpan() [1/4]

template<typename Function , typename... Args>

auto engine::AsyncNoSpan	(	Deadline	deadline,
		Function &&	f,
		Args &&...	args
	)

Runs an asynchronous function call with deadline using task processor of the caller

Definition at line 93 of file async.hpp.

◆ AsyncNoSpan() [2/4]

template<typename Function , typename... Args>

auto engine::AsyncNoSpan	(	Function &&	f,
		Args &&...	args
	)

Runs an asynchronous function call using task processor of the caller.

Definition at line 77 of file async.hpp.

◆ AsyncNoSpan() [3/4]

template<typename Function , typename... Args>

auto engine::AsyncNoSpan	(	TaskProcessor &	task_processor,
		Deadline	deadline,
		Function &&	f,
		Args &&...	args
	)

Runs an asynchronous function call with deadline using specified task processor

Definition at line 57 of file async.hpp.

◆ AsyncNoSpan() [4/4]

template<typename Function , typename... Args>

auto engine::AsyncNoSpan	(	TaskProcessor &	task_processor,
		Function &&	f,
		Args &&...	args
	)

Runs an asynchronous function call using specified task processor.

Examples: core/src/engine/mutex_benchmark.cpp.

Definition at line 38 of file async.hpp.

◆ CriticalAsyncNoSpan() [1/3]

template<typename Function , typename... Args>

auto engine::CriticalAsyncNoSpan	(	Deadline	deadline,
		Function &&	f,
		Args &&...	args
	)

Runs an asynchronous function call that will start regardless of cancellations, using task processor of the caller, with deadline.

See also: Task::Importance::Critical

Definition at line 155 of file async.hpp.

◆ CriticalAsyncNoSpan() [2/3]

template<typename Function , typename... Args>

auto engine::CriticalAsyncNoSpan	(	Function &&	f,
		Args &&...	args
	)

Runs an asynchronous function call that will start regardless of cancellations using task processor of the caller.

See also: Task::Importance::Critical

Definition at line 135 of file async.hpp.

◆ CriticalAsyncNoSpan() [3/3]

template<typename Function , typename... Args>

auto engine::CriticalAsyncNoSpan	(	TaskProcessor &	task_processor,
		Function &&	f,
		Args &&...	args
	)

Runs an asynchronous function call that will start regardless of cancellations using specified task processor.

See also: Task::Importance::Critical

Definition at line 113 of file async.hpp.

◆ InterruptibleSleepFor()

template<typename Rep , typename Period >

void engine::InterruptibleSleepFor ( const std::chrono::duration< Rep, Period > & duration )

Suspends execution for at least the specified amount of time or until the current task is cancelled. If already cancelled, the call is equivalent to Yield.

Definition at line 28 of file sleep.hpp.

◆ InterruptibleSleepUntil()

template<typename Clock , typename Duration >

void engine::InterruptibleSleepUntil ( const std::chrono::time_point< Clock, Duration > & time_point )

Suspends execution until the specified time point is reached or until the current task is cancelled. If already cancelled, the call is equivalent to Yield.

Definition at line 36 of file sleep.hpp.

◆ RunStandalone()

void engine::RunStandalone ( std::function< void()> payload )

Runs a payload in a temporary coroutine engine instance.

Creates a TaskProcessor with specified parameters, executes the payload in an Async and exits. Mainly designated for async code unit testing.

Warning: This function must not be used while another engine instance is running.

Parameters

payload	Code to be run in a Task
worker_threads	Engine thread pool size, 1 by default
config	A lightweight TaskProcessor config

Examples: core/src/engine/mutex_benchmark.cpp.

◆ SharedAsyncNoSpan() [1/4]

template<typename Function , typename... Args>

auto engine::SharedAsyncNoSpan	(	Deadline	deadline,
		Function &&	f,
		Args &&...	args
	)

Runs an asynchronous function call with deadline using task processor of the caller

Definition at line 102 of file async.hpp.

◆ SharedAsyncNoSpan() [2/4]

template<typename Function , typename... Args>

auto engine::SharedAsyncNoSpan	(	Function &&	f,
		Args &&...	args
	)

Runs an asynchronous function call using task processor of the caller.

Definition at line 84 of file async.hpp.

◆ SharedAsyncNoSpan() [3/4]

template<typename Function , typename... Args>

auto engine::SharedAsyncNoSpan	(	TaskProcessor &	task_processor,
		Deadline	deadline,
		Function &&	f,
		Args &&...	args
	)

Runs an asynchronous function call with deadline using specified task processor

Definition at line 67 of file async.hpp.

◆ SharedAsyncNoSpan() [4/4]

template<typename Function , typename... Args>

auto engine::SharedAsyncNoSpan	(	TaskProcessor &	task_processor,
		Function &&	f,
		Args &&...	args
	)

Runs an asynchronous function call using specified task processor.

Definition at line 47 of file async.hpp.

◆ SharedCriticalAsyncNoSpan() [1/2]

template<typename Function , typename... Args>

auto engine::SharedCriticalAsyncNoSpan	(	Function &&	f,
		Args &&...	args
	)

Runs an asynchronous function call that will start regardless of cancellations using task processor of the caller.

See also: Task::Importance::Critical

Definition at line 145 of file async.hpp.

◆ SharedCriticalAsyncNoSpan() [2/2]

template<typename Function , typename... Args>

auto engine::SharedCriticalAsyncNoSpan	(	TaskProcessor &	task_processor,
		Function &&	f,
		Args &&...	args
	)

Runs an asynchronous function call that will start regardless of cancellations using specified task processor.

See also: Task::Importance::Critical

Definition at line 124 of file async.hpp.

◆ SleepFor()

template<typename Rep , typename Period >

void engine::SleepFor ( const std::chrono::duration< Rep, Period > & duration )

Suspends execution for at least a specified amount of time.

Definition at line 43 of file sleep.hpp.

◆ SleepUntil()

template<typename Clock , typename Duration >

void engine::SleepUntil ( const std::chrono::time_point< Clock, Duration > & time_point )

Suspends execution until the specified time point is reached.

Definition at line 49 of file sleep.hpp.

◆ WaitAllCheckedFor()

template<typename... Tasks, typename Rep , typename Period >

FutureStatus engine::WaitAllCheckedFor	(	const std::chrono::duration< Rep, Period > &	duration,
		Tasks &...	tasks
	)

Definition at line 106 of file wait_all_checked.hpp.

◆ WaitAllCheckedUntil() [1/2]

template<typename... Tasks, typename Clock , typename Duration >

FutureStatus engine::WaitAllCheckedUntil	(	const std::chrono::time_point< Clock, Duration > &	until,
		Tasks &...	tasks
	)

Definition at line 112 of file wait_all_checked.hpp.

◆ WaitAllCheckedUntil() [2/2]

template<typename... Tasks>

FutureStatus engine::WaitAllCheckedUntil	(	Deadline	deadline,
		Tasks &...	tasks
	)

Definition at line 118 of file wait_all_checked.hpp.

◆ WaitAnyFor()

template<typename... Tasks, typename Rep , typename Period >

std::optional< std::size_t > engine::WaitAnyFor	(	const std::chrono::duration< Rep, Period > &	duration,
		Tasks &...	tasks
	)

Definition at line 61 of file wait_any.hpp.

◆ WaitAnyUntil() [1/2]

template<typename... Tasks, typename Clock , typename Duration >

std::optional< std::size_t > engine::WaitAnyUntil	(	const std::chrono::time_point< Clock, Duration > &	until,
		Tasks &...	tasks
	)

Definition at line 67 of file wait_any.hpp.

◆ WaitAnyUntil() [2/2]

template<typename... Tasks>

std::optional< std::size_t > engine::WaitAnyUntil	(	Deadline	deadline,
		Tasks &...	tasks
	)

Definition at line 105 of file wait_any.hpp.

Namespaces

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ MpscQueue

Enumeration Type Documentation

◆ CvStatus

◆ FutureStatus

◆ TaskCancellationReason

Function Documentation

◆ AsyncNoSpan() [1/4]

◆ AsyncNoSpan() [2/4]

◆ AsyncNoSpan() [3/4]

◆ AsyncNoSpan() [4/4]

◆ CriticalAsyncNoSpan() [1/3]

◆ CriticalAsyncNoSpan() [2/3]

◆ CriticalAsyncNoSpan() [3/3]

◆ InterruptibleSleepFor()

◆ InterruptibleSleepUntil()

◆ RunStandalone()

◆ SharedAsyncNoSpan() [1/4]

◆ SharedAsyncNoSpan() [2/4]

◆ SharedAsyncNoSpan() [3/4]

◆ SharedAsyncNoSpan() [4/4]

◆ SharedCriticalAsyncNoSpan() [1/2]

◆ SharedCriticalAsyncNoSpan() [2/2]

◆ SleepFor()

◆ SleepUntil()

◆ WaitAllCheckedFor()

◆ WaitAllCheckedUntil() [1/2]

◆ WaitAllCheckedUntil() [2/2]

◆ WaitAnyFor()

◆ WaitAnyUntil() [1/2]

◆ WaitAnyUntil() [2/2]