Protocol handler class to manage the whole Doip protocol communication. More...

#include <doip_transport_protocol_handler.h>

Inheritance diagram for doip_client::transport_protocol_handler::DoipTransportProtocolHandler:

Collaboration diagram for doip_client::transport_protocol_handler::DoipTransportProtocolHandler:

[legend]

Public Types
using	UdsTransportProtocolHandlerId = uds_transport::UdsTransportProtocolHandler::UdsTransportProtocolHandlerId
	Type alias for handler id. More...

using	InitializationResult = uds_transport::UdsTransportProtocolHandler::InitializationResult
	Type alias for Initialization result. More...

Public Types inherited from uds_transport::UdsTransportProtocolHandler
enum class	InitializationResult : std::uint8_t { kInitializeOk = 0 , kInitializeFailed = 1 }
	Definitions of different initialization result. More...

using	UdsTransportProtocolHandlerId = std::uint8_t
	Type alias for handler id. More...

Public Member Functions
	DoipTransportProtocolHandler (UdsTransportProtocolHandlerId handler_id, uds_transport::UdsTransportProtocolMgr const &transport_protocol_mgr)
	Constructs an instance of DoipTransportProtocolHandler. More...

	~DoipTransportProtocolHandler () final
	Destruct an instance of DoipTransportProtocolHandler. More...

InitializationResult	Initialize () override
	Function to initialize the handler. More...

void	Start () override
	Function to start the protocol handler. More...

void	Stop () override
	Function to stop the protocol handler. More...

std::unique_ptr< uds_transport::Connection >	CreateTcpConnection (uds_transport::ConversionHandler &conversation, std::string_view tcp_ip_address, std::uint16_t port_num) override
	Function to create a new Tcp connection. More...

std::unique_ptr< uds_transport::Connection >	CreateUdpConnection (uds_transport::ConversionHandler &conversation, std::string_view udp_ip_address, std::uint16_t port_num) override
	Function to create a new Udp connection. More...

Public Member Functions inherited from uds_transport::UdsTransportProtocolHandler
	UdsTransportProtocolHandler (UdsTransportProtocolHandlerId const handler_id, UdsTransportProtocolMgr const &)
	Constructs an instance of UdsTransportProtocolHandler. More...

virtual	~UdsTransportProtocolHandler ()=default
	Destruct an instance of UdsTransportProtocolHandler. More...

virtual UdsTransportProtocolHandlerId	GetHandlerID () const
	Function to get the handler id. More...

virtual std::unique_ptr< Connection >	CreateTcpConnection (ConversionHandler &conversion_handler, std::string_view tcpIpaddress, uint16_t portNum)=0
	Function to create a new Tcp connection. More...

virtual std::unique_ptr< Connection >	CreateUdpConnection (ConversionHandler &conversion_handler, std::string_view udpIpaddress, uint16_t portNum)=0
	Function to create a new Udp connection. More...

Private Attributes
connection::ConnectionManager	connection_mgr_
	Store Doip Connection manager. More...

Additional Inherited Members
Protected Attributes inherited from uds_transport::UdsTransportProtocolHandler
UdsTransportProtocolHandlerId	handler_id_
	Store the handler id. More...

Detailed Description

Protocol handler class to manage the whole Doip protocol communication.

This class must be instantiated by user for using the DoIP functionalities. This will inherit uds transport protocol handler

Definition at line 25 of file doip_transport_protocol_handler.h.

Member Typedef Documentation

◆ InitializationResult

using doip_client::transport_protocol_handler::DoipTransportProtocolHandler::InitializationResult = uds_transport::UdsTransportProtocolHandler::InitializationResult

Type alias for Initialization result.

Definition at line 36 of file doip_transport_protocol_handler.h.

◆ UdsTransportProtocolHandlerId

using doip_client::transport_protocol_handler::DoipTransportProtocolHandler::UdsTransportProtocolHandlerId = uds_transport::UdsTransportProtocolHandler::UdsTransportProtocolHandlerId

Type alias for handler id.

Definition at line 30 of file doip_transport_protocol_handler.h.

Constructor & Destructor Documentation

◆ DoipTransportProtocolHandler()

doip_client::transport_protocol_handler::DoipTransportProtocolHandler::DoipTransportProtocolHandler	(	UdsTransportProtocolHandlerId	handler_id,
		uds_transport::UdsTransportProtocolMgr const &	transport_protocol_mgr
	)

Constructs an instance of DoipTransportProtocolHandler.

Parameters

[in]	handler_id	The id of this transport protocol handler
[in]	transport_protocol_mgr	The reference to transport protocol manager

Definition at line 16 of file doip_transport_protocol_handler.cpp.

19 : uds_transport::UdsTransportProtocolHandler(handler_id, transport_protocol_mgr) {}

uds_transport::UdsTransportProtocolHandler

Definition: protocol_handler.h:22

◆ ~DoipTransportProtocolHandler()

doip_client::transport_protocol_handler::DoipTransportProtocolHandler::~DoipTransportProtocolHandler ( )

finaldefault

Destruct an instance of DoipTransportProtocolHandler.

Member Function Documentation

◆ CreateTcpConnection()

std::unique_ptr< uds_transport::Connection > doip_client::transport_protocol_handler::DoipTransportProtocolHandler::CreateTcpConnection	(	uds_transport::ConversionHandler &	conversation,
		std::string_view	tcp_ip_address,
		std::uint16_t	port_num
	)

override

Function to create a new Tcp connection.

Parameters

[in]	conversation	The conversation handler used by tcp connection to communicate
[in]	tcp_ip_address	The local tcp ip address
[in]	port_num	The local port number

Returns: The unique pointer to the connection created

Definition at line 31 of file doip_transport_protocol_handler.cpp.

                           {
   logger::DoipClientLogger::GetDiagClientLogger().GetLogger().LogInfo(
       FILE_NAME, __LINE__, __func__, [tcp_ip_address](std::stringstream &msg) {
         msg << "DoIP Tcp protocol requested with local endpoint : "
             << "<Tcp: " << tcp_ip_address << ">";
       });
   return connection_mgr_.CreateTcpConnection(conversation, tcp_ip_address, port_num);
 }

References connection_mgr_, doip_client::connection::ConnectionManager::CreateTcpConnection(), FILE_NAME, and doip_client::logger::DoipClientLogger::GetDiagClientLogger().

Here is the call graph for this function:

◆ CreateUdpConnection()

std::unique_ptr< uds_transport::Connection > doip_client::transport_protocol_handler::DoipTransportProtocolHandler::CreateUdpConnection	(	uds_transport::ConversionHandler &	conversation,
		std::string_view	udp_ip_address,
		std::uint16_t	port_num
	)

override

Function to create a new Udp connection.

Parameters

[in]	conversation	The conversation handler used by udp connection to communicate
[in]	udp_ip_address	The local udp ip address
[in]	port_num	The local port number

Returns: The unique pointer to the connection created

Definition at line 42 of file doip_transport_protocol_handler.cpp.

                           {
   logger::DoipClientLogger::GetDiagClientLogger().GetLogger().LogInfo(
       FILE_NAME, __LINE__, __func__, [udp_ip_address](std::stringstream &msg) {
         msg << "DoIP Udp protocol requested with local endpoint : "
             << "<Udp: " << udp_ip_address << ">";
       });
   return connection_mgr_.CreateUdpConnection(conversation, udp_ip_address, port_num);
 }

References connection_mgr_, doip_client::connection::ConnectionManager::CreateUdpConnection(), FILE_NAME, and doip_client::logger::DoipClientLogger::GetDiagClientLogger().

Here is the call graph for this function:

◆ Initialize()

DoipTransportProtocolHandler::InitializationResult doip_client::transport_protocol_handler::DoipTransportProtocolHandler::Initialize ( )

overridevirtual

Function to initialize the handler.

Returns: The initialization result

Implements uds_transport::UdsTransportProtocolHandler.

Definition at line 23 of file doip_transport_protocol_handler.cpp.

                                                                                           {
   return InitializationResult::kInitializeOk;
 }

References uds_transport::UdsTransportProtocolHandler::kInitializeOk.

◆ Start()

void doip_client::transport_protocol_handler::DoipTransportProtocolHandler::Start ( )

overridevirtual

Function to start the protocol handler.

Implements uds_transport::UdsTransportProtocolHandler.

Definition at line 27 of file doip_transport_protocol_handler.cpp.

27 {}

◆ Stop()

void doip_client::transport_protocol_handler::DoipTransportProtocolHandler::Stop ( )

overridevirtual

Function to stop the protocol handler.

Implements uds_transport::UdsTransportProtocolHandler.

Definition at line 29 of file doip_transport_protocol_handler.cpp.

29 {}

Member Data Documentation

◆ connection_mgr_

connection::ConnectionManager doip_client::transport_protocol_handler::DoipTransportProtocolHandler::connection_mgr_

private

Store Doip Connection manager.

Definition at line 102 of file doip_transport_protocol_handler.h.

Referenced by CreateTcpConnection(), and CreateUdpConnection().

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

/home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/doip-client/doip_transport_protocol_handler.h
/home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/doip-client/doip_transport_protocol_handler.cpp

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ InitializationResult

◆ UdsTransportProtocolHandlerId

Constructor & Destructor Documentation

◆ DoipTransportProtocolHandler()

◆ ~DoipTransportProtocolHandler()

Member Function Documentation

◆ CreateTcpConnection()

◆ CreateUdpConnection()

◆ Initialize()

◆ Start()

◆ Stop()

Member Data Documentation

◆ connection_mgr_