cancel_handle.h

Go to the documentation of this file.

/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

 
#pragma once
 
#include "ignite/client/cancellation_token.h"
#include "ignite/common/ignite_result.h"
#include "ignite/common/detail/config.h"
 
#include <memory>
 
namespace ignite
{

class cancel_handle
{
public:
    virtual ~cancel_handle() = default;

    [[nodiscard]] IGNITE_API static std::shared_ptr<cancel_handle> create();

    IGNITE_API virtual void cancel_async(ignite_callback<void> callback) = 0;

    IGNITE_API virtual void cancel() {
        return sync<void>([this](auto callback) mutable {
            cancel_async(std::move(callback));
        });
    }

    IGNITE_API virtual bool is_cancelled() const = 0;

    IGNITE_API virtual std::shared_ptr<cancellation_token> get_token() = 0;
};
 
} // namespace ignite