doip_client::channel::udp_channel::VehicleDiscoveryHandler::VehicleDiscoveryHandlerImpl Class Reference

Class implements vehicle discovery handler. More...

Collaboration diagram for doip_client::channel::udp_channel::VehicleDiscoveryHandler::VehicleDiscoveryHandlerImpl:

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

Public Member Functions
	VehicleDiscoveryHandlerImpl (sockets::UdpSocketHandler &udp_socket_handler)
	Constructs an instance of VehicleDiscoveryHandlerImpl. More...
auto	GetStateContext () noexcept -> VehicleDiscoveryStateContext &
	Function to get the Vehicle Discovery State context. More...
auto	GetSocketHandler () noexcept -> sockets::UdpSocketHandler &
	Function to get the socket handler. More...

Private Attributes
sockets::UdpSocketHandler &	udp_socket_handler_
	The reference to socket handler. More...
VehicleDiscoveryStateContext	state_context_
	Stores the vehicle discovery states. More...

Detailed Description

Class implements vehicle discovery handler.

Definition at line 97 of file doip_vehicle_discovery_handler.cpp.

Member Typedef Documentation

VehicleDiscoveryStateContext

using doip_client::channel::udp_channel::VehicleDiscoveryHandler::VehicleDiscoveryHandlerImpl::VehicleDiscoveryStateContext = utility::state::StateContext<VehicleDiscoveryState>

Type alias for state context.

Definition at line 102 of file doip_vehicle_discovery_handler.cpp.

Constructor & Destructor Documentation

VehicleDiscoveryHandlerImpl()

doip_client::channel::udp_channel::VehicleDiscoveryHandler::VehicleDiscoveryHandlerImpl::VehicleDiscoveryHandlerImpl ( sockets::UdpSocketHandler &  udp_socket_handler )

inlineexplicit

Constructs an instance of VehicleDiscoveryHandlerImpl.

Parameters

[in]

udp_socket_handler

The reference to socket handler

Definition at line 109 of file doip_vehicle_discovery_handler.cpp.

      : udp_socket_handler_{udp_socket_handler},
        state_context_{} {
    // create and add state for vehicle discovery
    // kIdle
    state_context_.AddState(VehicleDiscoveryState::kIdle, std::make_unique<kIdle>(VehicleDiscoveryState::kIdle));
    // kWaitForVehicleAnnouncement
    state_context_.AddState(
        VehicleDiscoveryState::kWaitForVehicleAnnouncement,
        std::make_unique<kWaitForVehicleAnnouncement>(VehicleDiscoveryState::kWaitForVehicleAnnouncement));
    // kDoIPCtrlTimeout
    state_context_.AddState(VehicleDiscoveryState::kDoIPCtrlTimeout,
                            std::make_unique<kDoIPCtrlTimeout>(VehicleDiscoveryState::kDoIPCtrlTimeout));
    // Transit to wait for vehicle announcement
    state_context_.TransitionTo(VehicleDiscoveryState::kWaitForVehicleAnnouncement);
  }

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

GetSocketHandler()

auto doip_client::channel::udp_channel::VehicleDiscoveryHandler::VehicleDiscoveryHandlerImpl::GetSocketHandler ( ) -> sockets::UdpSocketHandler &

inlinenoexcept

Function to get the socket handler.

Returns

The reference to socket handler

Definition at line 136 of file doip_vehicle_discovery_handler.cpp.

{ return udp_socket_handler_; }

References udp_socket_handler_.

GetStateContext()

auto doip_client::channel::udp_channel::VehicleDiscoveryHandler::VehicleDiscoveryHandlerImpl::GetStateContext ( ) -> VehicleDiscoveryStateContext &

inlinenoexcept

Function to get the Vehicle Discovery State context.

Returns

The reference to state context

Definition at line 130 of file doip_vehicle_discovery_handler.cpp.

{ return state_context_; }

References state_context_.

Member Data Documentation

state_context_

VehicleDiscoveryStateContext doip_client::channel::udp_channel::VehicleDiscoveryHandler::VehicleDiscoveryHandlerImpl::state_context_

private

Stores the vehicle discovery states.

Definition at line 147 of file doip_vehicle_discovery_handler.cpp.

Referenced by GetStateContext(), and VehicleDiscoveryHandlerImpl().

udp_socket_handler_

sockets::UdpSocketHandler& doip_client::channel::udp_channel::VehicleDiscoveryHandler::VehicleDiscoveryHandlerImpl::udp_socket_handler_

private

The reference to socket handler.

Definition at line 142 of file doip_vehicle_discovery_handler.cpp.

Referenced by GetSocketHandler().

---

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/channel/udp_channel/doip_vehicle_discovery_handler.cpp