NetworkSettings.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 <chrono>
#include <cstdint>
#include <string>
#include <vector>
 
#include <olp/core/CoreApi.h>
#include <olp/core/http/NetworkProxySettings.h>
#include <olp/core/http/NetworkTypes.h>
#include <olp/core/porting/deprecated.h>
 
namespace olp {
namespace http {
 
class CORE_API NetworkSettings final {
 public:
  std::chrono::milliseconds GetConnectionTimeoutDuration() const;
 
#ifdef OLP_SDK_NETWORK_IOS_BACKGROUND_DOWNLOAD
  std::chrono::milliseconds GetBackgroundConnectionTimeoutDuration() const;
#endif  // OLP_SDK_NETWORK_IOS_BACKGROUND_DOWNLOAD
 
  NetworkSettings& WithConnectionTimeout(std::chrono::milliseconds timeout);
 
#ifdef OLP_SDK_NETWORK_IOS_BACKGROUND_DOWNLOAD
  NetworkSettings& WithBackgroundConnectionTimeout(
      std::chrono::milliseconds timeout);
#endif  // OLP_SDK_NETWORK_IOS_BACKGROUND_DOWNLOAD
 
  std::chrono::milliseconds GetTransferTimeoutDuration() const;
 
  std::chrono::seconds GetMaxConnectionLifetime() const;
 
  NetworkSettings& WithMaxConnectionLifetime(std::chrono::seconds lifetime);
 
  NetworkSettings& WithTransferTimeout(std::chrono::milliseconds timeout);
 
  const NetworkProxySettings& GetProxySettings() const;
 
  NetworkSettings& WithProxySettings(NetworkProxySettings settings);
 
  const std::vector<std::string>& GetDNSServers() const;
 
  NetworkSettings& WithDNSServers(std::vector<std::string> dns_servers);
 
 private:
  std::chrono::milliseconds connection_timeout_ = std::chrono::seconds(60);
#ifdef OLP_SDK_NETWORK_IOS_BACKGROUND_DOWNLOAD
  std::chrono::milliseconds background_connection_timeout_ =
      std::chrono::seconds(600);
#endif  // OLP_SDK_NETWORK_IOS_BACKGROUND_DOWNLOAD
  std::chrono::milliseconds transfer_timeout_ = std::chrono::seconds(30);
  std::chrono::seconds connection_lifetime_{0};
  NetworkProxySettings proxy_settings_;
  std::vector<std::string> dns_servers_;
};
 
}  // namespace http
}  // namespace olp