tcp_client.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_BOOST_SUPPORT_INCLUDE_BOOST_SUPPORT_CLIENT_TCP_TCP_CLIENT_H_
#define DIAG_CLIENT_LIB_LIB_BOOST_SUPPORT_INCLUDE_BOOST_SUPPORT_CLIENT_TCP_TCP_CLIENT_H_
 
#include <functional>
#include <string_view>
 
#include "boost-support/message/tcp/tcp_message.h"
#include "core/include/result.h"
 
namespace boost_support {
namespace client {
namespace tcp {
 
class TcpClient final {
 public:
  using Message = boost_support::message::tcp::TcpMessage;
 
  using MessagePtr = boost_support::message::tcp::TcpMessagePtr;
 
  using MessageConstPtr = boost_support::message::tcp::TcpMessageConstPtr;
 
  using HandlerRead = std::function<void(MessagePtr)>;
 
 public:
  TcpClient(std::string_view client_name, std::string_view local_ip_address,
            std::uint16_t local_port_num) noexcept;
 
  TcpClient(const TcpClient &other) noexcept = delete;
  TcpClient &operator=(const TcpClient &other) noexcept = delete;
 
  TcpClient(TcpClient &&other) noexcept;
  TcpClient &operator=(TcpClient &&other) noexcept;
 
  ~TcpClient() noexcept;
 
  void Initialize() noexcept;
 
  void DeInitialize() noexcept;
 
  void SetReadHandler(HandlerRead read_handler) noexcept;
 
  core_type::Result<void> ConnectToHost(std::string_view host_ip_address,
                                        std::uint16_t host_port_num);
 
  core_type::Result<void> DisconnectFromHost();
 
  auto IsConnectedToHost() const noexcept -> bool;
 
  core_type::Result<void> Transmit(MessageConstPtr tcp_message);
 
 private:
  class TcpClientImpl;
 
  std::unique_ptr<TcpClientImpl> tcp_client_impl_;
};
 
}  // namespace tcp
}  // namespace client
}  // namespace boost_support
#endif  // DIAG_CLIENT_LIB_LIB_BOOST_SUPPORT_INCLUDE_BOOST_SUPPORT_CLIENT_TCP_TCP_CLIENT_H_