A wrapper that manages the cancellation state of an asynchronous operation in a thread-safe way. More...

Public Types
using	ExecuteFuncType = std::function< CancellationToken()>
	An alias for the operation function.

using	CancelFuncType = std::function< void()>
	An alias for the cancellation function.

Public Member Functions
bool	ExecuteOrCancelled (const ExecuteFuncType &execute_fn, const CancelFuncType &cancel_fn=nullptr)
	Executes the given cancellable code block if the operation is not cancelled. More...

void	CancelOperation ()
	Cancels the ongoing operation in a thread-safe way.

bool	IsCancelled () const
	Checks whether this context is cancelled. More...

Friends
struct	CancellationContextHash
	A helper for unordered containers.

Detailed Description

A wrapper that manages the cancellation state of an asynchronous operation in a thread-safe way.

All public APIs are thread-safe.

This class is both movable and copyable.

Member Function Documentation

bool olp::client::CancellationContext::ExecuteOrCancelled	(	const ExecuteFuncType &	execute_fn,
		const CancelFuncType &	cancel_fn = `nullptr`
	)

inline

Executes the given cancellable code block if the operation is not cancelled.

Otherwise, executes the custom cancellation function.

Parameters

execute_fn	The function that should be executed if this operation is not cancelled. This function should return `CancellationToken` for which `CancellationContext` propagates a cancel request.
cancel_fn	The function that is called if this operation is cancelled.

Returns: True if the execution is successful; false if the context was cancelled.

bool olp::client::CancellationContext::IsCancelled ( ) const

inline

Checks whether this context is cancelled.

The documentation for this class was generated from the following files: