diagnostic_client_conversation.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 DIAGNOSTIC_CLIENT_LIB_APPL_INCLUDE_DIAGNOSTIC_CLIENT_CONVERSATION_H
#define DIAGNOSTIC_CLIENT_LIB_APPL_INCLUDE_DIAGNOSTIC_CLIENT_CONVERSATION_H
 
#include <cstdint>
 
#include "diag-client/diagnostic_client_result.h"
#include "diag-client/diagnostic_client_uds_message_type.h"
 
namespace diag {
namespace client {
namespace conversation {
 
class DiagClientConversation final {
 public:
  using IpAddress = uds_message::UdsMessage::IpAddress;
 
 public:
  enum class ConnectResult : std::uint8_t {
    kConnectSuccess = 0U, 
    kConnectFailed =
        1U, 
    kConnectTimeout = 2U, 
    kTlsRequired =
        3U 
  };
 
  enum class DisconnectResult : std::uint8_t {
    kDisconnectSuccess = 0U, 
    kDisconnectFailed =
        1U, 
    kAlreadyDisconnected = 2U 
  };
 
  enum class DiagError : std::uint8_t {
    kDiagGenericFailure = 1U,    
    kDiagRequestSendFailed = 2U, 
    kDiagAckTimeout = 3U, 
    kDiagNegAckReceived = 4U,  
    kDiagResponseTimeout = 5U, 
    kDiagInvalidParameter = 6U, 
    kDiagBusyProcessing = 7U    
  };
 
  explicit DiagClientConversation(std::string_view conversation_name) noexcept;
 
  DiagClientConversation(const DiagClientConversation &other) noexcept = delete;
  DiagClientConversation &operator=(const DiagClientConversation &other) noexcept = delete;
 
  DiagClientConversation(DiagClientConversation &&other) noexcept = default;
  DiagClientConversation &operator=(DiagClientConversation &&other) noexcept = default;
 
  ~DiagClientConversation() noexcept;
 
  void Startup() noexcept;
 
  void Shutdown() noexcept;
 
  ConnectResult ConnectToDiagServer(std::uint16_t target_address, IpAddress host_ip_addr) noexcept;
 
  DisconnectResult DisconnectFromDiagServer() noexcept;
 
  Result<uds_message::UdsResponseMessagePtr, DiagError> SendDiagnosticRequest(
      uds_message::UdsRequestMessageConstPtr message) noexcept;
 
 private:
  class DiagClientConversationImpl;
 
  std::unique_ptr<DiagClientConversationImpl> diag_client_conversation_impl_;
};
}  // namespace conversation
}  // namespace client
}  // namespace diag
#endif  // DIAGNOSTIC_CLIENT_LIB_APPL_INCLUDE_DIAGNOSTIC_CLIENT_CONVERSATION_H