protocol_handler.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_PROTOCOL_HANDLER_H
#define DIAGNOSTIC_CLIENT_LIB_LIB_UDS_TRANSPORT_LAYER_API_UDS_TRANSPORT_PROTOCOL_HANDLER_H
 
#include <cstdint>
#include <memory>
#include <string_view>
 
#include "uds_transport/protocol_mgr.h"
 
namespace uds_transport {
// forward declaration
class Connection;
class ConversionHandler;
 
class UdsTransportProtocolHandler {
 public:
  using UdsTransportProtocolHandlerId = std::uint8_t;
 
  enum class InitializationResult : std::uint8_t { kInitializeOk = 0, kInitializeFailed = 1 };
 
  UdsTransportProtocolHandler(UdsTransportProtocolHandlerId const handler_id, UdsTransportProtocolMgr const&)
      : handler_id_{handler_id} {}
 
  virtual ~UdsTransportProtocolHandler() = default;
 
  virtual UdsTransportProtocolHandlerId GetHandlerID() const { return handler_id_; };
 
  virtual InitializationResult Initialize() = 0;
 
  virtual void Start() = 0;
 
  virtual void Stop() = 0;
 
  virtual std::unique_ptr<Connection> CreateTcpConnection(ConversionHandler& conversion_handler,
                                                          std::string_view tcpIpaddress, uint16_t portNum) = 0;
 
  virtual std::unique_ptr<Connection> CreateUdpConnection(ConversionHandler& conversion_handler,
                                                          std::string_view udpIpaddress, uint16_t portNum) = 0;
 
 protected:
  UdsTransportProtocolHandlerId handler_id_;
};
}  // namespace uds_transport
#endif  // DIAGNOSTIC_CLIENT_LIB_LIB_UDS_TRANSPORT_LAYER_API_UDS_TRANSPORT_PROTOCOL_HANDLER_H