udp_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_UDP_UDP_SOCKET_H_
#define DIAG_CLIENT_LIB_LIB_BOOST_SUPPORT_SOCKET_UDP_UDP_SOCKET_H_
 
#include <boost/asio.hpp>
#include <vector>
 
#include "boost-support/message/udp/udp_message.h"
#include "core/include/result.h"
 
namespace boost_support {
namespace socket {
namespace udp {
 
class UdpSocket final {
 public:
  enum class SocketError : std::uint8_t { kOpenFailed, kBindingFailed, kGenericError };
 
  using UdpMessage = boost_support::message::udp::UdpMessage;
 
  using UdpMessagePtr = boost_support::message::udp::UdpMessagePtr;
 
  using UdpMessageConstPtr = boost_support::message::udp::UdpMessageConstPtr;
 
  using Udp = boost::asio::ip::udp;
 
  using Socket = Udp::socket;
 
  using UdpHandlerRead = std::function<void(UdpMessagePtr)>;
 
 public:
  UdpSocket(std::string_view local_ip_address, std::uint16_t local_port_num,
            boost::asio::io_context &io_context) noexcept;
 
  UdpSocket(const UdpSocket &other) noexcept = delete;
  UdpSocket &operator=(const UdpSocket &other) noexcept = delete;
 
  UdpSocket(UdpSocket &&other) noexcept = default;
  UdpSocket &operator=(UdpSocket &&other) noexcept = default;
 
  ~UdpSocket() noexcept;
 
  void SetReadHandler(UdpHandlerRead read_handler);
 
  core_type::Result<void, SocketError> Open() noexcept;
 
  core_type::Result<void, SocketError> Transmit(UdpMessageConstPtr udp_message) noexcept;
 
  core_type::Result<void, SocketError> Close() noexcept;
 
 private:
  using UdpErrorCodeType = boost::system::error_code;
 
  Socket udp_socket_;
 
  Udp::endpoint local_endpoint_;
 
  Udp::endpoint remote_endpoint_;
 
  std::vector<std::uint8_t> rx_buffer_;
 
  UdpHandlerRead udp_handler_read_;
 
 private:
  core_type::Result<UdpMessagePtr> Read(std::size_t bytes_received);
 
  void StartReceivingMessage();
};
 
}  // namespace udp
}  // namespace socket
}  // namespace boost_support
#endif  // DIAG_CLIENT_LIB_LIB_BOOST_SUPPORT_SOCKET_UDP_UDP_SOCKET_H_