tcp_socket.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_SOCKET_TCP_TCP_SOCKET_H_
#define DIAG_CLIENT_LIB_LIB_BOOST_SUPPORT_SOCKET_TCP_TCP_SOCKET_H_
 
#include <boost/asio.hpp>
 
#include "boost-support/message/tcp/tcp_message.h"
#include "boost-support/socket/io_context.h"
#include "core/include/result.h"
 
namespace boost_support {
namespace socket {
namespace tcp {
 
class TcpSocket final {
 public:
  enum class SocketError : std::uint8_t {
    kOpenFailed,
    kBindingFailed,
    kRemoteDisconnected,
    kGenericError
  };
 
  using TcpMessage = boost_support::message::tcp::TcpMessage;
 
  using TcpMessagePtr = boost_support::message::tcp::TcpMessagePtr;
 
  using TcpMessageConstPtr = boost_support::message::tcp::TcpMessageConstPtr;
 
  using Tcp = boost::asio::ip::tcp;
 
  using Socket = Tcp::socket;
 
 public:
  TcpSocket(std::string_view local_ip_address, std::uint16_t local_port_num,
            IoContext &io_context) noexcept;
 
  explicit TcpSocket(Socket socket) noexcept;
 
  TcpSocket(const TcpSocket &other) noexcept = delete;
  TcpSocket &operator=(const TcpSocket &other) noexcept = delete;
 
  TcpSocket(TcpSocket &&other) noexcept = default;
  TcpSocket &operator=(TcpSocket &&other) noexcept = default;
 
  ~TcpSocket() noexcept;
 
  core_type::Result<void, SocketError> Open() noexcept;
 
  core_type::Result<void, SocketError> Connect(std::string_view host_ip_address,
                                               std::uint16_t host_port_num) noexcept;
 
  core_type::Result<void, SocketError> Disconnect() noexcept;
 
  core_type::Result<void, SocketError> Transmit(TcpMessageConstPtr tcp_message) noexcept;
 
  core_type::Result<TcpMessagePtr, SocketError> Read() noexcept;
 
  core_type::Result<void, SocketError> Close() noexcept;
 
 private:
  using TcpIpAddress = boost::asio::ip::address;
 
  using TcpErrorCodeType = boost::system::error_code;
 
  Socket tcp_socket_;
 
  Tcp::endpoint local_endpoint_;
};
}  // namespace tcp
}  // namespace socket
}  // namespace boost_support
#endif  // DIAG_CLIENT_LIB_LIB_BOOST_SUPPORT_SOCKET_TCP_TCP_SOCKET_H_