AsyncControl Class Reference

Class used to cancel async operation. More...

#include <mip/common_types.h>

Public Member Functions
virtual bool	Cancel ()=0
	Calling cancel will result in a attempt to cancel the task, in case of success the appropriate onFailure callback will be called with mip::OperationCancelledError. This feature is dependent on the task dispatcher delegate (.
virtual	~AsyncControl ()=default

Detailed Description

Class used to cancel async operation.

Constructor & Destructor Documentation

~AsyncControl()

virtual AsyncControl::~AsyncControl ( )

virtualdefault

Member Function Documentation

Cancel()

virtual bool AsyncControl::Cancel ( )

pure virtual

Calling cancel will result in a attempt to cancel the task, in case of success the appropriate onFailure callback will be called with mip::OperationCancelledError. This feature is dependent on the task dispatcher delegate (.

See also

mip::TaskDispatcherDelegate),

Returns

false if cancel signal cannot be dispatched, true otherwise.

Note

Do not hold a strong reference to an AsyncControl object in a task completion block.

---

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

• src/api/mip/common_types.h