RAII guard for automatic callback unregistration. More...

#include <enhanced_cancellation_token.h>

Collaboration diagram for kcenon::thread::cancellation_callback_guard:

Public Member Functions
	cancellation_callback_guard (enhanced_cancellation_token &token, std::function< void()> callback)
	Constructs a guard and registers the callback.

	~cancellation_callback_guard ()
	Destructor unregisters the callback.

	cancellation_callback_guard (const cancellation_callback_guard &)=delete

auto	operator= (const cancellation_callback_guard &) -> cancellation_callback_guard &=delete

	cancellation_callback_guard (cancellation_callback_guard &&other) noexcept
	Move constructor.

auto	operator= (cancellation_callback_guard &&other) noexcept -> cancellation_callback_guard &
	Move assignment.

Private Attributes
enhanced_cancellation_token *	token_

enhanced_cancellation_token::callback_handle	handle_

Detailed Description

RAII guard for automatic callback unregistration.

Automatically unregisters a callback when the guard goes out of scope. Useful for ensuring callbacks are properly cleaned up.

Usage Example

{
    cancellation_callback_guard guard(token, [] {
        cleanup_resources();
    });
 
    do_interruptible_work();
}  // Callback auto-unregistered here

Definition at line 358 of file enhanced_cancellation_token.h.

Constructor & Destructor Documentation

◆ cancellation_callback_guard() [1/3]

kcenon::thread::cancellation_callback_guard::cancellation_callback_guard	(	enhanced_cancellation_token &	token,
		std::function< void()>	callback )

Constructs a guard and registers the callback.

Parameters

token	The token to register with.
callback	The callback to register.

Definition at line 533 of file enhanced_cancellation_token.cpp.

        : token_(&token), handle_(token.register_callback(std::move(callback)))
    {
    }

◆ ~cancellation_callback_guard()

kcenon::thread::cancellation_callback_guard::~cancellation_callback_guard ( )

Destructor unregisters the callback.

Definition at line 540 of file enhanced_cancellation_token.cpp.

    {
        if (token_ && handle_ != 0)
        {
            token_->unregister_callback(handle_);
        }
    }

References handle_, token_, and kcenon::thread::enhanced_cancellation_token::unregister_callback().

Here is the call graph for this function:

◆ cancellation_callback_guard() [2/3]

kcenon::thread::cancellation_callback_guard::cancellation_callback_guard ( const cancellation_callback_guard & )

delete

◆ cancellation_callback_guard() [3/3]

kcenon::thread::cancellation_callback_guard::cancellation_callback_guard ( cancellation_callback_guard && other )

noexcept

Move constructor.

Definition at line 548 of file enhanced_cancellation_token.cpp.

        : token_(other.token_), handle_(other.handle_)
    {
        other.token_ = nullptr;
        other.handle_ = 0;
    }

Member Function Documentation

◆ operator=() [1/2]

auto kcenon::thread::cancellation_callback_guard::operator= ( cancellation_callback_guard && other ) -> cancellation_callback_guard&

noexcept

Move assignment.

Definition at line 556 of file enhanced_cancellation_token.cpp.

    {
        if (this != &other)
        {
            if (token_ && handle_ != 0)
            {
                token_->unregister_callback(handle_);
            }
            token_ = other.token_;
            handle_ = other.handle_;
            other.token_ = nullptr;
            other.handle_ = 0;
        }
        return *this;
    }