Doip Tcp Connection handle connection between two layers. More...

Inheritance diagram for doip_client::connection::DoipTcpConnection:

Collaboration diagram for doip_client::connection::DoipTcpConnection:

[legend]

Public Types
using	InitializationResult = uds_transport::Connection::InitializationResult
	Type alias for Initialization result. More...

using	TcpClient = sockets::TcpSocketHandler::Client
	Type alias for Tcp client used by socket handler. More...

Public Types inherited from uds_transport::Connection
using	ConnectionId = std::uint8_t
	Type alias for connection id. More...

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

Public Member Functions
	DoipTcpConnection (uds_transport::ConversionHandler const &conversation_handler, std::string_view tcp_ip_address, std::uint16_t port_num)
	Constructor to create a new tcp connection. More...

	~DoipTcpConnection () final=default
	Destruct an instance of DoipTcpConnection. More...

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

void	Start () override
	Function to start the connection. More...

void	Stop () override
	Function to stop the connection. More...

bool	IsConnectToHost () override
	Function to check if connected to host remote server. More...

uds_transport::UdsTransportProtocolMgr::ConnectionResult	ConnectToHost (uds_transport::UdsMessageConstPtr message) override
	Function to establish connection to remote host server. More...

uds_transport::UdsTransportProtocolMgr::DisconnectionResult	DisconnectFromHost () override
	Function to disconnect from remote host server. More...

std::pair< uds_transport::UdsTransportProtocolMgr::IndicationResult, uds_transport::UdsMessagePtr >	IndicateMessage (uds_transport::UdsMessage::Address source_addr, uds_transport::UdsMessage::Address target_addr, uds_transport::UdsMessage::TargetAddressType type, uds_transport::ChannelID channel_id, std::size_t size, uds_transport::Priority priority, uds_transport::ProtocolKind protocol_kind, core_type::Span< std::uint8_t const > payload_info) override
	Function to indicate a start of reception of message. More...

uds_transport::UdsTransportProtocolMgr::TransmissionResult	Transmit (uds_transport::UdsMessageConstPtr message) override
	Function to transmit a valid Uds message. More...

void	HandleMessage (uds_transport::UdsMessagePtr message) override
	Function to Hands over a valid received Uds message. More...

Public Member Functions inherited from uds_transport::Connection
	Connection (std::string_view connection_name, ConnectionId connection_id, uds_transport::ConversionHandler const &conversation_handler) noexcept
	Constructor to create a new connection. More...

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

ConnectionId	GetConnectionId () const noexcept
	Function to get the connection id. More...

std::string_view	GetConnectionName () const noexcept
	Function to get the connection name. More...

Private Attributes
channel::tcp_channel::DoipTcpChannel	doip_tcp_channel_
	Store the doip tcp channel. More...

Additional Inherited Members
Protected Attributes inherited from uds_transport::Connection
uds_transport::ConversionHandler const &	conversation_handler_
	Store the conversation handler. More...

Detailed Description

Doip Tcp Connection handle connection between two layers.

Definition at line 38 of file connection_manager.cpp.

Member Typedef Documentation

◆ InitializationResult

using doip_client::connection::DoipTcpConnection::InitializationResult = uds_transport::Connection::InitializationResult

Type alias for Initialization result.

Definition at line 43 of file connection_manager.cpp.

◆ TcpClient

using doip_client::connection::DoipTcpConnection::TcpClient = sockets::TcpSocketHandler::Client

Type alias for Tcp client used by socket handler.

Definition at line 48 of file connection_manager.cpp.

Constructor & Destructor Documentation

◆ DoipTcpConnection()

doip_client::connection::DoipTcpConnection::DoipTcpConnection	(	uds_transport::ConversionHandler const &	conversation_handler,
		std::string_view	tcp_ip_address,
		std::uint16_t	port_num
	)

inline

Constructor to create a new tcp connection.

Parameters

[in]	conversation_handler	The reference to conversation handler
[in]	tcp_ip_address	The local tcp ip address
[in]	port_num	The local port number
[in]	io_context	The reference to io context

Definition at line 61 of file connection_manager.cpp.

       : uds_transport::Connection{kDoipTcpConnectionName, 1u, conversation_handler},
         doip_tcp_channel_{
             sockets::TcpSocketHandler{TcpClient{GetConnectionName(), tcp_ip_address, port_num}},
             *this} {}

◆ ~DoipTcpConnection()

doip_client::connection::DoipTcpConnection::~DoipTcpConnection ( )

finaldefault

Destruct an instance of DoipTcpConnection.

Member Function Documentation

◆ ConnectToHost()

uds_transport::UdsTransportProtocolMgr::ConnectionResult doip_client::connection::DoipTcpConnection::ConnectToHost ( uds_transport::UdsMessageConstPtr message )

inlineoverridevirtual

Function to establish connection to remote host server.

Parameters

[in] message The connection message

Returns: Connection result

Implements uds_transport::Connection.

Definition at line 101 of file connection_manager.cpp.

                                                         {
     return (doip_tcp_channel_.ConnectToHost(std::move(message)));
   }

References doip_client::channel::tcp_channel::DoipTcpChannel::ConnectToHost(), and doip_tcp_channel_.

Here is the call graph for this function:

◆ DisconnectFromHost()

uds_transport::UdsTransportProtocolMgr::DisconnectionResult doip_client::connection::DoipTcpConnection::DisconnectFromHost ( )

inlineoverridevirtual

Function to disconnect from remote host server.

Returns: Disconnection result

Implements uds_transport::Connection.

Definition at line 110 of file connection_manager.cpp.

                                                                                         {
     return (doip_tcp_channel_.DisconnectFromHost());
   }

References doip_client::channel::tcp_channel::DoipTcpChannel::DisconnectFromHost(), and doip_tcp_channel_.

Here is the call graph for this function:

◆ HandleMessage()

void doip_client::connection::DoipTcpConnection::HandleMessage ( uds_transport::UdsMessagePtr message )

inlineoverridevirtual

Function to Hands over a valid received Uds message.

Parameters

[in] message The Uds message ptr (unique_ptr semantics) with the request. Ownership of the UdsMessage is given back to the conversation here

Implements uds_transport::Connection.

Definition at line 166 of file connection_manager.cpp.

                                                                   {
     conversation_handler_.HandleMessage(std::move(message));
   }

References uds_transport::Connection::conversation_handler_, and uds_transport::ConversionHandler::HandleMessage().

Here is the call graph for this function:

◆ IndicateMessage()

std::pair<uds_transport::UdsTransportProtocolMgr::IndicationResult, uds_transport::UdsMessagePtr> doip_client::connection::DoipTcpConnection::IndicateMessage	(	uds_transport::UdsMessage::Address	source_addr,
		uds_transport::UdsMessage::Address	target_addr,
		uds_transport::UdsMessage::TargetAddressType	type,
		uds_transport::ChannelID	channel_id,
		std::size_t	size,
		uds_transport::Priority	priority,
		uds_transport::ProtocolKind	protocol_kind,
		core_type::Span< std::uint8_t const >	payload_info
	)

inlineoverridevirtual

Function to indicate a start of reception of message.

This is called to indicate the reception of new message by underlying transport protocol handler

Parameters

[in]	source_addr	The UDS source address of message
[in]	target_addr	The UDS target address of message
[in]	type	The indication whether its is phys/func request
[in]	channel_id	The transport protocol channel on which message start happened
[in]	size	The size in bytes of the UdsMessage starting from SID
[in]	priority	The priority of the given message, used for prioritization of conversations
[in]	protocol_kind	The identifier of protocol kind associated to message
[in]	payload_info	The view onto the first received payload bytes, if any. This view shall be used only within this function call. It is recommended that the TP provides at least the first two bytes of the request message, so the DM can identify a functional TesterPresent

Returns: std::pair< IndicationResult, UdsMessagePtr > The pair of IndicationResult and a pointer to UdsMessage owned/created by DM core and returned to the handler to get filled

Implements uds_transport::Connection.

Definition at line 140 of file connection_manager.cpp.

                                                                          {
     return (conversation_handler_.IndicateMessage(source_addr, target_addr, type, channel_id, size,
                                                   priority, protocol_kind, payload_info));
   }

References uds_transport::Connection::conversation_handler_, and uds_transport::ConversionHandler::IndicateMessage().

Here is the call graph for this function:

◆ Initialize()

InitializationResult doip_client::connection::DoipTcpConnection::Initialize ( )

inlineoverridevirtual

Function to initialize the connection.

Returns: The initialization result

Implements uds_transport::Connection.

Definition at line 77 of file connection_manager.cpp.

77 { return InitializationResult::kInitializeOk; }

uds_transport::UdsTransportProtocolHandler::InitializationResult::kInitializeOk

@ kInitializeOk

References uds_transport::UdsTransportProtocolHandler::kInitializeOk.

◆ IsConnectToHost()

bool doip_client::connection::DoipTcpConnection::IsConnectToHost ( )

inlineoverridevirtual

Function to check if connected to host remote server.

Returns: True if connected, False otherwise

Implements uds_transport::Connection.

Definition at line 93 of file connection_manager.cpp.

93 { return (doip_tcp_channel_.IsConnectedToHost()); }

doip_client::channel::tcp_channel::DoipTcpChannel::IsConnectedToHost

bool IsConnectedToHost()

Function to check if connected to host remote server.

Definition: doip_tcp_channel.cpp:39

References doip_tcp_channel_, and doip_client::channel::tcp_channel::DoipTcpChannel::IsConnectedToHost().

Here is the call graph for this function:

◆ Start()

void doip_client::connection::DoipTcpConnection::Start ( )

inlineoverridevirtual

Function to start the connection.

Implements uds_transport::Connection.

Definition at line 82 of file connection_manager.cpp.

82 { doip_tcp_channel_.Start(); }

doip_client::channel::tcp_channel::DoipTcpChannel::Start

void Start()

Function to start the channel.

Definition: doip_tcp_channel.cpp:25

References doip_tcp_channel_, and doip_client::channel::tcp_channel::DoipTcpChannel::Start().

Here is the call graph for this function:

◆ Stop()

void doip_client::connection::DoipTcpConnection::Stop ( )

inlineoverridevirtual

Function to stop the connection.

Implements uds_transport::Connection.

Definition at line 87 of file connection_manager.cpp.

87 { doip_tcp_channel_.Stop(); }

doip_client::channel::tcp_channel::DoipTcpChannel::Stop

void Stop()

Function to stop the channel.

Definition: doip_tcp_channel.cpp:34

References doip_tcp_channel_, and doip_client::channel::tcp_channel::DoipTcpChannel::Stop().

Here is the call graph for this function:

◆ Transmit()

uds_transport::UdsTransportProtocolMgr::TransmissionResult doip_client::connection::DoipTcpConnection::Transmit ( uds_transport::UdsMessageConstPtr message )

inlineoverridevirtual

Function to transmit a valid Uds message.

Parameters

[in] message The Uds message ptr (unique_ptr semantics) with the request.

Implements uds_transport::Connection.

Definition at line 155 of file connection_manager.cpp.

                                                         {
     return doip_tcp_channel_.Transmit(std::move(message));
   }

References doip_tcp_channel_, and doip_client::channel::tcp_channel::DoipTcpChannel::Transmit().

Here is the call graph for this function:

Member Data Documentation

◆ doip_tcp_channel_

channel::tcp_channel::DoipTcpChannel doip_client::connection::DoipTcpConnection::doip_tcp_channel_

private

Store the doip tcp channel.

Definition at line 174 of file connection_manager.cpp.

Referenced by ConnectToHost(), DisconnectFromHost(), IsConnectToHost(), Start(), Stop(), and Transmit().

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

/home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/doip-client/connection/connection_manager.cpp

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ InitializationResult

◆ TcpClient

Constructor & Destructor Documentation

◆ DoipTcpConnection()

◆ ~DoipTcpConnection()

Member Function Documentation

◆ ConnectToHost()

◆ DisconnectFromHost()

◆ HandleMessage()

◆ IndicateMessage()

◆ Initialize()

◆ IsConnectToHost()

◆ Start()

◆ Stop()

◆ Transmit()

Member Data Documentation

◆ doip_tcp_channel_