udp_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_UDP_UDP_MESSAGE_H_
#define DIAG_CLIENT_LIB_LIB_BOOST_SUPPORT_SOCKET_UDP_UDP_MESSAGE_H_
 
#include <memory>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
 
#include "core/include/span.h"
 
namespace boost_support {
namespace socket {
namespace udp {
 
constexpr std::uint8_t kDoipUdpResSize{40u};
 
class UdpMessage final {
 public:
  using BufferType = std::vector<uint8_t>;
 
  using IpAddressType = std::string_view;
 
 public:
  UdpMessage(IpAddressType host_ip_address, std::uint16_t host_port_number)
      : rx_buffer_{},
        tx_buffer_{},
        host_ip_address_{host_ip_address},
        host_port_number_{host_port_number} {}
 
  UdpMessage(IpAddressType host_ip_address, std::uint16_t host_port_number, BufferType payload)
      : rx_buffer_{std::move(payload)},
        tx_buffer_{},
        host_ip_address_{host_ip_address},
        host_port_number_{host_port_number} {}
 
  UdpMessage(UdpMessage &&other) noexcept = default;
  UdpMessage &operator=(UdpMessage &&other) noexcept = default;
 
  UdpMessage(const UdpMessage &other) = delete;
  UdpMessage &operator=(const UdpMessage &other) = delete;
 
  virtual ~UdpMessage() = 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_; }
 
 private:
  BufferType rx_buffer_;
 
  BufferType tx_buffer_;
 
  IpAddressType host_ip_address_;
 
  std::uint16_t host_port_number_;
};
 
using UdpMessageConstPtr = std::unique_ptr<const UdpMessage>;
 
using UdpMessagePtr = std::unique_ptr<UdpMessage>;
 
}  // namespace udp
}  // namespace socket
}  // namespace boost_support
#endif  // DIAG_CLIENT_LIB_LIB_BOOST_SUPPORT_SOCKET_UDP_UDP_MESSAGE_H_