boost_support::client::udp::UdpClient Class Reference

Client that manages udp connection. More...

#include <udp_client.h>

Classes
class	UdpClientImpl
	Class to provide implementation of udp client. More...

Public Types
using	Message = boost_support::message::udp::UdpMessage
	Type alias for Tcp message. More...
using	MessagePtr = boost_support::message::udp::UdpMessagePtr
	Type alias for Tcp message pointer. More...
using	MessageConstPtr = boost_support::message::udp::UdpMessageConstPtr
	Type alias for Tcp message const pointer. More...
using	HandlerRead = std::function< void(MessagePtr)>
	Tcp function template used for reception. More...

Public Member Functions
	UdpClient (std::string_view local_ip_address, std::uint16_t local_port_num) noexcept
	Constructs an instance of UdpClient. More...
	UdpClient (const UdpClient &other) noexcept=delete
	Deleted copy assignment and copy constructor. More...
UdpClient &	operator= (const UdpClient &other) noexcept=delete
	UdpClient (UdpClient &&other) noexcept
	Move assignment and move constructor. More...
UdpClient &	operator= (UdpClient &&other) noexcept
	~UdpClient () noexcept
	Destruct an instance of UdpClient. More...
void	Initialize () noexcept
	Initialize the client. More...
void	DeInitialize () noexcept
	De-initialize the client. More...
void	SetReadHandler (HandlerRead read_handler) noexcept
	Function to set the read handler that is invoked when message is received. More...
core_type::Result< void >	Transmit (MessageConstPtr udp_message)
	Function to transmit the provided tcp message. More...

Private Attributes
std::unique_ptr< UdpClientImpl >	udp_client_impl_
	Unique pointer to udp client implementation. More...

Detailed Description

Client that manages udp connection.

Definition at line 24 of file udp_client.h.

Member Typedef Documentation

HandlerRead

using boost_support::client::udp::UdpClient::HandlerRead = std::function<void(MessagePtr)>

Tcp function template used for reception.

Definition at line 44 of file udp_client.h.

Message

using boost_support::client::udp::UdpClient::Message = boost_support::message::udp::UdpMessage

Type alias for Tcp message.

Definition at line 29 of file udp_client.h.

MessageConstPtr

using boost_support::client::udp::UdpClient::MessageConstPtr = boost_support::message::udp::UdpMessageConstPtr

Type alias for Tcp message const pointer.

Definition at line 39 of file udp_client.h.

MessagePtr

using boost_support::client::udp::UdpClient::MessagePtr = boost_support::message::udp::UdpMessagePtr

Type alias for Tcp message pointer.

Definition at line 34 of file udp_client.h.

Constructor & Destructor Documentation

UdpClient() [1/3]

boost_support::client::udp::UdpClient::UdpClient ( std::string_view  local_ip_address, std::uint16_t  local_port_num  )

noexcept

Constructs an instance of UdpClient.

Parameters

[in]	local_ip_address	The local ip address
[in]	local_port_num	The local port number

Definition at line 111 of file udp_client.cpp.

    : udp_client_impl_{std::make_unique<UdpClientImpl>(local_ip_address, local_port_num)} {}

UdpClient() [2/3]

boost_support::client::udp::UdpClient::UdpClient ( const UdpClient &  other )

deletenoexcept

Deleted copy assignment and copy constructor.

UdpClient() [3/3]

boost_support::client::udp::UdpClient::UdpClient ( UdpClient &&  other )

defaultnoexcept

Move assignment and move constructor.

~UdpClient()

boost_support::client::udp::UdpClient::~UdpClient ( )

defaultnoexcept

Destruct an instance of UdpClient.

Member Function Documentation

DeInitialize()

void boost_support::client::udp::UdpClient::DeInitialize ( )

noexcept

De-initialize the client.

Definition at line 122 of file udp_client.cpp.

{ udp_client_impl_->DeInitialize(); }

References udp_client_impl_.

Initialize()

void boost_support::client::udp::UdpClient::Initialize ( )

noexcept

Initialize the client.

Definition at line 120 of file udp_client.cpp.

{ udp_client_impl_->Initialize(); }

References Initialize().

Referenced by Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

UdpClient& boost_support::client::udp::UdpClient::operator= ( const UdpClient &  other )

deletenoexcept

operator=() [2/2]

UdpClient & boost_support::client::udp::UdpClient::operator= ( UdpClient &&  other )

defaultnoexcept

SetReadHandler()

void boost_support::client::udp::UdpClient::SetReadHandler ( UdpClient::HandlerRead  read_handler )

noexcept

Function to set the read handler that is invoked when message is received.

The ownership of provided read handler is moved

Parameters

[in]

read_handler

The handler to be set

Definition at line 124 of file udp_client.cpp.

                                                                         {
  udp_client_impl_->SetReadHandler(std::move(read_handler));
}

Transmit()

core_type::Result< void > boost_support::client::udp::UdpClient::Transmit

(

UdpClient::MessageConstPtr

udp_message

)

Function to transmit the provided tcp message.

Parameters

[in]

udp_message

The udp message

Returns

Empty void on success, otherwise error is returned

Definition at line 128 of file udp_client.cpp.

                                                                              {
  return udp_client_impl_->Transmit(std::move(udp_message));
}

References udp_client_impl_.

Member Data Documentation

udp_client_impl_

std::unique_ptr<UdpClientImpl> boost_support::client::udp::UdpClient::udp_client_impl_

private

Unique pointer to udp client implementation.

Definition at line 108 of file udp_client.h.

Referenced by DeInitialize(), 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/include/boost-support/client/udp/udp_client.h
• /home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/boost-support/src/boost-support/client/udp/udp_client.cpp