dm_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_DM_CONVERSATION_H
#define DIAGNOSTIC_CLIENT_LIB_APPL_SRC_DCM_CONVERSATION_DM_CONVERSATION_H
/* includes */
#include <string_view>
 
#include "diag-client/dcm/conversation/conversation.h"
#include "diag-client/dcm/conversation/dm_conversation_state_impl.h"
#include "diag-client/dcm/conversation/dm_conversation_type.h"
#include "diag-client/diagnostic_client_conversation.h"
#include "uds_transport/connection.h"
#include "uds_transport/protocol_types.h"
#include "utility/sync_timer.h"
 
namespace diag {
namespace client {
namespace conversation {
 
class DmConversation final : public Conversation {
 public:
  using ConversationState = conversation_state_impl::ConversationState;
  using SyncTimer = utility::sync_timer::SyncTimer<std::chrono::steady_clock>;
 
 public:
  DmConversation(std::string_view conversion_name, DMConversationType &conversion_identifier);
 
  DmConversation(const DmConversation &other) noexcept = delete;
  DmConversation &operator=(const DmConversation &other) noexcept = delete;
 
  DmConversation(DmConversation &&other) noexcept = delete;
  DmConversation &operator=(DmConversation &&other) noexcept = delete;
 
  ~DmConversation() override;
 
  void Startup() noexcept override;
 
  void Shutdown() noexcept override;
 
  void RegisterConnection(
      std::unique_ptr<::uds_transport::Connection> connection) noexcept override;
 
  ::uds_transport::ConversionHandler &GetConversationHandler() noexcept override;
 
  ConnectResult ConnectToDiagServer(std::uint16_t target_address,
                                    IpAddress host_ip_addr) noexcept override;
 
  DisconnectResult DisconnectFromDiagServer() noexcept override;
 
  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 override;
 
  void HandleMessage(::uds_transport::UdsMessagePtr message) noexcept override;
 
  Result<uds_message::UdsResponseMessagePtr, DiagError> SendDiagnosticRequest(
      uds_message::UdsRequestMessageConstPtr message) noexcept override;
 
 private:
  enum class SessionControlType : std::uint8_t {
    kDefaultSession = 0x01,
    kProgrammingSession = 0x02,
    kExtendedSession = 0x03,
    kSystemSafetySession = 0x04
  };
 
  enum class SecurityLevelType : std::uint8_t {
    kLocked = 0x00,
    kUnLocked = 0x01,
  };
 
 private:
  static DiagClientConversation::DiagError ConvertResponseType(
      ::uds_transport::UdsTransportProtocolMgr::TransmissionResult result_type);
 
  SessionControlType active_session_;
 
  SecurityLevelType active_security_level_;
 
  std::uint32_t rx_buffer_size_;
 
  std::uint16_t p2_client_max_;
 
  std::uint16_t p2_star_client_max_;
 
  std::uint16_t source_address_;
 
  std::uint16_t target_address_;
 
  std::string remote_address_;
 
  std::string conversation_name_;
 
  std::unique_ptr<::uds_transport::ConversionHandler> dm_conversion_handler_;
 
  std::unique_ptr<::uds_transport::Connection> connection_;
 
  SyncTimer sync_timer_;
 
  ::uds_transport::ByteVector payload_rx_buffer_;
 
  conversation_state_impl::ConversationStateImpl conversation_state_;
};
 
}  // namespace conversation
}  // namespace client
}  // namespace diag
 
#endif  // DIAGNOSTIC_CLIENT_LIB_APPL_SRC_DCM_CONVERSATION_DM_CONVERSATION_H