cancelable_handle.hpp

Go to the documentation of this file.

//    OpenVPN -- An application to securely tunnel IP networks
//               over a single port, with support for SSL/TLS-based
//               session authentication and key exchange,
//               packet encryption, packet authentication, and
//               packet compression.
//
//    Copyright (C) 2025- OpenVPN Inc.
//
//    SPDX-License-Identifier: MPL-2.0 OR AGPL-3.0-only WITH openvpn3-openssl-exception
//
 
#include <openvpn/io/io.hpp>
#include <openvpn/win/winerr.hpp>
 
namespace openvpn {
 
class CancelableHandle
{
  public:
    CancelableHandle(openvpn_io::io_context &io_context)
        : handle_(io_context)
    {
    }
 
    ~CancelableHandle()
    {
        cancel_and_close();
    }
 
    void check_is_already_signalled()
    {
        DWORD status = ::WaitForSingleObject(handle_.native_handle(), 0);
        const Win::LastError err;
        switch (status)
        {
        case WAIT_TIMEOUT: // expected status
            break;
        case WAIT_OBJECT_0:
            throw Exception("CancelableHandle: destroy event is already signaled");
        case WAIT_ABANDONED:
            throw Exception("CancelableHandle: destroy event is abandoned");
        default:
            OPENVPN_THROW_EXCEPTION("CancelableHandle: WaitForSingleObject failed: " << err.message());
        }
    }
 
    void cancel_and_close()
    {
        if (!*is_closed_)
        {
            *is_closed_ = true;
            try
            {
                handle_.cancel();
            }
            catch (const openvpn_io::system_error &)
            {
                // this is fine, handle is likely not yet initialized
            }
 
            handle_.close();
        }
    }
 
    void assign(HANDLE handle)
    {
        handle_.assign(handle);
        is_closed_ = std::make_shared<bool>(false);
    }
 
    template <typename Handler>
    void async_wait(Handler &&handler)
    {
        handle_.async_wait([is_closed = is_closed_, handler = std::forward<Handler>(handler)](const openvpn_io::error_code &ec)
                           {
            if (!*is_closed)
            {
                handler(ec);
            } });
    }
 
  private:
    openvpn_io::windows::object_handle handle_;                       
    std::shared_ptr<bool> is_closed_ = std::make_shared<bool>(false); 
};
 
} // namespace openvpn