Class used as a handler to process routing activation messages. More...

#include <doip_routing_activation_handler.h>

Classes
class	RoutingActivationHandlerImpl
	Class implements routing activation handler. More...

Public Types
using	TcpMessagePtr = sockets::TcpSocketHandler::TcpMessagePtr
	Type alias for Tcp message pointer. More...

using	TcpMessage = sockets::TcpSocketHandler::TcpMessage
	Type alias for Tcp message. More...

Public Member Functions
	RoutingActivationHandler (sockets::TcpSocketHandler &tcp_socket_handler)
	Constructs an instance of RoutingActivationHandler. More...

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

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

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

void	Reset ()
	Function to reset the handler. More...

void	ProcessDoIPRoutingActivationResponse (DoipMessage &doip_payload) noexcept
	Function to process received routing activation response. More...

auto	HandleRoutingActivationRequest (uds_transport::UdsMessageConstPtr routing_activation_request) noexcept -> uds_transport::UdsTransportProtocolMgr::ConnectionResult
	Function to handle sending of routing activation request. More...

auto	IsRoutingActivated () noexcept -> bool
	Check if routing activation is active for this handler. More...

Private Member Functions
auto	SendRoutingActivationRequest (uds_transport::UdsMessageConstPtr routing_activation_request) noexcept -> uds_transport::UdsTransportProtocolMgr::TransmissionResult
	Function to send routing activation request. More...

Static Private Member Functions
static void	CreateDoipGenericHeader (std::vector< std::uint8_t > &doip_header, std::uint16_t payload_type, std::uint32_t payload_len)
	Function to create doip generic header. More...

Private Attributes
std::unique_ptr< RoutingActivationHandlerImpl >	handler_impl_
	Stores the Handler implementation. More...

Detailed Description

Class used as a handler to process routing activation messages.

Definition at line 29 of file doip_routing_activation_handler.h.

Member Typedef Documentation

◆ TcpMessage

using doip_client::channel::tcp_channel::RoutingActivationHandler::TcpMessage = sockets::TcpSocketHandler::TcpMessage

Type alias for Tcp message.

Definition at line 39 of file doip_routing_activation_handler.h.

◆ TcpMessagePtr

using doip_client::channel::tcp_channel::RoutingActivationHandler::TcpMessagePtr = sockets::TcpSocketHandler::TcpMessagePtr

Type alias for Tcp message pointer.

Definition at line 34 of file doip_routing_activation_handler.h.

Constructor & Destructor Documentation

◆ RoutingActivationHandler()

doip_client::channel::tcp_channel::RoutingActivationHandler::RoutingActivationHandler ( sockets::TcpSocketHandler & tcp_socket_handler )

explicit

Constructs an instance of RoutingActivationHandler.

Parameters

[in] tcp_socket_handler The reference to socket handler

Definition at line 310 of file doip_routing_activation_handler.cpp.

311 : handler_impl_{std::make_unique<RoutingActivationHandlerImpl>(tcp_socket_handler)} {}

doip_client::channel::tcp_channel::RoutingActivationHandler::handler_impl_

std::unique_ptr< RoutingActivationHandlerImpl > handler_impl_

Stores the Handler implementation.

Definition: doip_routing_activation_handler.h:119

◆ ~RoutingActivationHandler()

doip_client::channel::tcp_channel::RoutingActivationHandler::~RoutingActivationHandler ( )

default

Destruct an instance of RoutingActivationHandler.

Member Function Documentation

◆ CreateDoipGenericHeader()

void doip_client::channel::tcp_channel::RoutingActivationHandler::CreateDoipGenericHeader	(	std::vector< std::uint8_t > &	doip_header,
		std::uint16_t	payload_type,
		std::uint32_t	payload_len
	)

staticprivate

Function to create doip generic header.

Parameters

[in,out]	doip_header	The doip header
[in]	payload_type	The type of payload
[in]	payload_len	The length of payload

Definition at line 443 of file doip_routing_activation_handler.cpp.

                                                                                                           {
   doip_header_buffer.emplace_back(kDoip_ProtocolVersion);
   doip_header_buffer.emplace_back(~(static_cast<std::uint8_t>(kDoip_ProtocolVersion)));
   doip_header_buffer.emplace_back(static_cast<std::uint8_t>((payload_type & 0xFF00) >> 8));
   doip_header_buffer.emplace_back(static_cast<std::uint8_t>(payload_type & 0x00FF));
   doip_header_buffer.emplace_back(static_cast<std::uint8_t>((payload_len & 0xFF000000) >> 24));
   doip_header_buffer.emplace_back(static_cast<std::uint8_t>((payload_len & 0x00FF0000) >> 16));
   doip_header_buffer.emplace_back(static_cast<std::uint8_t>((payload_len & 0x0000FF00) >> 8));
   doip_header_buffer.emplace_back(static_cast<std::uint8_t>(payload_len & 0x000000FF));
 }

References doip_client::kDoip_ProtocolVersion.

◆ HandleRoutingActivationRequest()

auto doip_client::channel::tcp_channel::RoutingActivationHandler::HandleRoutingActivationRequest ( uds_transport::UdsMessageConstPtr routing_activation_request ) -> uds_transport::UdsTransportProtocolMgr::ConnectionResult

noexcept

Function to handle sending of routing activation request.

Parameters

[in] routing_activation_request The routing activation request

Returns: Transmission result

Definition at line 359 of file doip_routing_activation_handler.cpp.

                                                             {
   uds_transport::UdsTransportProtocolMgr::ConnectionResult result{
       uds_transport::UdsTransportProtocolMgr::ConnectionResult::kConnectionFailed};
   if (handler_impl_->GetStateContext().GetActiveState().GetState() == RoutingActivationState::kIdle) {
     if (SendRoutingActivationRequest(std::move(routing_activation_request)) ==
         uds_transport::UdsTransportProtocolMgr::TransmissionResult::kTransmitOk) {
       // Wait for routing activation response
       handler_impl_->GetStateContext().TransitionTo(RoutingActivationState::kWaitForRoutingActivationRes);
       handler_impl_->GetSyncTimer().WaitForTimeout(
           [this, &result]() {
             result = uds_transport::UdsTransportProtocolMgr::ConnectionResult::kConnectionTimeout;
             handler_impl_->GetStateContext().TransitionTo(RoutingActivationState::kIdle);
             logger::DoipClientLogger::GetDiagClientLogger().GetLogger().LogError(
                 __FILE__, __LINE__, "", [](std::stringstream &msg) {
                   msg << "RoutingActivation response timeout, no response received in: "
                       << kDoIPRoutingActivationTimeout << " milliseconds";
                 });
           },
           [this, &result]() {
             if (handler_impl_->GetStateContext().GetActiveState().GetState() ==
                 RoutingActivationState::kRoutingActivationSuccessful) {
               // success
               result = uds_transport::UdsTransportProtocolMgr::ConnectionResult::kConnectionOk;
               logger::DoipClientLogger::GetDiagClientLogger().GetLogger().LogInfo(
                   __FILE__, __LINE__, "",
                   [](std::stringstream &msg) { msg << "RoutingActivation successful with remote server"; });
             } else {  // failed
               handler_impl_->GetStateContext().TransitionTo(RoutingActivationState::kIdle);
               logger::DoipClientLogger::GetDiagClientLogger().GetLogger().LogError(
                   __FILE__, __LINE__, "",
                   [](std::stringstream &msg) { msg << "RoutingActivation failed with remote server"; });
             }
           },
           std::chrono::milliseconds{kDoIPRoutingActivationTimeout});
     } else {
       // failed, do nothing
       handler_impl_->GetStateContext().TransitionTo(RoutingActivationState::kIdle);
       logger::DoipClientLogger::GetDiagClientLogger().GetLogger().LogError(
           __FILE__, __LINE__, "",
           [](std::stringstream &msg) { msg << "RoutingActivation Request send failed with remote server"; });
     }
   } else {
     // channel not free
     logger::DoipClientLogger::GetDiagClientLogger().GetLogger().LogVerbose(
         __FILE__, __LINE__, "", [](std::stringstream &msg) { msg << "RoutingActivation channel not free"; });
   }
   return result;
 }

References doip_client::logger::DoipClientLogger::GetDiagClientLogger(), uds_transport::UdsTransportProtocolMgr::kConnectionFailed, uds_transport::UdsTransportProtocolMgr::kConnectionOk, uds_transport::UdsTransportProtocolMgr::kConnectionTimeout, doip_client::channel::tcp_channel::anonymous_namespace{doip_routing_activation_handler.cpp}::kDoIPRoutingActivationTimeout, and uds_transport::UdsTransportProtocolMgr::kTransmitOk.

Here is the call graph for this function:

◆ IsRoutingActivated()

auto doip_client::channel::tcp_channel::RoutingActivationHandler::IsRoutingActivated ( ) -> bool

noexcept

Check if routing activation is active for this handler.

Returns: True if activated, otherwise False

Definition at line 410 of file doip_routing_activation_handler.cpp.

                                                                    {
   return (handler_impl_->GetStateContext().GetActiveState().GetState() ==
           RoutingActivationState::kRoutingActivationSuccessful);
 }

References handler_impl_.

Referenced by doip_client::channel::tcp_channel::DoipTcpChannelHandler::IsRoutingActivated().

Here is the caller graph for this function:

◆ ProcessDoIPRoutingActivationResponse()

auto doip_client::channel::tcp_channel::RoutingActivationHandler::ProcessDoIPRoutingActivationResponse ( DoipMessage & doip_payload )

noexcept

Function to process received routing activation response.

Parameters

[in] doip_payload The doip message received

Definition at line 321 of file doip_routing_activation_handler.cpp.

                                                                                                               {
   RoutingActivationState final_state{RoutingActivationState::kRoutingActivationFailed};
   if (handler_impl_->GetStateContext().GetActiveState().GetState() ==
       RoutingActivationState::kWaitForRoutingActivationRes) {
     // get the ack code
     RoutingActivationAckType const rout_act_type{doip_payload.GetPayload()[0u]};
     switch (rout_act_type.act_type_) {
       case kDoip_RoutingActivation_ResCode_RoutingSuccessful: {
         // routing successful
         final_state = RoutingActivationState::kRoutingActivationSuccessful;
         logger::DoipClientLogger::GetDiagClientLogger().GetLogger().LogInfo(
             __FILE__, __LINE__, __func__, [&doip_payload](std::stringstream &msg) {
               msg << "RoutingActivation successfully activated in remote server with logical Address"
                   << " (0x" << std::hex << doip_payload.GetServerAddress() << ")";
             });
       } break;
       case kDoip_RoutingActivation_ResCode_ConfirmtnRequired: {
         // trigger routing activation after sometime, not implemented yet
         logger::DoipClientLogger::GetDiagClientLogger().GetLogger().LogInfo(
             __FILE__, __LINE__, __func__, [&doip_payload](std::stringstream &msg) {
               msg << "RoutingActivation is activated, confirmation required in remote server with logical Address"
                   << " (0x" << std::hex << doip_payload.GetServerAddress() << ")";
             });
       } break;
       default:
         // failure, do nothing
         logger::DoipClientLogger::GetDiagClientLogger().GetLogger().LogWarn(
             __FILE__, __LINE__, __func__,
             [&rout_act_type](std::stringstream &msg) { msg << "Routing activation denied due to " << rout_act_type; });
         break;
     }
     handler_impl_->GetStateContext().TransitionTo(final_state);
     handler_impl_->GetSyncTimer().CancelWait();
   } else {
     /* ignore */
   }
 }

References doip_client::logger::DoipClientLogger::GetDiagClientLogger(), doip_client::channel::tcp_channel::anonymous_namespace{doip_routing_activation_handler.cpp}::kDoip_RoutingActivation_ResCode_ConfirmtnRequired, and doip_client::channel::tcp_channel::anonymous_namespace{doip_routing_activation_handler.cpp}::kDoip_RoutingActivation_ResCode_RoutingSuccessful.

Here is the call graph for this function:

◆ Reset()

void doip_client::channel::tcp_channel::RoutingActivationHandler::Reset ( )

Function to reset the handler.

This will reset all the internal handler back to default state

Definition at line 319 of file doip_routing_activation_handler.cpp.

319 { handler_impl_->Reset(); }

References handler_impl_.

Referenced by doip_client::channel::tcp_channel::DoipTcpChannelHandler::Reset().

Here is the caller graph for this function:

◆ SendRoutingActivationRequest()

auto doip_client::channel::tcp_channel::RoutingActivationHandler::SendRoutingActivationRequest ( uds_transport::UdsMessageConstPtr routing_activation_request ) -> uds_transport::UdsTransportProtocolMgr::TransmissionResult

privatenoexcept

Function to send routing activation request.

Parameters

[in] routing_activation_request The routing activation request

Returns: Transmission result

Definition at line 415 of file doip_routing_activation_handler.cpp.

                                                               {
   uds_transport::UdsTransportProtocolMgr::TransmissionResult ret_val{
       uds_transport::UdsTransportProtocolMgr::TransmissionResult::kTransmitFailed};
   TcpMessagePtr doip_routing_act_req{std::make_unique<TcpMessage>()};
   // reserve bytes in vector
   doip_routing_act_req->GetTxBuffer().reserve(kDoipheadrSize + kDoip_RoutingActivation_ReqMinLen);
   // create header
   CreateDoipGenericHeader(doip_routing_act_req->GetTxBuffer(), kDoip_RoutingActivation_ReqType,
                           kDoip_RoutingActivation_ReqMinLen);
   // Add source address
   doip_routing_act_req->GetTxBuffer().emplace_back(static_cast<std::uint8_t>((message->GetSa() & 0xFF00) >> 8u));
   doip_routing_act_req->GetTxBuffer().emplace_back(static_cast<std::uint8_t>(message->GetSa() & 0x00FF));
   // Add activation type
   doip_routing_act_req->GetTxBuffer().emplace_back(kDoip_RoutingActivation_ReqActType_Default);
   // Add reservation byte , default zeroes
   doip_routing_act_req->GetTxBuffer().emplace_back(0x00);
   doip_routing_act_req->GetTxBuffer().emplace_back(0x00);
   doip_routing_act_req->GetTxBuffer().emplace_back(0x00);
   doip_routing_act_req->GetTxBuffer().emplace_back(0x00);
  
   // Initiate transmission
   if (handler_impl_->GetSocketHandler().Transmit(std::move(doip_routing_act_req))) {
     ret_val = uds_transport::UdsTransportProtocolMgr::TransmissionResult::kTransmitOk;
   }
   return ret_val;
 }

References doip_client::channel::udp_channel::anonymous_namespace{doip_vehicle_identification_handler.cpp}::CreateDoipGenericHeader(), doip_client::channel::tcp_channel::anonymous_namespace{doip_routing_activation_handler.cpp}::kDoip_RoutingActivation_ReqActType_Default, doip_client::channel::tcp_channel::anonymous_namespace{doip_routing_activation_handler.cpp}::kDoip_RoutingActivation_ReqMinLen, doip_client::channel::tcp_channel::anonymous_namespace{doip_routing_activation_handler.cpp}::kDoip_RoutingActivation_ReqType, doip_client::kDoipheadrSize, uds_transport::UdsTransportProtocolMgr::kTransmitFailed, and uds_transport::UdsTransportProtocolMgr::kTransmitOk.

Here is the call graph for this function:

◆ Start()

void doip_client::channel::tcp_channel::RoutingActivationHandler::Start ( )

Function to start the handler.

Definition at line 315 of file doip_routing_activation_handler.cpp.

315 { handler_impl_->Start(); }

References handler_impl_.

Referenced by doip_client::channel::tcp_channel::DoipTcpChannelHandler::Start().

Here is the caller graph for this function:

◆ Stop()

void doip_client::channel::tcp_channel::RoutingActivationHandler::Stop ( )

Function to stop the handler.

This will reset all the internal handler back to default state

Definition at line 317 of file doip_routing_activation_handler.cpp.

317 { handler_impl_->Stop(); }

References handler_impl_.

Referenced by doip_client::channel::tcp_channel::DoipTcpChannelHandler::Stop().

Here is the caller graph for this function:

Member Data Documentation

◆ handler_impl_

std::unique_ptr<RoutingActivationHandlerImpl> doip_client::channel::tcp_channel::RoutingActivationHandler::handler_impl_

private

Stores the Handler implementation.

Definition at line 124 of file doip_routing_activation_handler.h.

Referenced by IsRoutingActivated(), Reset(), Start(), and Stop().

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/channel/tcp_channel/doip_routing_activation_handler.h
/home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/doip-client/channel/tcp_channel/doip_routing_activation_handler.cpp

Classes

Public Types

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ TcpMessage

◆ TcpMessagePtr

Constructor & Destructor Documentation

◆ RoutingActivationHandler()

◆ ~RoutingActivationHandler()

Member Function Documentation

◆ CreateDoipGenericHeader()

◆ HandleRoutingActivationRequest()

◆ IsRoutingActivated()

◆ ProcessDoIPRoutingActivationResponse()

◆ Reset()

◆ SendRoutingActivationRequest()

◆ Start()

◆ Stop()

Member Data Documentation

◆ handler_impl_