VolatileLayerClient.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 <memory>
#include <vector>
 
#include <olp/core/client/ApiError.h>
#include <olp/core/client/ApiNoResult.h>
#include <olp/core/client/ApiResponse.h>
#include <olp/core/client/OlpClientSettings.h>
#include <olp/core/porting/deprecated.h>
 
#include <olp/dataservice/write/DataServiceWriteApi.h>
#include <olp/dataservice/write/generated/model/Publication.h>
#include <olp/dataservice/write/generated/model/ResponseOkSingle.h>
#include <olp/dataservice/write/model/PublishPartitionDataRequest.h>
#include <olp/dataservice/write/model/StartBatchRequest.h>
#include <olp/dataservice/write/model/VersionResponse.h>
 
namespace olp {
namespace client {
struct Error;
class HRN;
}  // namespace client
 
namespace dataservice {
namespace write {
class VolatileLayerClientImpl;
 
using PublishPartitionDataResult =
    olp::dataservice::write::model::ResponseOkSingle;
using PublishPartitionDataResponse =
    client::ApiResponse<PublishPartitionDataResult, client::ApiError>;
using PublishPartitionDataCallback =
    std::function<void(PublishPartitionDataResponse response)>;
 
using GetBaseVersionResult = model::VersionResponse;
using GetBaseVersionResponse =
    client::ApiResponse<GetBaseVersionResult, client::ApiError>;
using GetBaseVersionCallback = std::function<void(GetBaseVersionResponse)>;
 
using StartBatchResult = model::Publication;
using StartBatchResponse =
    client::ApiResponse<StartBatchResult, client::ApiError>;
using StartBatchCallback = std::function<void(StartBatchResponse)>;
 
using GetBatchResult = model::Publication;
using GetBatchResponse = client::ApiResponse<GetBatchResult, client::ApiError>;
using GetBatchCallback = std::function<void(GetBatchResponse)>;
 
using PublishToBatchResult = client::ApiNoResult;
using PublishToBatchResponse =
    client::ApiResponse<PublishToBatchResult, client::ApiError>;
using PublishToBatchCallback =
    std::function<void(PublishToBatchResponse response)>;
 
using CompleteBatchResult = client::ApiNoResult;
using CompleteBatchResponse =
    client::ApiResponse<CompleteBatchResult, client::ApiError>;
using CompleteBatchCallback =
    std::function<void(CompleteBatchResponse response)>;
 
class DATASERVICE_WRITE_API VolatileLayerClient {
 public:
  VolatileLayerClient(client::HRN catalog, client::OlpClientSettings settings);
 
  void CancelPendingRequests();
 
  olp::client::CancellableFuture<PublishPartitionDataResponse>
  PublishPartitionData(model::PublishPartitionDataRequest request);
 
  olp::client::CancellationToken PublishPartitionData(
      model::PublishPartitionDataRequest request,
      PublishPartitionDataCallback callback);
 
  olp::client::CancellableFuture<GetBaseVersionResponse> GetBaseVersion();
 
  olp::client::CancellationToken GetBaseVersion(
      GetBaseVersionCallback callback);
 
  olp::client::CancellableFuture<StartBatchResponse> StartBatch(
      model::StartBatchRequest request);
 
  olp::client::CancellationToken StartBatch(model::StartBatchRequest request,
                                            StartBatchCallback callback);
 
  olp::client::CancellableFuture<GetBatchResponse> GetBatch(
      const model::Publication& pub);
 
  olp::client::CancellationToken GetBatch(const model::Publication& pub,
                                          GetBatchCallback callback);
 
  olp::client::CancellableFuture<PublishToBatchResponse> PublishToBatch(
      const model::Publication& pub,
      const std::vector<model::PublishPartitionDataRequest>& partitions);
 
  olp::client::CancellationToken PublishToBatch(
      const model::Publication& pub,
      const std::vector<model::PublishPartitionDataRequest>& partitions,
      PublishToBatchCallback callback);
 
  olp::client::CancellableFuture<CompleteBatchResponse> CompleteBatch(
      const model::Publication& pub);
 
  olp::client::CancellationToken CompleteBatch(const model::Publication& pub,
                                               CompleteBatchCallback callback);
 
 private:
  std::shared_ptr<VolatileLayerClientImpl> impl_;
};
 
}  // namespace write
}  // namespace dataservice
}  // namespace olp