tcp_message.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_MESSAGE_H_
#define DIAG_CLIENT_LIB_LIB_BOOST_SUPPORT_SOCKET_TCP_TCP_MESSAGE_H_
 
#include <memory>
#include <string>
#include <string_view>
#include <vector>
 
#include "core/include/span.h"
 
namespace boost_support {
namespace socket {
namespace tcp {
 
class TcpMessage final {
 public:
  enum class SocketState : std::uint8_t {
    kIdle = 0x00,
    kSocketOnline,
    kSocketOffline,
    kSocketRxMessageReceived,
    kSocketTxMessageSend,
    kSocketTxMessageConf,
    kSocketError
  };
 
  enum class SocketError : std::uint8_t { kNone = 0x00 };
 
  using BufferType = std::vector<uint8_t>;
 
  using IpAddressType = std::string_view;
 
 public:
  TcpMessage()
      : socket_state_{SocketState::kIdle},
        socket_error_{SocketError::kNone},
        rx_buffer_{},
        tx_buffer_{},
        host_ip_address_{},
        host_port_number_{} {}
 
  TcpMessage(IpAddressType host_ip_address, std::uint16_t host_port_number, BufferType &&payload)
      : socket_state_{SocketState::kIdle},
        socket_error_{SocketError::kNone},
        rx_buffer_{std::move(payload)},
        tx_buffer_{},
        host_ip_address_{host_ip_address},
        host_port_number_{host_port_number} {}
 
  TcpMessage(TcpMessage &&other) noexcept = default;
  TcpMessage &operator=(TcpMessage &&other) noexcept = default;
 
  TcpMessage(const TcpMessage &other) = delete;
  TcpMessage &operator=(const TcpMessage &other) = delete;
 
  ~TcpMessage() = default;
 
  IpAddressType GetHostIpAddress() const { return host_ip_address_; }
 
  std::uint16_t GetHostPortNumber() const { return host_port_number_; }
 
  core_type::Span<std::uint8_t> GetRxBuffer() { return core_type::Span<std::uint8_t>{rx_buffer_}; }
 
  BufferType &GetTxBuffer() { return tx_buffer_; }
 
  BufferType const &GetTxBuffer() const { return tx_buffer_; }
 
  SocketState GetSocketState() const { return socket_state_; }
 
  SocketError GetSocketError() const { return socket_error_; }
 
 private:
  SocketState socket_state_;
 
  SocketError socket_error_;
 
  BufferType rx_buffer_;
 
  BufferType tx_buffer_;
 
  std::string host_ip_address_;
 
  std::uint16_t host_port_number_;
};
 
using TcpMessageConstPtr = std::unique_ptr<const TcpMessage>;
 
using TcpMessagePtr = std::unique_ptr<TcpMessage>;
 
constexpr std::uint8_t kDoipheadrSize = 8U;
 
}  // namespace tcp
}  // namespace socket
}  // namespace boost_support
#endif  // DIAG_CLIENT_LIB_LIB_BOOST_SUPPORT_SOCKET_TCP_TCP_MESSAGE_H_