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

#include <tcp_client.h>

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

using	TcpHandlerRead = std::function< void(TcpMessagePtr)>
	Tcp function template used for reception. More...

Public Member Functions
	TcpClientSocket (std::string_view local_ip_address, std::uint16_t local_port_num, TcpHandlerRead tcp_handler_read)
	Constructs an instance of TcpClientSocket. More...

	~TcpClientSocket ()
	Destruct an instance of TcpClientSocket. More...

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

core_type::Result< void, TcpErrorCode >	ConnectToHost (std::string_view host_ip_address, std::uint16_t host_port_num)
	Function to connect to remote ip address and port number. More...

core_type::Result< void, TcpErrorCode >	DisconnectFromHost ()
	Function to Disconnect from host. More...

core_type::Result< void, TcpErrorCode >	Transmit (TcpMessageConstPtr tcp_message)
	Function to trigger transmission. More...

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

Private Types
using	Tcp = boost::asio::ip::tcp
	Type alias for tcp protocol. More...

using	TcpSocket = Tcp::socket
	Type alias for tcp socket. More...

using	TcpIpAddress = boost::asio::ip::address
	Type alias for tcp ip address. More...

using	TcpErrorCodeType = boost::system::error_code
	Type alias for tcp error codes. More...

Private Member Functions
void	HandleMessage ()
	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...

TcpSocket	tcp_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...

TcpHandlerRead	tcp_handler_read_
	Store the handler. More...

Detailed Description

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

Definition at line 26 of file tcp_client.h.

Member Typedef Documentation

◆ Tcp

using boost_support::socket::tcp::TcpClientSocket::Tcp = boost::asio::ip::tcp

private

Type alias for tcp protocol.

Definition at line 95 of file tcp_client.h.

◆ TcpErrorCodeType

using boost_support::socket::tcp::TcpClientSocket::TcpErrorCodeType = boost::system::error_code

private

Type alias for tcp error codes.

Definition at line 110 of file tcp_client.h.

◆ TcpHandlerRead

using boost_support::socket::tcp::TcpClientSocket::TcpHandlerRead = std::function<void(TcpMessagePtr)>

Tcp function template used for reception.

Definition at line 36 of file tcp_client.h.

◆ TcpIpAddress

using boost_support::socket::tcp::TcpClientSocket::TcpIpAddress = boost::asio::ip::address

private

Type alias for tcp ip address.

Definition at line 105 of file tcp_client.h.

◆ TcpSocket

using boost_support::socket::tcp::TcpClientSocket::TcpSocket = Tcp::socket

private

Type alias for tcp socket.

Definition at line 100 of file tcp_client.h.

Member Enumeration Documentation

◆ TcpErrorCode

enum boost_support::socket::tcp::TcpClientSocket::TcpErrorCode : std::uint8_t

strong

Tcp error code.

Enumerator
kOpenFailed
kBindingFailed
kGenericError

Definition at line 31 of file tcp_client.h.

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

doip_client::error_domain::DoipErrorErrc::kGenericError

@ kGenericError

Constructor & Destructor Documentation

◆ TcpClientSocket()

boost_support::socket::tcp::TcpClientSocket::TcpClientSocket	(	std::string_view	local_ip_address,
		std::uint16_t	local_port_num,
		TcpHandlerRead	tcp_handler_read
	)

Constructs an instance of TcpClientSocket.

Parameters

[in]	local_ip_address	The local ip address
[in]	local_port_num	The local port number
[in]	tcp_handler_read	The handler to send received data to user

Definition at line 19 of file tcp_client.cpp.

     : local_ip_address_{local_ip_address},
       local_port_num_{local_port_num},
       io_context_{},
       tcp_socket_{io_context_},
       exit_request_{false},
       running_{false},
       cond_var_{},
       mutex_{},
       tcp_handler_read_{std::move(tcp_handler_read)} {
   // 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_.load()) {
         if (running_) {
           lck.unlock();
           HandleMessage();
           lck.lock();
         }
       }
     }
   });
 }

References cond_var_, exit_request_, HandleMessage(), mutex_, running_, and thread_.

Here is the call graph for this function:

◆ ~TcpClientSocket()

boost_support::socket::tcp::TcpClientSocket::~TcpClientSocket ( )

Destruct an instance of TcpClientSocket.

Definition at line 48 of file tcp_client.cpp.

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

References cond_var_, exit_request_, running_, and thread_.

Member Function Documentation

◆ ConnectToHost()

core_type::Result< void, TcpClientSocket::TcpErrorCode > boost_support::socket::tcp::TcpClientSocket::ConnectToHost	(	std::string_view	host_ip_address,
		std::uint16_t	host_port_num
	)

Function to connect to remote ip address and port number.

Parameters

[in]	host_ip_address	The host ip address
[in]	host_port_num	The host port number

Returns: Empty result on success otherwise error code

Definition at line 94 of file tcp_client.cpp.

                                                                                                                  {
   core_type::Result<void, TcpErrorCode> result{TcpErrorCode::kGenericError};
   TcpErrorCodeType ec{};
  
   // connect to provided ipAddress
   tcp_socket_.connect(Tcp::endpoint(TcpIpAddress::from_string(std::string{host_ip_address}), host_port_num), ec);
   if (ec.value() == boost::system::errc::success) {
     common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogDebug(
         __FILE__, __LINE__, __func__, [this](std::stringstream &msg) {
           Tcp::endpoint const endpoint_{tcp_socket_.remote_endpoint()};
           msg << "Tcp Socket connected to host "
               << "<" << endpoint_.address().to_string() << "," << endpoint_.port() << ">";
         });
     {  // start reading
       std::lock_guard<std::mutex> lock{mutex_};
       running_ = true;
       cond_var_.notify_all();
     }
     result.EmplaceValue();
   } else {
     common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogError(
         __FILE__, __LINE__, __func__,
         [ec](std::stringstream &msg) { msg << "Tcp Socket connect to host failed with error: " << ec.message(); });
   }
   return result;
 }

References cond_var_, boost_support::common::logger::LibBoostLogger::GetLibBoostLogger(), kGenericError, mutex_, running_, and tcp_socket_.

Here is the call graph for this function:

◆ Destroy()

core_type::Result< void, TcpClientSocket::TcpErrorCode > boost_support::socket::tcp::TcpClientSocket::Destroy ( )

Function to destroy the socket.

Returns: Empty result on success otherwise error code

Definition at line 165 of file tcp_client.cpp.

                                                                             {
   core_type::Result<void, TcpErrorCode> result{TcpErrorCode::kGenericError};
   // destroy the socket
   tcp_socket_.close();
   result.EmplaceValue();
   return result;
 }

References kGenericError, and tcp_socket_.

◆ DisconnectFromHost()

core_type::Result< void, TcpClientSocket::TcpErrorCode > boost_support::socket::tcp::TcpClientSocket::DisconnectFromHost ( )

Function to Disconnect from host.

Returns: Empty result on success otherwise error code

Definition at line 122 of file tcp_client.cpp.

                                                                                        {
   core_type::Result<void, TcpErrorCode> result{TcpErrorCode::kGenericError};
   TcpErrorCodeType ec{};
  
   // Graceful shutdown
   tcp_socket_.shutdown(TcpSocket::shutdown_both, ec);
   if (ec.value() == boost::system::errc::success) {
     // stop reading
     running_ = false;
     // Socket shutdown success
     result.EmplaceValue();
   } else {
     common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogError(
         __FILE__, __LINE__, __func__, [ec](std::stringstream &msg) {
           msg << "Tcp Socket disconnection from host failed with error: " << ec.message();
         });
   }
   return result;
 }

References boost_support::common::logger::LibBoostLogger::GetLibBoostLogger(), kGenericError, running_, and tcp_socket_.

Here is the call graph for this function:

◆ HandleMessage()

void boost_support::socket::tcp::TcpClientSocket::HandleMessage ( )

private

Function to handle the reception of tcp message.

Definition at line 173 of file tcp_client.cpp.

                                     {
   TcpErrorCodeType ec{};
   // create and reserve the buffer
   TcpMessage::BufferType rx_buffer{};
   rx_buffer.resize(kDoipheadrSize);
   // start blocking read to read Header first
   boost::asio::read(tcp_socket_, boost::asio::buffer(&rx_buffer[0u], kDoipheadrSize), ec);
   // Check for error
   if (ec.value() == boost::system::errc::success) {
     // read the next bytes to read
     std::uint32_t const read_next_bytes = [&rx_buffer]() noexcept -> std::uint32_t {
       return static_cast<std::uint32_t>((static_cast<std::uint32_t>(rx_buffer[4u] << 24u) & 0xFF000000) |
                                         (static_cast<std::uint32_t>(rx_buffer[5u] << 16u) & 0x00FF0000) |
                                         (static_cast<std::uint32_t>(rx_buffer[6u] << 8u) & 0x0000FF00) |
                                         (static_cast<std::uint32_t>(rx_buffer[7u] & 0x000000FF)));
     }();
     // reserve the buffer
     rx_buffer.resize(kDoipheadrSize + std::size_t(read_next_bytes));
     boost::asio::read(tcp_socket_, boost::asio::buffer(&rx_buffer[kDoipheadrSize], read_next_bytes), ec);
  
     // all message received, transfer to upper layer
     Tcp::endpoint const endpoint_{tcp_socket_.remote_endpoint()};
     TcpMessagePtr tcp_rx_message{
         std::make_unique<TcpMessage>(endpoint_.address().to_string(), endpoint_.port(), std::move(rx_buffer))};
     common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogDebug(
         __FILE__, __LINE__, __func__, [endpoint_](std::stringstream &msg) {
           msg << "Tcp Message received from "
               << "<" << endpoint_.address().to_string() << "," << endpoint_.port() << ">";
         });
     // notify upper layer about received message
     tcp_handler_read_(std::move(tcp_rx_message));
   } else if (ec.value() == boost::asio::error::eof) {
     running_ = false;
     common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogDebug(
         __FILE__, __LINE__, __func__,
         [ec](std::stringstream &msg) { msg << "Remote Disconnected with: " << ec.message(); });
   } else {
     running_ = false;
     common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogError(
         __FILE__, __LINE__, __func__,
         [ec](std::stringstream &msg) { msg << "Remote Disconnected with undefined error: " << ec.message(); });
   }
 }

References boost_support::common::logger::LibBoostLogger::GetLibBoostLogger(), boost_support::socket::tcp::kDoipheadrSize, running_, tcp_handler_read_, and tcp_socket_.

Referenced by TcpClientSocket().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Open()

core_type::Result< void, TcpClientSocket::TcpErrorCode > boost_support::socket::tcp::TcpClientSocket::Open ( )

Function to Open the socket.

Returns: Empty result on success otherwise error code

Definition at line 55 of file tcp_client.cpp.

                                                                          {
   core_type::Result<void, TcpErrorCode> result{TcpErrorCode::kGenericError};
   TcpErrorCodeType ec{};
  
   // Open the socket
   tcp_socket_.open(Tcp::v4(), ec);
   if (ec.value() == boost::system::errc::success) {
     // reuse address
     tcp_socket_.set_option(boost::asio::socket_base::reuse_address{true});
     // Set socket to non blocking
     tcp_socket_.non_blocking(false);
     // Bind to local ip address and random port
     tcp_socket_.bind(Tcp::endpoint(TcpIpAddress::from_string(local_ip_address_), local_port_num_), ec);
  
     if (ec.value() == boost::system::errc::success) {
       // Socket binding success
       common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogDebug(
           __FILE__, __LINE__, __func__, [this](std::stringstream &msg) {
             Tcp::endpoint const endpoint_{tcp_socket_.local_endpoint()};
             msg << "Tcp Socket opened and bound to "
                 << "<" << endpoint_.address().to_string() << "," << endpoint_.port() << ">";
           });
       result.EmplaceValue();
     } else {
       // Socket binding failed
       common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogError(
           __FILE__, __LINE__, __func__,
           [ec](std::stringstream &msg) { msg << "Tcp Socket binding failed with message: " << ec.message(); });
       result.EmplaceError(TcpErrorCode::kBindingFailed);
     }
   } else {
     common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogError(
         __FILE__, __LINE__, __func__,
         [ec](std::stringstream &msg) { msg << "Tcp Socket opening failed with error: " << ec.message(); });
     result.EmplaceError(TcpErrorCode::kOpenFailed);
   }
   return result;
 }

References boost_support::common::logger::LibBoostLogger::GetLibBoostLogger(), kBindingFailed, kGenericError, kOpenFailed, local_ip_address_, local_port_num_, and tcp_socket_.

Here is the call graph for this function:

◆ Transmit()

core_type::Result< void, TcpClientSocket::TcpErrorCode > boost_support::socket::tcp::TcpClientSocket::Transmit ( TcpMessageConstPtr tcp_message )

Function to trigger transmission.

Parameters

[in] tcp_message The tcp message to be transmitted

Returns: Empty result on success otherwise error code

Definition at line 142 of file tcp_client.cpp.

                                                                                                            {
   core_type::Result<void, TcpErrorCode> result{TcpErrorCode::kGenericError};
   TcpErrorCodeType ec{};
  
   boost::asio::write(tcp_socket_, boost::asio::buffer(tcp_message->GetTxBuffer(), tcp_message->GetTxBuffer().size()),
                      ec);
   // Check for error
   if (ec.value() == boost::system::errc::success) {
     common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogDebug(
         __FILE__, __LINE__, __func__, [this](std::stringstream &msg) {
           Tcp::endpoint const endpoint_{tcp_socket_.remote_endpoint()};
           msg << "Tcp message sent to "
               << "<" << endpoint_.address().to_string() << "," << endpoint_.port() << ">";
         });
     result.EmplaceValue();
   } else {
     common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogError(
         __FILE__, __LINE__, __func__,
         [ec](std::stringstream &msg) { msg << "Tcp message sending failed with error: " << ec.message(); });
   }
   return result;
 }

References boost_support::common::logger::LibBoostLogger::GetLibBoostLogger(), kGenericError, and tcp_socket_.

Here is the call graph for this function:

Member Data Documentation

◆ cond_var_

std::condition_variable boost_support::socket::tcp::TcpClientSocket::cond_var_

private

Conditional variable to block the thread.

Definition at line 145 of file tcp_client.h.

Referenced by ConnectToHost(), TcpClientSocket(), and ~TcpClientSocket().

◆ exit_request_

std::atomic_bool boost_support::socket::tcp::TcpClientSocket::exit_request_

private

Flag to terminate the thread.

Definition at line 135 of file tcp_client.h.

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

◆ io_context_

boost::asio::io_context boost_support::socket::tcp::TcpClientSocket::io_context_

private

boost io context

Definition at line 125 of file tcp_client.h.

◆ local_ip_address_

std::string boost_support::socket::tcp::TcpClientSocket::local_ip_address_

private

Store local ip address.

Definition at line 115 of file tcp_client.h.

Referenced by Open().

◆ local_port_num_

std::uint16_t boost_support::socket::tcp::TcpClientSocket::local_port_num_

private

Store local port number.

Definition at line 120 of file tcp_client.h.

Referenced by Open().

◆ mutex_

std::mutex boost_support::socket::tcp::TcpClientSocket::mutex_

private

mutex to lock critical section

Definition at line 155 of file tcp_client.h.

Referenced by ConnectToHost(), and TcpClientSocket().

◆ running_

std::atomic_bool boost_support::socket::tcp::TcpClientSocket::running_

private

Flag to start the thread.

Definition at line 140 of file tcp_client.h.

Referenced by ConnectToHost(), DisconnectFromHost(), HandleMessage(), TcpClientSocket(), and ~TcpClientSocket().

◆ tcp_handler_read_

TcpHandlerRead boost_support::socket::tcp::TcpClientSocket::tcp_handler_read_

private

Store the handler.

Definition at line 160 of file tcp_client.h.

Referenced by HandleMessage().

◆ tcp_socket_

TcpSocket boost_support::socket::tcp::TcpClientSocket::tcp_socket_

private

Store tcp socket.

Definition at line 130 of file tcp_client.h.

Referenced by ConnectToHost(), Destroy(), DisconnectFromHost(), HandleMessage(), Open(), and Transmit().

◆ thread_

std::thread boost_support::socket::tcp::TcpClientSocket::thread_

private

The thread itself.

Definition at line 150 of file tcp_client.h.

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

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/tcp/tcp_client.h
/home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/boost-support/socket/tcp/tcp_client.cpp

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Tcp

◆ TcpErrorCodeType

◆ TcpHandlerRead

◆ TcpIpAddress

◆ TcpSocket

Member Enumeration Documentation

◆ TcpErrorCode

Constructor & Destructor Documentation

◆ TcpClientSocket()

◆ ~TcpClientSocket()

Member Function Documentation

◆ ConnectToHost()

◆ Destroy()

◆ DisconnectFromHost()

◆ HandleMessage()

◆ Open()

◆ Transmit()

Member Data Documentation

◆ cond_var_

◆ exit_request_

◆ io_context_

◆ local_ip_address_

◆ local_port_num_

◆ mutex_

◆ running_

◆ tcp_handler_read_

◆ tcp_socket_

◆ thread_