cancel.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/engine/task/cancel.hpp
/// @brief Task cancellation helpers
 
#include <string>
 
#include <boost/smart_ptr/intrusive_ptr.hpp>
 
#include <userver/engine/deadline.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace engine {
namespace impl {
class TaskContext;
}  // namespace impl
 
/// Task cancellation reason
enum class TaskCancellationReason {
    kNone,         ///< Not cancelled
    kUserRequest,  ///< User request
    kDeadline,     ///< Deadline
    kOverload,     ///< Task processor overload
    kOOM,          ///< Not enough memory
    kAbandoned,    ///< Task destructor is called before the payload finished
    kShutdown,     ///< Task processor shutdown
};
 
class Task;
class TaskCancellationToken;
 
namespace current_task {
 
/// Checks for pending cancellation requests, use
/// engine::current_task::ShouldCancel() instead, as the latter respects
/// engine::TaskCancellationBlocker.
///
/// @see @ref task_cancellation_intro
bool IsCancelRequested() noexcept;
 
/// Checks for pending *non-blocked* cancellation requests
///
/// @see engine::TaskCancellationBlocker
/// @see @ref task_cancellation_intro
bool ShouldCancel() noexcept;
 
/// Returns task cancellation reason for the current task
/// @see @ref task_cancellation_intro
TaskCancellationReason CancellationReason() noexcept;
 
/// @brief \b Throws an exception if a cancellation request for this task is
/// pending.
///
/// @throws unspecified (non-std) exception if cancellation is pending and not
/// blocked
///
/// @warning catching this exception without a rethrow in the same scope leads
/// to undefined behavior.
/// @see @ref task_cancellation_intro
void CancellationPoint();
 
/// Set deadline for the current task.
/// The task will be cancelled when the deadline is reached.
void SetDeadline(Deadline deadline);
 
/// @see engine::Task::RequestCancel
void RequestCancel();
 
/// @brief Return cancellation token for current coroutine.
/// @note Prefer engine::current_task::RequestCancel in most cases.
TaskCancellationToken GetCancellationToken();
 
}  // namespace current_task
 
/// Blocks cancellation for specific scopes, e.g. destructors.
/// Recursive, i.e. can be instantiated multiple times in a given call stack.
class TaskCancellationBlocker final {
public:
    TaskCancellationBlocker();
    ~TaskCancellationBlocker();
 
    TaskCancellationBlocker(const TaskCancellationBlocker&) = delete;
    TaskCancellationBlocker(TaskCancellationBlocker&&) = delete;
    TaskCancellationBlocker& operator=(const TaskCancellationBlocker&) = delete;
    TaskCancellationBlocker& operator=(TaskCancellationBlocker&&) = delete;
 
private:
    impl::TaskContext& context_;
    const bool was_allowed_;
};
 
/// Returns a string representation of a cancellation reason
std::string_view ToString(TaskCancellationReason reason) noexcept;
 
/// @brief Cancellation token to given task object
///
/// Unlike Task, TaskCancellationToken object doesn't wait for task finish in
/// its destructor. It is allowed to outlive the task object it was created
/// from. However, as long as there is any cancellation token associated with
/// given task, some internal structures of a task will not be freed.
///
/// General rule: whenever possible, prefer using engine::Task object instead.
class TaskCancellationToken final {
public:
    /// Creates an invalid TaskCancellationToken
    TaskCancellationToken() noexcept;
 
    /// Creates a TaskCancellationToken associated with a task. The task must be
    /// valid.
    explicit TaskCancellationToken(Task& task);
 
    TaskCancellationToken(const TaskCancellationToken&) noexcept;
    TaskCancellationToken(TaskCancellationToken&&) noexcept;
    TaskCancellationToken& operator=(const TaskCancellationToken&) noexcept;
    TaskCancellationToken& operator=(TaskCancellationToken&&) noexcept;
    ~TaskCancellationToken();
 
    /// @see engine::Task::RequestCancel
    /// This method should not be called on invalid TaskCancellationToken
    void RequestCancel();
 
    /// @see engine::Task::CancellationReason
    /// This method should not be called on invalid TaskCancellationToken
    TaskCancellationReason CancellationReason() const noexcept;
 
    /// @see @ref task_cancellation_intro
    /// True if there is pending cancellation request for the associated task
    /// This method should not be called on invalid TaskCancellationToken
    bool IsCancelRequested() const noexcept;
 
    /// True if this token is associated with a task
    bool IsValid() const noexcept;
 
private:
    friend TaskCancellationToken current_task::GetCancellationToken();
 
    explicit TaskCancellationToken(impl::TaskContext& context) noexcept;
 
    boost::intrusive_ptr<impl::TaskContext> context_;
};
 
}  // namespace engine
 
USERVER_NAMESPACE_END