Network.h

/*
 * Copyright (C) 2019-2023 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 <cstdint>
#include <functional>
#include <memory>
#include <string>
 
#include "olp/core/CoreApi.h"
#include "olp/core/http/NetworkInitializationSettings.h"
#include "olp/core/http/NetworkRequest.h"
#include "olp/core/http/NetworkResponse.h"
#include "olp/core/http/NetworkTypes.h"
 
namespace olp {
namespace http {
 
class CORE_API Network {
 public:
  using Callback = std::function<void(NetworkResponse response)>;
 
  using HeaderCallback =
      std::function<void(std::string key, std::string value)>;
 
  using DataCallback = std::function<void(
      const std::uint8_t* data, std::uint64_t offset, std::size_t length)>;
 
  using Payload = std::shared_ptr<std::ostream>;
 
  struct Statistics {
    uint64_t bytes_downloaded{0ull};
 
    uint64_t bytes_uploaded{0ull};
 
    uint32_t total_requests{0u};
 
    uint32_t total_failed{0u};
  };
 
  virtual ~Network() = default;
 
  virtual SendOutcome Send(NetworkRequest request, Payload payload,
                           Callback callback,
                           HeaderCallback header_callback = nullptr,
                           DataCallback data_callback = nullptr) = 0;
 
  virtual void Cancel(RequestId id) = 0;
 
  virtual void SetDefaultHeaders(Headers headers);
 
  virtual void SetCurrentBucket(uint8_t bucket_id);
 
  virtual Statistics GetStatistics(uint8_t bucket_id = 0);
};
 
OLP_SDK_DEPRECATED(
    "Will be removed by 05.2024, use "
    "CreateDefaultNetwork(NetworkInitializationSettings) instead")
CORE_API std::shared_ptr<Network> CreateDefaultNetwork(
    size_t max_requests_count);
 
CORE_API std::shared_ptr<Network> CreateDefaultNetwork(
    NetworkInitializationSettings settings);
 
}  // namespace http
}  // namespace olp