Inheritance diagram for ignite::cancel_handle_impl:

Public Member Functions
	cancel_handle_impl ()
	~cancel_handle_impl () override=default
IGNITE_API void	cancel_async (ignite_callback< void > callback) override
IGNITE_API bool	is_cancelled () const override
IGNITE_API std::shared_ptr< cancellation_token >	get_token () override
Public Member Functions inherited from ignite::cancel_handle
virtual	~cancel_handle ()=default
virtual IGNITE_API void	cancel ()

Additional Inherited Members
Static Public Member Functions inherited from ignite::cancel_handle
static IGNITE_API std::shared_ptr< cancel_handle >	create ()

Detailed Description

A cancel handle implementation.

Constructor & Destructor Documentation

ignite::cancel_handle_impl::cancel_handle_impl ( )

inline

Constructor.

ignite::cancel_handle_impl::~cancel_handle_impl ( )

overridedefault

Destructor.

IGNITE_API void ignite::cancel_handle_impl::cancel_async ( ignite_callback< void > callback )

inlineoverridevirtual

Abruptly terminates an execution of an associated process.

Parameters

callback A callback that will be called after the process has been terminated and the resources associated with that process have been freed.

IGNITE_API std::shared_ptr< cancellation_token > ignite::cancel_handle_impl::get_token ( )

inlineoverridevirtual

Issue a token associated with this handle.

Token is reusable, meaning the same token may be used to link several executions into a single cancellable.

IGNITE_API bool ignite::cancel_handle_impl::is_cancelled ( ) const

inlineoverridevirtual

Flag indicating whether cancellation was requested or not.

This method will return true even if cancellation has not been completed yet.

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