NetworkResponse.h

/*
 * Copyright (C) 2019-2025 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 <array>
#include <bitset>
#include <chrono>
#include <string>
 
#include <boost/optional/optional.hpp>
 
#include <olp/core/CoreApi.h>
#include <olp/core/http/NetworkTypes.h>
 
namespace olp {
namespace http {
 
struct Diagnostics {
  using MicroSeconds = std::chrono::duration<uint32_t, std::micro>;
 
  enum Timings {
    Queue = 0,      // Delay until the request is processed
    NameLookup,     // Time taken for DNS name lookup
    Connect,        // Time taken to establish connection
    SSL_Handshake,  // Time taken to establish a secured connection
    Send,           // Time taken to send the request
    Wait,           // Time delay until server starts responding
    Receive,        // Time taken to receive the response
    Total,          // Total time taken for reqeust
    Count
  };
 
  std::array<MicroSeconds, Count> timings{};
 
  std::bitset<Count> available_timings{};
};
 
class CORE_API NetworkResponse final {
 public:
  bool IsCancelled() const;
 
  int GetStatus() const;
 
  NetworkResponse& WithStatus(int status);
 
  const std::string& GetError() const;
 
  NetworkResponse& WithError(std::string error);
 
  RequestId GetRequestId() const;
 
  NetworkResponse& WithRequestId(RequestId id);
 
  uint64_t GetBytesUploaded() const;
 
  NetworkResponse& WithBytesUploaded(uint64_t bytes_uploaded);
 
  uint64_t GetBytesDownloaded() const;
 
  NetworkResponse& WithBytesDownloaded(uint64_t bytes_downloaded);
 
  const boost::optional<Diagnostics>& GetDiagnostics() const;
 
  NetworkResponse& WithDiagnostics(Diagnostics diagnostics);
 
 private:
  RequestId request_id_{0};
  int status_{0};
  std::string error_;
  uint64_t bytes_uploaded_{0};
  uint64_t bytes_downloaded_{0};
  boost::optional<Diagnostics> diagnostics_;
};
 
}  // namespace http
}  // namespace olp