VersionedLayerClient.h

/*
 * Copyright (C) 2019-2024 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 <memory>
#include <string>
#include <vector>
 
#include <olp/core/client/ApiError.h>
#include <olp/core/client/ApiResponse.h>
#include <olp/core/client/CancellationToken.h>
#include <olp/core/client/HRN.h>
#include <olp/core/client/OlpClientSettings.h>
#include <olp/dataservice/read/DataRequest.h>
#include <olp/dataservice/read/DataServiceReadApi.h>
#include <olp/dataservice/read/PartitionsRequest.h>
#include <olp/dataservice/read/PrefetchPartitionsRequest.h>
#include <olp/dataservice/read/PrefetchTileResult.h>
#include <olp/dataservice/read/PrefetchTilesRequest.h>
#include <olp/dataservice/read/TileRequest.h>
#include <olp/dataservice/read/Types.h>
#include <boost/optional.hpp>
 
namespace olp {
namespace dataservice {
namespace read {
class VersionedLayerClientImpl;
 
// clang-format off
// clang-format on
class DATASERVICE_READ_API VersionedLayerClient final {
 public:
  VersionedLayerClient(client::HRN catalog, std::string layer_id,
                       boost::optional<int64_t> catalog_version,
                       client::OlpClientSettings settings);
 
  VersionedLayerClient(const VersionedLayerClient& other) = delete;
 
  VersionedLayerClient(VersionedLayerClient&& other) noexcept;
 
  VersionedLayerClient& operator=(const VersionedLayerClient& other) = delete;
 
  VersionedLayerClient& operator=(VersionedLayerClient&& other) noexcept;
 
  ~VersionedLayerClient();
 
  bool CancelPendingRequests();
 
  client::CancellationToken GetData(DataRequest data_request,
                                    DataResponseCallback callback);
 
  client::CancellableFuture<DataResponse> GetData(DataRequest data_request);
 
  client::CancellationToken GetData(TileRequest request,
                                    DataResponseCallback callback);
  client::CancellableFuture<DataResponse> GetData(TileRequest request);
 
  client::CancellationToken GetAggregatedData(
      TileRequest request, AggregatedDataResponseCallback callback);
 
  client::CancellableFuture<AggregatedDataResponse> GetAggregatedData(
      TileRequest request);
 
  client::CancellationToken GetPartitions(PartitionsRequest partitions_request,
                                          PartitionsResponseCallback callback);
 
  client::CancellationToken StreamLayerPartitions(
      PartitionsRequest partitions_request,
      PartitionsStreamCallback partition_stream_callback,
      CallbackNoResult callback);
 
  client::CancellableFuture<PartitionsResponse> GetPartitions(
      PartitionsRequest partitions_request);
 
  client::CancellationToken QuadTreeIndex(TileRequest tile_request,
                                          PartitionsResponseCallback callback);
 
  client::CancellationToken PrefetchTiles(
      PrefetchTilesRequest request, PrefetchTilesResponseCallback callback,
      PrefetchStatusCallback status_callback = nullptr);
 
  client::CancellableFuture<PrefetchTilesResponse> PrefetchTiles(
      PrefetchTilesRequest request,
      PrefetchStatusCallback status_callback = nullptr);
 
  client::CancellationToken PrefetchPartitions(
      PrefetchPartitionsRequest request,
      PrefetchPartitionsResponseCallback callback,
      PrefetchPartitionsStatusCallback status_callback = nullptr);
 
  client::CancellableFuture<PrefetchPartitionsResponse> PrefetchPartitions(
      PrefetchPartitionsRequest request,
      PrefetchPartitionsStatusCallback status_callback = nullptr);
 
  bool RemoveFromCache(const std::string& partition_id);
 
  bool RemoveFromCache(const geo::TileKey& tile);
 
  client::ApiNoResponse DeleteFromCache(const std::string& partition_id);
 
  client::ApiNoResponse DeleteFromCache(const geo::TileKey& tile);
 
  bool IsCached(const std::string& partition_id) const;
 
  bool IsCached(const geo::TileKey& tile, bool aggregated = false) const;
 
  bool Protect(const TileKeys& tiles);
 
  bool Protect(const std::string& partition_id);
 
  bool Protect(const std::vector<std::string>& partition_ids);
 
  bool Release(const TileKeys& tiles);
 
  bool Release(const std::string& partition_id);
 
  bool Release(const std::vector<std::string>& partition_ids);
 
 private:
  std::unique_ptr<VersionedLayerClientImpl> impl_;
};
 
}  // namespace read
}  // namespace dataservice
}  // namespace olp