ignite::cancel_handle Class Reference

#include <cancel_handle.h>

Inheritance diagram for ignite::cancel_handle:

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

Static Public Member Functions
static IGNITE_API std::shared_ptr< cancel_handle >	create ()

Detailed Description

A handle which may be used to request the cancellation of execution.

Constructor & Destructor Documentation

~cancel_handle()

virtual ignite::cancel_handle::~cancel_handle ( )

virtualdefault

Destructor.

Member Function Documentation

cancel()

virtual IGNITE_API void ignite::cancel_handle::cancel ( )

inlinevirtual

Abruptly terminates an execution of an associated process.

Control flow will return after the process has been terminated and the resources associated with that process have been freed.

cancel_async()

virtual IGNITE_API void ignite::cancel_handle::cancel_async ( ignite_callback< void > callback )

pure virtual

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.

Implemented in ignite::cancel_handle_impl.

create()

std::shared_ptr< cancel_handle > ignite::cancel_handle::create ( )

staticnodiscard

A factory method to create a handle.

Returns

A new cancel handle.

get_token()

virtual IGNITE_API std::shared_ptr< cancellation_token > ignite::cancel_handle::get_token ( )

pure virtual

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.

Returns

A token associated with this handle.

Implemented in ignite::cancel_handle_impl.

is_cancelled()

virtual IGNITE_API bool ignite::cancel_handle::is_cancelled ( ) const

pure virtual

Flag indicating whether cancellation was requested or not.

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

Returns

true if the cancellation was requested.

Implemented in ignite::cancel_handle_impl.

---

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

• ignite/client/cancel_handle.h
• ignite/client/cancel_handle.cpp