diagnostic_client.h

Go to the documentation of this file.

/* Diagnostic Client library
 * Copyright (C) 2024  Avijit Dey
 * 
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
#ifndef DIAG_CLIENT_LIB_APPL_INCLUDE_DIAGNOSTIC_CLIENT_H_
#define DIAG_CLIENT_LIB_APPL_INCLUDE_DIAGNOSTIC_CLIENT_H_
 
#include <functional>
#include <memory>
#include <string_view>
 
#include "diag-client/diagnostic_client_conversation.h"
#include "diag-client/diagnostic_client_result.h"
#include "diag-client/diagnostic_client_vehicle_info_message_type.h"
 
namespace diag {
namespace client {
 
class DiagClient final {
 public:
  enum class VehicleInfoResponseError : std::uint8_t {
    kTransmitFailed = 0U,     
    kInvalidParameters = 1U,  
    kNoResponseReceived = 2U, 
  };
 
 public:
  explicit DiagClient(std::string_view diag_client_config_path) noexcept;
 
  DiagClient(const DiagClient &other) noexcept = delete;
  DiagClient &operator=(const DiagClient &other) noexcept = delete;
 
  DiagClient(DiagClient &&other) noexcept = delete;
  DiagClient &operator=(DiagClient &&other) noexcept = delete;
 
  ~DiagClient() noexcept;
 
  Result<void> Initialize() noexcept;
 
  Result<void> DeInitialize() noexcept;
 
  Result<vehicle_info::VehicleInfoMessageResponseUniquePtr, VehicleInfoResponseError>
  SendVehicleIdentificationRequest(
      diag::client::vehicle_info::VehicleInfoListRequestType vehicle_info_request) noexcept;
 
  conversation::DiagClientConversation GetDiagnosticClientConversation(
      std::string_view conversation_name) noexcept;
 
 private:
  class DiagClientImpl;
 
  std::unique_ptr<DiagClientImpl> diag_client_impl_;
};
 
}  // namespace client
}  // namespace diag
#endif  // DIAG_CLIENT_LIB_APPL_INCLUDE_DIAGNOSTIC_CLIENT_H_