Woman, Life, Freedom


Adaptive AUTOSAR
ARA public interface header documentation
ara::com::someip::sd::fsm::ServiceSeenState Class Reference

Client's state when the service is seen (up) but not requested. More...

#include <service_seen_state.h>

Inheritance diagram for ara::com::someip::sd::fsm::ServiceSeenState:
ara::com::someip::sd::fsm::ClientServiceState ara::com::helper::MachineState< helper::SdClientState >

Public Member Functions

 ServiceSeenState (helper::TtlTimer *ttlTimer, std::condition_variable *conditionVariable) noexcept
 Constructor. More...
 
 ServiceSeenState (const ServiceSeenState &)=delete
 
ServiceSeenStateoperator= (const ServiceSeenState &)=delete
 
void Activate (helper::SdClientState previousState) override
 Activate the state. More...
 
- Public Member Functions inherited from ara::com::someip::sd::fsm::ClientServiceState
 ClientServiceState (const ClientServiceState &)=delete
 
ClientServiceStateoperator= (const ClientServiceState &)=delete
 
- Public Member Functions inherited from ara::com::helper::MachineState< helper::SdClientState >
 MachineState (const MachineState &)=delete
 
MachineStateoperator= (const MachineState &)=delete
 
helper::SdClientState GetState () const noexcept
 Get the machine state. More...
 
void Register (AbstractStateMachine< helper::SdClientState > *finiteStateMachine) noexcept
 Register the state to a finite state machine (FSM) More...
 

Protected Member Functions

void Deactivate (helper::SdClientState nextState) override
 Deactivating the current state before transiting to the next state. More...
 
- Protected Member Functions inherited from ara::com::someip::sd::fsm::ClientServiceState
 ClientServiceState (helper::TtlTimer *timer)
 Constructor. More...
 
- Protected Member Functions inherited from ara::com::helper::MachineState< helper::SdClientState >
void Transit (helper::SdClientState nextState)
 Transit to the next state. More...
 
 MachineState (helper::SdClientState state) noexcept
 Constructor. More...
 

Additional Inherited Members

- Protected Attributes inherited from ara::com::someip::sd::fsm::ClientServiceState
helper::TtlTimer *const Timer
 Timer to handle service offer entry TTL.
 

Detailed Description

Client's state when the service is seen (up) but not requested.

Note
The state is not copyable.

Constructor & Destructor Documentation

◆ ServiceSeenState()

ara::com::someip::sd::fsm::ServiceSeenState::ServiceSeenState ( helper::TtlTimer ttlTimer,
std::condition_variable *  conditionVariable 
)
noexcept

Constructor.

Parameters
ttlTimerFinite machine state global TTL timer pointer
conditionVariableCondition variable to be notified when the state activated

Member Function Documentation

◆ Activate()

void ara::com::someip::sd::fsm::ServiceSeenState::Activate ( helper::SdClientState  previousState)
overridevirtual

Activate the state.

Parameters
previousStatePrevious state before transiting to this state

Implements ara::com::helper::MachineState< helper::SdClientState >.

◆ Deactivate()

void ara::com::someip::sd::fsm::ServiceSeenState::Deactivate ( helper::SdClientState  nextState)
overrideprotectedvirtual

Deactivating the current state before transiting to the next state.

Parameters
nextStateNext state coming after deactivation

Implements ara::com::helper::MachineState< helper::SdClientState >.