Woman, Life, Freedom


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

Client's service initial wait state. More...

#include <client_initial_wait_state.h>

Inheritance diagram for ara::com::someip::sd::fsm::ClientInitialWaitState:
ara::com::someip::sd::fsm::ClientServiceState ara::com::someip::sd::fsm::InitialWaitState< helper::SdClientState > ara::com::helper::MachineState< helper::SdClientState > ara::com::someip::sd::fsm::TimerSetState< T > ara::com::helper::MachineState< T >

Public Member Functions

 ClientInitialWaitState (helper::TtlTimer *ttlTimer, std::function< void()> onTimerExpired, int initialDelayMin, int initialDelayMax)
 Constructor. More...
 
 ClientInitialWaitState (const ClientInitialWaitState &)=delete
 
ClientInitialWaitStateoperator= (const ClientInitialWaitState &)=delete
 
- 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...
 
- Public Member Functions inherited from ara::com::someip::sd::fsm::InitialWaitState< helper::SdClientState >
 InitialWaitState (helper::SdClientState currentState, helper::SdClientState nextState, helper::SdClientState stoppedState, std::function< void()> onTimerExpired, int initialDelayMin, int initialDelayMax)
 Constructor. More...
 
 InitialWaitState (const InitialWaitState &)=delete
 
InitialWaitStateoperator= (const InitialWaitState &)=delete
 
- Public Member Functions inherited from ara::com::someip::sd::fsm::TimerSetState< T >
 TimerSetState (const TimerSetState &)=delete
 
TimerSetStateoperator= (const TimerSetState &)=delete
 
virtual void Activate (T previousState) override
 Activate the state. More...
 
void ServiceStopped () noexcept
 Inform the state that the server's service is stopped.
 
void SetNextState (T nextState) noexcept
 Set next state. More...
 
- Public Member Functions inherited from ara::com::helper::MachineState< T >
 MachineState (const MachineState &)=delete
 
MachineStateoperator= (const MachineState &)=delete
 
GetState () const noexcept
 Get the machine state. More...
 
void Register (AbstractStateMachine< T > *finiteStateMachine) noexcept
 Register the state to a finite state machine (FSM) More...
 

Protected Member Functions

void Activate (helper::SdClientState previousState) override
 Activate the state. More...
 
void SetTimer () override
 Set the phase time on state activation. 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 >
virtual void Deactivate (helper::SdClientState nextState)=0
 Deactivating the current state before transiting to the next state. More...
 
void Transit (helper::SdClientState nextState)
 Transit to the next state. More...
 
 MachineState (helper::SdClientState state) noexcept
 Constructor. More...
 
- Protected Member Functions inherited from ara::com::someip::sd::fsm::TimerSetState< T >
bool WaitFor (std::chrono::milliseconds duration)
 Wait for certian period of time. More...
 
bool WaitFor (int duration)
 Wait for certian period of time. More...
 
void Interrupt () noexcept
 Interrupt the timer. More...
 
 TimerSetState (T nextState, T stoppedState, std::function< void()> onTimerExpired)
 Constructor. More...
 
void Deactivate (T nextState) override
 Deactivating the current state before transiting to the next state. More...
 
- Protected Member Functions inherited from ara::com::helper::MachineState< T >
void Transit (T nextState)
 Transit to the next state. More...
 
 MachineState (T 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.
 
- Protected Attributes inherited from ara::com::someip::sd::fsm::InitialWaitState< helper::SdClientState >
const int InitialDelayMin
 Initial delay lower bound in milliseconds.
 
const int InitialDelayMax
 Initial delay higher bound in milliseconds.
 
- Protected Attributes inherited from ara::com::someip::sd::fsm::TimerSetState< T >
const std::function< void()> OnTimerExpired
 Delegate which is invoked by timer's thread when the timer is expired.
 

Detailed Description

Client's service initial wait state.

Constructor & Destructor Documentation

◆ ClientInitialWaitState()

ara::com::someip::sd::fsm::ClientInitialWaitState::ClientInitialWaitState ( helper::TtlTimer ttlTimer,
std::function< void()>  onTimerExpired,
int  initialDelayMin,
int  initialDelayMax 
)

Constructor.

Parameters
ttlTimerFinite machine state global TTL timer pointer
onTimerExpiredDelegate to be invoked by timer's thread when the timer is expired
initialDelayMinMinimum initial delay in milliseconds
initialDelayMaxMaximum initial delay in milliseconds

Member Function Documentation

◆ Activate()

void ara::com::someip::sd::fsm::ClientInitialWaitState::Activate ( helper::SdClientState  previousState)
overrideprotectedvirtual

Activate the state.

Parameters
previousStatePrevious state before transiting to this state

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

◆ SetTimer()

void ara::com::someip::sd::fsm::ClientInitialWaitState::SetTimer ( )
overrideprotectedvirtual

Set the phase time on state activation.

Reimplemented from ara::com::someip::sd::fsm::InitialWaitState< helper::SdClientState >.