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_SRC_DCM_CONVERSATION_CONVERSATION_H
#define DIAGNOSTIC_CLIENT_LIB_APPL_SRC_DCM_CONVERSATION_CONVERSATION_H
 
#include "core/include/result.h"
#include "diag-client/diagnostic_client.h"
#include "diag-client/diagnostic_client_conversation.h"
#include "diag-client/diagnostic_client_vehicle_info_message_type.h"
#include "uds_transport/connection.h"
 
namespace diag {
namespace client {
namespace conversation {
 
class Conversation {
 public:
  using IpAddress = DiagClientConversation::IpAddress;
 
  using ConnectResult = DiagClientConversation::ConnectResult;
 
  using DisconnectResult = DiagClientConversation::DisconnectResult;
 
  using DiagError = DiagClientConversation::DiagError;
 
  enum class ActivityStatusType : uint8_t { kActive = 0x00, kInactive = 0x01 };
 
 public:
  Conversation() noexcept = default;
 
  Conversation(const Conversation &other) noexcept = delete;
  Conversation &operator=(const Conversation &other) noexcept = delete;
 
  Conversation(Conversation &&other) noexcept = delete;
  Conversation &operator=(Conversation &&other) noexcept = delete;
 
  virtual ~Conversation() noexcept = default;
 
  virtual void Startup() noexcept = 0;
 
  virtual void Shutdown() noexcept = 0;
 
  virtual void RegisterConnection(
      std::unique_ptr<::uds_transport::Connection> connection) noexcept = 0;
 
  virtual ::uds_transport::ConversionHandler &GetConversationHandler() noexcept = 0;
 
  virtual ConnectResult ConnectToDiagServer(std::uint16_t, IpAddress) noexcept {
    return ConnectResult::kConnectFailed;
  }
 
  virtual DisconnectResult DisconnectFromDiagServer() noexcept {
    return DisconnectResult::kDisconnectFailed;
  }
 
  virtual std::pair<::uds_transport::UdsTransportProtocolMgr::IndicationResult,
                    ::uds_transport::UdsMessagePtr>
  IndicateMessage(::uds_transport::UdsMessage::Address source_addr,
                  ::uds_transport::UdsMessage::Address target_addr,
                  ::uds_transport::UdsMessage::TargetAddressType type,
                  ::uds_transport::ChannelID channel_id, std::size_t size,
                  ::uds_transport::Priority priority, ::uds_transport::ProtocolKind protocol_kind,
                  core_type::Span<std::uint8_t const> payload_info) noexcept = 0;
 
  virtual void HandleMessage(::uds_transport::UdsMessagePtr message) noexcept = 0;
 
  virtual Result<uds_message::UdsResponseMessagePtr, DiagError> SendDiagnosticRequest(
      uds_message::UdsRequestMessageConstPtr) noexcept {
    return Result<uds_message::UdsResponseMessagePtr, DiagError>::FromError(
        DiagError::kDiagRequestSendFailed);
  }
 
  virtual core_type::Result<diag::client::vehicle_info::VehicleInfoMessageResponseUniquePtr,
                            DiagClient::VehicleInfoResponseError>
  SendVehicleIdentificationRequest(vehicle_info::VehicleInfoListRequestType) noexcept {
    return core_type::Result<diag::client::vehicle_info::VehicleInfoMessageResponseUniquePtr,
                             DiagClient::VehicleInfoResponseError>::
        FromError(DiagClient::VehicleInfoResponseError::kTransmitFailed);
  }
 
  auto GetActivityStatus() const noexcept -> ActivityStatusType { return activity_status_; }
 
 protected:
  ActivityStatusType activity_status_{ActivityStatusType::kInactive};
};
 
}  // namespace conversation
}  // namespace client
}  // namespace diag
 
#endif  // DIAGNOSTIC_CLIENT_LIB_APPL_SRC_DCM_CONVERSATION_CONVERSATION_H