Class implements routing activation handler. More...

Collaboration diagram for doip_client::channel::tcp_channel::DiagnosticMessageHandler::DiagnosticMessageHandlerImpl:

[legend]

Public Types
using	DiagnosticMessageStateContext = utility::state::StateContext< DiagnosticMessageState >
	Type alias for state context. More...

using	SyncTimer = utility::sync_timer::SyncTimer< std::chrono::steady_clock >
	Type alias for Sync timer. More...

Public Member Functions
	DiagnosticMessageHandlerImpl (sockets::TcpSocketHandler &tcp_socket_handler, DoipTcpChannel &channel)
	Constructs an instance of DiagnosticMessageHandlerImpl. 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...

auto	GetStateContext () noexcept -> DiagnosticMessageStateContext &
	Function to get the Diagnostic Message State context. More...

auto	GetSocketHandler () noexcept -> sockets::TcpSocketHandler &
	Function to get the socket handler. More...

auto	GetDoipChannel () noexcept -> DoipTcpChannel &
	Function to get the doip channel. More...

auto	GetSyncTimer () noexcept -> SyncTimer &
	Function to get the sync timer. More...

Private Attributes
sockets::TcpSocketHandler &	tcp_socket_handler_
	The reference to socket handler. More...

DoipTcpChannel &	channel_
	The reference to doip channel. More...

DiagnosticMessageStateContext	state_context_
	Stores the diagnostic message states. More...

SyncTimer	sync_timer_
	Store the synchronous timer. More...

Detailed Description

Class implements routing activation handler.

Definition at line 287 of file doip_diagnostic_message_handler.cpp.

Member Typedef Documentation

◆ DiagnosticMessageStateContext

using doip_client::channel::tcp_channel::DiagnosticMessageHandler::DiagnosticMessageHandlerImpl::DiagnosticMessageStateContext = utility::state::StateContext<DiagnosticMessageState>

Type alias for state context.

Definition at line 292 of file doip_diagnostic_message_handler.cpp.

◆ SyncTimer

using doip_client::channel::tcp_channel::DiagnosticMessageHandler::DiagnosticMessageHandlerImpl::SyncTimer = utility::sync_timer::SyncTimer<std::chrono::steady_clock>

Type alias for Sync timer.

Definition at line 297 of file doip_diagnostic_message_handler.cpp.

Constructor & Destructor Documentation

◆ DiagnosticMessageHandlerImpl()

doip_client::channel::tcp_channel::DiagnosticMessageHandler::DiagnosticMessageHandlerImpl::DiagnosticMessageHandlerImpl	(	sockets::TcpSocketHandler &	tcp_socket_handler,
		DoipTcpChannel &	channel
	)

inline

Constructs an instance of DiagnosticMessageHandlerImpl.

Parameters

[in]	tcp_socket_handler	The reference to socket handler
[in]	channel	The reference to doip channel

Definition at line 306 of file doip_diagnostic_message_handler.cpp.

       : tcp_socket_handler_{tcp_socket_handler},
         channel_{channel},
         state_context_{},
         sync_timer_{} {
     // create and add state for Diagnostic State
     // kIdle
     state_context_.AddState(DiagnosticMessageState::kIdle,
                             std::make_unique<kIdle>(DiagnosticMessageState::kIdle));
     // kSendDiagnosticReqFailed
     state_context_.AddState(DiagnosticMessageState::kSendDiagnosticReqFailed,
                             std::make_unique<kSendDiagnosticReqFailed>(
                                 DiagnosticMessageState::kSendDiagnosticReqFailed));
     // kWaitForDiagnosticAck
     state_context_.AddState(
         DiagnosticMessageState::kWaitForDiagnosticAck,
         std::make_unique<kWaitForDiagnosticAck>(DiagnosticMessageState::kWaitForDiagnosticAck));
     // kDiagnosticPositiveAckRecvd
     state_context_.AddState(DiagnosticMessageState::kDiagnosticPositiveAckRecvd,
                             std::make_unique<kDiagnosticPositiveAckRecvd>(
                                 DiagnosticMessageState::kDiagnosticPositiveAckRecvd));
     // kDiagnosticNegativeAckRecvd
     state_context_.AddState(DiagnosticMessageState::kDiagnosticNegativeAckRecvd,
                             std::make_unique<kDiagnosticNegativeAckRecvd>(
                                 DiagnosticMessageState::kDiagnosticNegativeAckRecvd));
     // kWaitForDiagnosticResponse
     state_context_.AddState(DiagnosticMessageState::kWaitForDiagnosticResponse,
                             std::make_unique<kWaitForDiagnosticResponse>(
                                 DiagnosticMessageState::kWaitForDiagnosticResponse));
     // Transit to idle state
     state_context_.TransitionTo(DiagnosticMessageState::kIdle);
   }

References utility::state::StateContext< EnumState >::AddState(), state_context_, and utility::state::StateContext< EnumState >::TransitionTo().

Here is the call graph for this function:

Member Function Documentation

◆ GetDoipChannel()

auto doip_client::channel::tcp_channel::DiagnosticMessageHandler::DiagnosticMessageHandlerImpl::GetDoipChannel ( ) -> DoipTcpChannel &

inlinenoexcept

Function to get the doip channel.

Returns: The reference to channel

Definition at line 376 of file doip_diagnostic_message_handler.cpp.

376 { return channel_; }

References channel_.

◆ GetSocketHandler()

auto doip_client::channel::tcp_channel::DiagnosticMessageHandler::DiagnosticMessageHandlerImpl::GetSocketHandler ( ) -> sockets::TcpSocketHandler &

inlinenoexcept

Function to get the socket handler.

Returns: The reference to socket handler

Definition at line 370 of file doip_diagnostic_message_handler.cpp.

370 { return tcp_socket_handler_; }

References tcp_socket_handler_.

◆ GetStateContext()

auto doip_client::channel::tcp_channel::DiagnosticMessageHandler::DiagnosticMessageHandlerImpl::GetStateContext ( ) -> DiagnosticMessageStateContext &

inlinenoexcept

Function to get the Diagnostic Message State context.

Returns: The reference to state context

Definition at line 364 of file doip_diagnostic_message_handler.cpp.

364 { return state_context_; }

References state_context_.

◆ GetSyncTimer()

auto doip_client::channel::tcp_channel::DiagnosticMessageHandler::DiagnosticMessageHandlerImpl::GetSyncTimer ( ) -> SyncTimer &

inlinenoexcept

Function to get the sync timer.

Returns: The reference to sync timer

Definition at line 382 of file doip_diagnostic_message_handler.cpp.

382 { return sync_timer_; }

References sync_timer_.

◆ Reset()

void doip_client::channel::tcp_channel::DiagnosticMessageHandler::DiagnosticMessageHandlerImpl::Reset ( )

inline

Function to reset the handler.

This will reset all the internal handler back to default state

Definition at line 358 of file doip_diagnostic_message_handler.cpp.

358 { Stop(); }

doip_client::channel::tcp_channel::DiagnosticMessageHandler::DiagnosticMessageHandlerImpl::Stop

void Stop()

Function to stop the handler.

Definition: doip_diagnostic_message_handler.cpp:349

References Stop().

Here is the call graph for this function:

◆ Start()

void doip_client::channel::tcp_channel::DiagnosticMessageHandler::DiagnosticMessageHandlerImpl::Start ( )

inline

Function to start the handler.

Definition at line 343 of file doip_diagnostic_message_handler.cpp.

343 {}

◆ Stop()

void doip_client::channel::tcp_channel::DiagnosticMessageHandler::DiagnosticMessageHandlerImpl::Stop ( )

inline

Function to stop the handler.

This will reset all the internal handler back to default state

Definition at line 349 of file doip_diagnostic_message_handler.cpp.

               {
     if (sync_timer_.IsTimerActive()) { sync_timer_.CancelWait(); }
     state_context_.TransitionTo(DiagnosticMessageState::kIdle);
   }