NetworkTypes.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 <cstdint>
#include <limits>
#include <string>
#include <utility>
#include <vector>
 
#include <olp/core/CoreApi.h>
 
namespace olp {
namespace http {
 
using RequestId = std::uint64_t;
 
enum class RequestIdConstants : RequestId {
  RequestIdInvalid = std::numeric_limits<RequestId>::min(),
  RequestIdMin = std::numeric_limits<RequestId>::min() + 1,
  RequestIdMax = std::numeric_limits<RequestId>::max(),
};
 
enum class ErrorCode {
  SUCCESS = 0,
  IO_ERROR = -1,
  AUTHORIZATION_ERROR = -2,
  INVALID_URL_ERROR = -3,
  OFFLINE_ERROR = -4,
  CANCELLED_ERROR = -5,
  AUTHENTICATION_ERROR = -6,
  TIMEOUT_ERROR = -7,          
  NETWORK_OVERLOAD_ERROR = -8, 
  UNKNOWN_ERROR = -9,          
};
 
class CORE_API SendOutcome final {
 public:
  static constexpr RequestId kInvalidRequestId =
      static_cast<RequestId>(RequestIdConstants::RequestIdInvalid);
 
  explicit SendOutcome(RequestId request_id) : request_id_(request_id) {}
 
  explicit SendOutcome(ErrorCode error_code) : error_code_(error_code) {}
 
  bool IsSuccessful() const {
    return error_code_ == ErrorCode::SUCCESS &&
           request_id_ != kInvalidRequestId;
  }
 
  RequestId GetRequestId() const { return request_id_; }
 
  ErrorCode GetErrorCode() const { return error_code_; }
 
 private:
  RequestId request_id_{kInvalidRequestId};
  ErrorCode error_code_{ErrorCode::SUCCESS};
};
 
CORE_API std::string ErrorCodeToString(ErrorCode code);
 
using Header = std::pair<std::string, std::string>;
 
using Headers = std::vector<Header>;
 
}  // namespace http
}  // namespace olp