connection.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_LIB_UDS_TRANSPORT_LAYER_API_UDS_TRANSPORT_CONNECTION_H
#define DIAGNOSTIC_CLIENT_LIB_LIB_UDS_TRANSPORT_LAYER_API_UDS_TRANSPORT_CONNECTION_H
 
/* includes */
#include <cstdint>
#include <string>
#include <string_view>
 
#include "core/include/span.h"
#include "uds_transport/protocol_handler.h"
#include "uds_transport/protocol_mgr.h"
#include "uds_transport/protocol_types.h"
 
namespace uds_transport {
namespace {
 
template<typename... T>
std::string Append(T... args) {
  std::string appended_name{};
  (appended_name.append(args), ...);
  return appended_name;
}
 
inline std::string CreateConnectionName(std::string_view connection_name,
                                        std::uint8_t connection_id) {
  std::string final_connection_name{connection_name};
  final_connection_name.append(std::to_string(connection_id));
  return final_connection_name;
}
}  // namespace
 
class Connection {
 public:
  using ConnectionId = std::uint8_t;
 
  using InitializationResult = uds_transport::UdsTransportProtocolHandler::InitializationResult;
 
  Connection(std::string_view connection_name, ConnectionId connection_id,
             uds_transport::ConversionHandler const &conversation_handler) noexcept
      : conversation_handler_{conversation_handler},
        connection_id_{connection_id},
        connection_name_{CreateConnectionName(connection_name, connection_id_)} {}
 
  virtual ~Connection() = default;
 
  virtual InitializationResult Initialize() = 0;
 
  [[nodiscard]] ConnectionId GetConnectionId() const noexcept { return connection_id_; }
 
  [[nodiscard]] std::string_view GetConnectionName() const noexcept { return connection_name_; }
 
  virtual void Start() = 0;
 
  virtual void Stop() = 0;
 
  virtual bool IsConnectToHost() = 0;
 
  virtual UdsTransportProtocolMgr::ConnectionResult ConnectToHost(UdsMessageConstPtr message) = 0;
 
  virtual UdsTransportProtocolMgr::DisconnectionResult DisconnectFromHost() = 0;
 
  virtual std::pair<UdsTransportProtocolMgr::IndicationResult, UdsMessagePtr> IndicateMessage(
      UdsMessage::Address source_addr, UdsMessage::Address target_addr,
      UdsMessage::TargetAddressType type, ChannelID channel_id, std::size_t size, Priority priority,
      ProtocolKind protocol_kind, core_type::Span<std::uint8_t const> payload_info) = 0;
 
  virtual UdsTransportProtocolMgr::TransmissionResult Transmit(UdsMessageConstPtr message) = 0;
 
  virtual void HandleMessage(UdsMessagePtr message) = 0;
 
 protected:
  uds_transport::ConversionHandler const &conversation_handler_;
 
 private:
  ConnectionId connection_id_;
 
  std::string connection_name_;
};
 
}  // namespace uds_transport
 
#endif  // DIAGNOSTIC_CLIENT_LIB_LIB_UDS_TRANSPORT_LAYER_API_UDS_TRANSPORT_CONNECTION_H