udp_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_UDP_UDP_CLIENT_H_
#define DIAG_CLIENT_LIB_LIB_BOOST_SUPPORT_INCLUDE_BOOST_SUPPORT_CLIENT_UDP_UDP_CLIENT_H_
 
#include <functional>
#include <string_view>
 
#include "boost-support/message/udp/udp_message.h"
#include "core/include/result.h"
 
namespace boost_support {
namespace client {
namespace udp {
 
class UdpClient final {
 public:
  using Message = boost_support::message::udp::UdpMessage;
 
  using MessagePtr = boost_support::message::udp::UdpMessagePtr;
 
  using MessageConstPtr = boost_support::message::udp::UdpMessageConstPtr;
 
  using HandlerRead = std::function<void(MessagePtr)>;
 
 public:
  UdpClient(std::string_view local_ip_address, std::uint16_t local_port_num) noexcept;
 
  UdpClient(const UdpClient &other) noexcept = delete;
  UdpClient &operator=(const UdpClient &other) noexcept = delete;
 
  UdpClient(UdpClient &&other) noexcept;
  UdpClient &operator=(UdpClient &&other) noexcept;
 
  ~UdpClient() noexcept;
 
  void Initialize() noexcept;
 
  void DeInitialize() noexcept;
 
  void SetReadHandler(HandlerRead read_handler) noexcept;
 
  core_type::Result<void> Transmit(MessageConstPtr udp_message);
 
 private:
  class UdpClientImpl;
 
  std::unique_ptr<UdpClientImpl> udp_client_impl_;
};
 
}  // namespace udp
}  // namespace client
}  // namespace boost_support
#endif  // DIAG_CLIENT_LIB_LIB_BOOST_SUPPORT_INCLUDE_BOOST_SUPPORT_CLIENT_UDP_UDP_CLIENT_H_