Class used to create a udp socket for handling transmission and reception of udp message from driver. More...

#include <udp_client.h>

Public Types
enum class	UdpErrorCode : std::uint8_t { kOpenFailed , kBindingFailed , kGenericError }
	Udp error code. More...

enum class	PortType : std::uint8_t { kUdp_Broadcast = 0 , kUdp_Unicast }
	Type of udp port to be used underneath. More...

using	UdpHandlerRead = std::function< void(UdpMessagePtr)>
	Udp function template used for reception. More...

Public Member Functions
	UdpClientSocket (std::string_view local_ip_address, std::uint16_t local_port_num, PortType port_type, UdpHandlerRead udp_handler_read)
	Constructs an instance of UdpClientSocket. More...

virtual	~UdpClientSocket ()
	Destruct an instance of UdpClientSocket. More...

core_type::Result< void, UdpErrorCode >	Open ()
	Function to Open the socket. More...

core_type::Result< void, UdpErrorCode >	Transmit (UdpMessageConstPtr udp_message)
	Function to trigger transmission. More...

core_type::Result< void, UdpErrorCode >	Destroy ()
	Function to destroy the socket. More...

Private Types
using	Udp = boost::asio::ip::udp
	Type alias for udp protocol. More...

using	UdpSocket = Udp::socket
	Type alias for udp socket. More...

using	UdpIpAddress = boost::asio::ip::address
	Type alias for udp ip address. More...

using	UdpErrorCodeType = boost::system::error_code
	Type alias for udp error codes. More...

Private Member Functions
void	HandleMessage (const UdpErrorCodeType &error, std::size_t bytes_received)
	Function to handle the reception of tcp message. More...

Private Attributes
std::string	local_ip_address_
	Store local ip address. More...

std::uint16_t	local_port_num_
	Store local port number. More...

boost::asio::io_context	io_context_
	boost io context More...

UdpSocket	udp_socket_
	Store tcp socket. More...

std::atomic_bool	exit_request_
	Flag to terminate the thread. More...

std::atomic_bool	running_
	Flag to start the thread. More...

std::condition_variable	cond_var_
	Conditional variable to block the thread. More...

std::thread	thread_
	The thread itself. More...

std::mutex	mutex_
	mutex to lock critical section More...

Udp::endpoint	remote_endpoint_
	Store the remote endpoint. More...

PortType	port_type_
	Store the port type - broadcast / unicast. More...

UdpHandlerRead	udp_handler_read_
	Store the handler. More...

std::array< std::uint8_t, kDoipUdpResSize >	rx_buffer_
	Reception buffer needed for async reception of udp data. More...

Detailed Description

Class used to create a udp socket for handling transmission and reception of udp message from driver.

Definition at line 27 of file udp_client.h.

Member Typedef Documentation

◆ Udp

using boost_support::socket::udp::UdpClientSocket::Udp = boost::asio::ip::udp

private

Type alias for udp protocol.

Definition at line 88 of file udp_client.h.

◆ UdpErrorCodeType

using boost_support::socket::udp::UdpClientSocket::UdpErrorCodeType = boost::system::error_code

private

Type alias for udp error codes.

Definition at line 103 of file udp_client.h.

◆ UdpHandlerRead

using boost_support::socket::udp::UdpClientSocket::UdpHandlerRead = std::function<void(UdpMessagePtr)>

Udp function template used for reception.

Definition at line 42 of file udp_client.h.

◆ UdpIpAddress

using boost_support::socket::udp::UdpClientSocket::UdpIpAddress = boost::asio::ip::address

private

Type alias for udp ip address.

Definition at line 98 of file udp_client.h.

◆ UdpSocket

using boost_support::socket::udp::UdpClientSocket::UdpSocket = Udp::socket

private

Type alias for udp socket.

Definition at line 93 of file udp_client.h.

Member Enumeration Documentation

◆ PortType

enum boost_support::socket::udp::UdpClientSocket::PortType : std::uint8_t

strong

Type of udp port to be used underneath.

Enumerator
kUdp_Broadcast
kUdp_Unicast

Definition at line 37 of file udp_client.h.

37 : std::uint8_t { kUdp_Broadcast = 0, kUdp_Unicast };

◆ UdpErrorCode

enum boost_support::socket::udp::UdpClientSocket::UdpErrorCode : std::uint8_t

strong

Udp error code.

Enumerator
kOpenFailed
kBindingFailed
kGenericError

Definition at line 32 of file udp_client.h.

32 : std::uint8_t { kOpenFailed, kBindingFailed, kGenericError };

doip_client::error_domain::DoipErrorErrc::kGenericError

@ kGenericError

Constructor & Destructor Documentation

◆ UdpClientSocket()

boost_support::socket::udp::UdpClientSocket::UdpClientSocket	(	std::string_view	local_ip_address,
		std::uint16_t	local_port_num,
		PortType	port_type,
		UdpHandlerRead	udp_handler_read
	)

Constructs an instance of UdpClientSocket.

Parameters

[in]	local_ip_address	The local ip address
[in]	local_port_num	The local port number
[in]	port_type	The type of socket port
[in]	UdpHandlerRead	The handler to send received data to user

Definition at line 17 of file udp_client.cpp.

     : local_ip_address_{local_ip_address},
       local_port_num_{local_port_num},
       io_context_{},
       udp_socket_{io_context_},
       exit_request_{false},
       running_{false},
       cond_var_{},
       mutex_{},
       port_type_{port_type},
       udp_handler_read_{std::move(udp_handler_read)},
       rx_buffer_{} {
   // Start thread to receive messages
   thread_ = std::thread([this]() {
     std::unique_lock<std::mutex> lck(mutex_);
     while (!exit_request_) {
       if (!running_) {
         cond_var_.wait(lck, [this]() { return exit_request_ || running_; });
       }
       if (!exit_request_) {
         if (running_) {
           io_context_.restart();
           io_context_.run();
         }
       }
     }
   });
 }

References cond_var_, exit_request_, io_context_, mutex_, running_, and thread_.

◆ ~UdpClientSocket()

boost_support::socket::udp::UdpClientSocket::~UdpClientSocket ( )

virtual

Destruct an instance of UdpClientSocket.

Definition at line 47 of file udp_client.cpp.

                                   {
   exit_request_ = true;
   running_ = false;
   cond_var_.notify_all();
   thread_.join();
 }

References cond_var_, exit_request_, running_, and thread_.

Member Function Documentation

◆ Destroy()

core_type::Result< void, UdpClientSocket::UdpErrorCode > boost_support::socket::udp::UdpClientSocket::Destroy ( )

Function to destroy the socket.

Returns: Empty result on success otherwise error code

Definition at line 147 of file udp_client.cpp.

                                                                             {
   core_type::Result<void, UdpErrorCode> result{UdpErrorCode::kGenericError};
   // destroy the socket
   udp_socket_.close();
   running_ = false;
   io_context_.stop();
   result.EmplaceValue();
   return result;
 }

References core_type::Result< T, E >::EmplaceValue().

Here is the call graph for this function:

◆ HandleMessage()

void boost_support::socket::udp::UdpClientSocket::HandleMessage	(	const UdpErrorCodeType &	error,
		std::size_t	bytes_received
	)

private

Function to handle the reception of tcp message.

Definition at line 158 of file udp_client.cpp.

                                                                                                  {
   // Check for error
   if (error.value() == boost::system::errc::success) {
     if (local_ip_address_ != remote_endpoint_.address().to_string()) {
       UdpMessage::BufferType received_data{};
       received_data.reserve(total_bytes_received);
       // copy the received bytes into local buffer
       received_data.insert(received_data.begin(), rx_buffer_.begin(), rx_buffer_.begin() + total_bytes_received);
  
       UdpMessagePtr udp_rx_message{std::make_unique<UdpMessage>(remote_endpoint_.address().to_string(),
                                                                 remote_endpoint_.port(), std::move(received_data))};
  
       common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogInfo(
           __FILE__, __LINE__, __func__, [this, &udp_rx_message](std::stringstream &msg) {
             msg << "Udp Message received: "
                 << "<" << udp_rx_message->GetHostIpAddress() << "," << udp_rx_message->GetHostPortNumber() << ">"
                 << " -> "
                 << "<" << local_ip_address_ << "," << local_port_num_ << ">";
           });
  
       // send data to upper layer
       udp_handler_read_(std::move(udp_rx_message));
       // start async receive
       udp_socket_.async_receive_from(boost::asio::buffer(rx_buffer_), remote_endpoint_,
                                      [this](const UdpErrorCodeType &error_received, std::size_t bytes_received) {
                                        HandleMessage(error_received, bytes_received);
                                      });
     } else {
       Udp::endpoint endpoint_{remote_endpoint_};
       common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogVerbose(
           __FILE__, __LINE__, __func__, [endpoint_, this](std::stringstream &msg) {
             msg << "Udp Message received from "
                 << "<" << endpoint_.address().to_string() << "," << endpoint_.port() << ">"
                 << " ignored as received by self ip"
                 << " <" << local_ip_address_ << ">";
           });
     }
   } else {
     if (error.value() != boost::asio::error::operation_aborted) {
       common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogError(
           __FILE__, __LINE__, __func__, [error, this](std::stringstream &msg) {
             msg << "<" << local_ip_address_ << ">: "
                 << "Remote Disconnected with undefined error: " << error.message();
           });
     }
   }
 }

References boost_support::common::logger::LibBoostLogger::GetLibBoostLogger().

Referenced by Open(), and Transmit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Open()

core_type::Result< void, UdpClientSocket::UdpErrorCode > boost_support::socket::udp::UdpClientSocket::Open ( )

Function to Open the socket.

Returns: Empty result on success otherwise error code

Definition at line 54 of file udp_client.cpp.

                                                                          {
   core_type::Result<void, UdpErrorCode> result{UdpErrorCode::kGenericError};
   UdpErrorCodeType ec{};
  
   // Open the socket
   udp_socket_.open(Udp::v4(), ec);
   if (ec.value() == boost::system::errc::success) {
     // set broadcast option
     boost::asio::socket_base::broadcast broadcast_option(true);
     udp_socket_.set_option(broadcast_option);
     // reuse address
     boost::asio::socket_base::reuse_address reuse_address_option(true);
     udp_socket_.set_option(reuse_address_option);
  
     if (port_type_ == PortType::kUdp_Broadcast) {
       // Todo : change the hardcoded value of port number 13400
       udp_socket_.bind(Udp::endpoint(boost::asio::ip::address_v4::any(), 13400), ec);
     } else {
       //bind to local address and random port
       udp_socket_.bind(Udp::endpoint(UdpIpAddress::from_string(local_ip_address_), local_port_num_), ec);
     }
  
     if (ec.value() == boost::system::errc::success) {
       Udp::endpoint endpoint{udp_socket_.local_endpoint()};
       common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogDebug(
           __FILE__, __LINE__, __func__, [endpoint](std::stringstream &msg) {
             msg << "Udp Socket Opened and bound to "
                 << "<" << endpoint.address().to_string() << "," << endpoint.port() << ">";
           });
       // Update the port number with new one
       local_port_num_ = udp_socket_.local_endpoint().port();
       {  // start reading
         std::lock_guard<std::mutex> lock{mutex_};
         running_ = true;
         cond_var_.notify_all();
       }
       // start async receive
       udp_socket_.async_receive_from(
           boost::asio::buffer(rx_buffer_), remote_endpoint_,
           [this](const UdpErrorCodeType &error, std::size_t bytes_recvd) { HandleMessage(error, bytes_recvd); });
       result.EmplaceValue();
     } else {
       // Socket binding failed
       common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogError(
           __FILE__, __LINE__, __func__,
           [ec](std::stringstream &msg) { msg << "Udp Socket Bind failed with message: " << ec.message(); });
     }
   } else {
     common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogError(
         __FILE__, __LINE__, __func__,
         [ec](std::stringstream &msg) { msg << "Udp Socket Opening failed with error: " << ec.message(); });
   }
   return result;
 }

References cond_var_, boost_support::common::logger::LibBoostLogger::GetLibBoostLogger(), HandleMessage(), kGenericError, kUdp_Broadcast, local_ip_address_, local_port_num_, mutex_, port_type_, remote_endpoint_, running_, rx_buffer_, and udp_socket_.

Here is the call graph for this function:

◆ Transmit()

core_type::Result< void, UdpClientSocket::UdpErrorCode > boost_support::socket::udp::UdpClientSocket::Transmit ( UdpMessageConstPtr udp_message )

Function to trigger transmission.

Parameters

[in] udp_message The udp message to be transmitted

Returns: Empty result on success otherwise error code

Definition at line 109 of file udp_client.cpp.

                                                                                                            {
   core_type::Result<void, UdpErrorCode> result{UdpErrorCode::kGenericError};
   try {
     // Transmit to remote endpoints
     std::size_t send_size{udp_socket_.send_to(
         boost::asio::buffer(udp_message->GetTxBuffer(), std::size_t(udp_message->GetTxBuffer().size())),
         Udp::endpoint{UdpIpAddress::from_string(std::string{udp_message->GetHostIpAddress()}),
                       udp_message->GetHostPortNumber()})};
     // Check for error
     if (send_size == udp_message->GetTxBuffer().size()) {
       // successful
       Udp::endpoint endpoint{udp_socket_.local_endpoint()};
       common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogDebug(
           __FILE__, __LINE__, __func__, [&udp_message, endpoint](std::stringstream &msg) {
             msg << "Udp message sent : "
                 << "<" << endpoint.address().to_string() << "," << endpoint.port() << ">"
                 << " -> "
                 << "<" << udp_message->GetHostIpAddress() << "," << udp_message->GetHostPortNumber() << ">";
           });
       result.EmplaceValue();
       // start async receive
       udp_socket_.async_receive_from(
           boost::asio::buffer(rx_buffer_), remote_endpoint_,
           [this](const UdpErrorCodeType &error, std::size_t bytes_received) { HandleMessage(error, bytes_received); });
     }
   } catch (boost::system::system_error const &ec) {
     UdpErrorCodeType error = ec.code();
     std::cerr << error.message() << "\n";
     common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogError(
         __FILE__, __LINE__, __func__, [error, &udp_message](std::stringstream &msg) {
           msg << "Udp message sending to "
               << "<" << udp_message->GetHostIpAddress() << "> "
               << "failed with error: " << error.message();
         });
   }
   return result;
 }

References boost_support::common::logger::LibBoostLogger::GetLibBoostLogger(), HandleMessage(), kGenericError, remote_endpoint_, rx_buffer_, and udp_socket_.

Here is the call graph for this function:

Member Data Documentation

◆ cond_var_

std::condition_variable boost_support::socket::udp::UdpClientSocket::cond_var_

private

Conditional variable to block the thread.

Definition at line 138 of file udp_client.h.

Referenced by Open(), UdpClientSocket(), and ~UdpClientSocket().

◆ exit_request_

std::atomic_bool boost_support::socket::udp::UdpClientSocket::exit_request_

private

Flag to terminate the thread.

Definition at line 128 of file udp_client.h.

Referenced by UdpClientSocket(), and ~UdpClientSocket().

◆ io_context_

boost::asio::io_context boost_support::socket::udp::UdpClientSocket::io_context_

private

boost io context

Definition at line 118 of file udp_client.h.

Referenced by UdpClientSocket().

◆ local_ip_address_

std::string boost_support::socket::udp::UdpClientSocket::local_ip_address_

private

Store local ip address.

Definition at line 108 of file udp_client.h.

Referenced by Open().

◆ local_port_num_

std::uint16_t boost_support::socket::udp::UdpClientSocket::local_port_num_

private

Store local port number.

Definition at line 113 of file udp_client.h.

Referenced by Open().

◆ mutex_

std::mutex boost_support::socket::udp::UdpClientSocket::mutex_

private

mutex to lock critical section

Definition at line 148 of file udp_client.h.

Referenced by Open(), and UdpClientSocket().

◆ port_type_

PortType boost_support::socket::udp::UdpClientSocket::port_type_

private

Store the port type - broadcast / unicast.

Definition at line 158 of file udp_client.h.

Referenced by Open().

◆ remote_endpoint_

Udp::endpoint boost_support::socket::udp::UdpClientSocket::remote_endpoint_

private

Store the remote endpoint.

Definition at line 153 of file udp_client.h.

Referenced by Open(), and Transmit().

◆ running_

std::atomic_bool boost_support::socket::udp::UdpClientSocket::running_

private

Flag to start the thread.

Definition at line 133 of file udp_client.h.

Referenced by Open(), UdpClientSocket(), and ~UdpClientSocket().

◆ rx_buffer_

std::array<std::uint8_t, kDoipUdpResSize> boost_support::socket::udp::UdpClientSocket::rx_buffer_

private

Reception buffer needed for async reception of udp data.

Definition at line 168 of file udp_client.h.

Referenced by Open(), and Transmit().

◆ thread_

std::thread boost_support::socket::udp::UdpClientSocket::thread_

private

The thread itself.

Definition at line 143 of file udp_client.h.

Referenced by UdpClientSocket(), and ~UdpClientSocket().

◆ udp_handler_read_

UdpHandlerRead boost_support::socket::udp::UdpClientSocket::udp_handler_read_

private

Store the handler.

Definition at line 163 of file udp_client.h.

◆ udp_socket_

UdpSocket boost_support::socket::udp::UdpClientSocket::udp_socket_

private

Store tcp socket.

Definition at line 123 of file udp_client.h.

Referenced by Open(), and Transmit().

The documentation for this class was generated from the following files:

/home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/boost-support/socket/udp/udp_client.h
/home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/boost-support/socket/udp/udp_client.cpp

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Udp

◆ UdpErrorCodeType

◆ UdpHandlerRead

◆ UdpIpAddress

◆ UdpSocket

Member Enumeration Documentation

◆ PortType

◆ UdpErrorCode

Constructor & Destructor Documentation

◆ UdpClientSocket()

◆ ~UdpClientSocket()

Member Function Documentation

◆ Destroy()

◆ HandleMessage()

◆ Open()

◆ Transmit()

Member Data Documentation

◆ cond_var_

◆ exit_request_

◆ io_context_

◆ local_ip_address_

◆ local_port_num_

◆ mutex_

◆ port_type_

◆ remote_endpoint_

◆ running_

◆ rx_buffer_

◆ thread_

◆ udp_handler_read_

◆ udp_socket_