CancellationContext.h

/*
 * Copyright (C) 2019-2021 HERE Europe B.V.
 *
 * Licensed 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * License-Filename: LICENSE
 */
 
#pragma once
 
#include <functional>
#include <memory>
#include <mutex>
 
#include <olp/core/CoreApi.h>
#include <olp/core/client/CancellationToken.h>
 
namespace olp {
namespace client {
 
class CORE_API CancellationContext {
 public:
  using ExecuteFuncType = std::function<CancellationToken()>;
  using CancelFuncType = std::function<void()>;
 
  CancellationContext();
 
  bool ExecuteOrCancelled(const ExecuteFuncType& execute_fn,
                          const CancelFuncType& cancel_fn = nullptr);
 
  void CancelOperation();
 
  bool IsCancelled() const;
 
 private:
  friend struct CancellationContextHash;
  friend struct CancellationContextEquality;
 
  struct CancellationContextImpl {
    mutable std::recursive_mutex mutex_;
    CancellationToken sub_operation_cancel_token_{};
    bool is_cancelled_{false};
  };
 
  std::shared_ptr<CancellationContextImpl> impl_;
};
 
struct CORE_API CancellationContextHash {
  size_t operator()(const CancellationContext& context) const;
};
 
struct CORE_API CancellationContextEquality {
  bool operator()(const CancellationContext& lhs,
                  const CancellationContext& rhs) const;
};
 
}  // namespace client
}  // namespace olp
 
#include "CancellationContext.inl"