tcp_socket_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 DIAG_CLIENT_LIB_LIB_DOIP_CLIENT_SOCKETS_TCP_SOCKET_HANDLER_H_
#define DIAG_CLIENT_LIB_LIB_DOIP_CLIENT_SOCKETS_TCP_SOCKET_HANDLER_H_
 
#include <atomic>
#include <optional>
#include <string>
#include <string_view>
 
#include "core/include/result.h"
#include "socket/tcp/tcp_client.h"
 
namespace doip_client {
// forward declaration
namespace channel {
namespace tcp_channel {
class DoipTcpChannel;
}  // namespace tcp_channel
}  // namespace channel
 
namespace sockets {
 
class TcpSocketHandler final {
 public:
  enum class SocketHandlerState : std::uint8_t {
    kSocketOffline = 0U,     
    kSocketOnline = 1U,      
    kSocketConnected = 2U,   
    kSocketDisconnected = 4U 
  };
 
  using TcpMessage = boost_support::socket::tcp::TcpMessage;
 
  using TcpMessagePtr = boost_support::socket::tcp::TcpMessagePtr;
 
  using TcpMessageConstPtr = boost_support::socket::tcp::TcpMessageConstPtr;
 
  using TcpChannel = channel::tcp_channel::DoipTcpChannel;
 
  TcpSocketHandler(std::string_view local_ip_address, TcpChannel &channel);
 
  ~TcpSocketHandler() = default;
 
  void Start();
 
  void Stop();
 
  core_type::Result<void> ConnectToHost(std::string_view host_ip_address, std::uint16_t host_port_num);
 
  core_type::Result<void> DisconnectFromHost();
 
  core_type::Result<void> Transmit(TcpMessageConstPtr tcp_message);
 
  SocketHandlerState GetSocketHandlerState() const;
 
 private:
  using TcpSocket = boost_support::socket::tcp::TcpClientSocket;
 
  std::string local_ip_address_;
 
  std::uint16_t local_port_num_;
 
  std::optional<TcpSocket> tcp_socket_;
 
  TcpChannel &channel_;
 
  std::atomic<SocketHandlerState> state_;
};
}  // namespace sockets
}  // namespace doip_client
#endif  // DIAG_CLIENT_LIB_LIB_DOIP_CLIENT_SOCKETS_TCP_SOCKET_HANDLER_H_