Module com.thecoderscorner.tcmenu.javaapi
Package com.thecoderscorner.menu.remote.states

Interface RemoteConnectorState

All Known Implementing Classes:
AwaitingBootstrapState, BaseMessageProcessingState, BootstrapInProgressState, ConnectionHasFailedState, ConnectionReadyState, JoinMessageArrivedState, NoOperationInitialState, PairingAuthFailedState, PairingAuthSuccessState, SendPairingMessageState, SerialAwaitFirstMsgState, SocketAwaitJoinState, StreamNotConnectedState
public interface RemoteConnectorState

  • Method Details

    • enterState

      void enterState()
      called when a state machine class becomes active

    • exitState

      void exitState​(RemoteConnectorState nextState)
      called when a state machine class is deactivated

    • getAuthenticationStatus

      AuthStatus getAuthenticationStatus()
      Returns:
      the current authentication status as determined by the state.

    • canSendCommandToRemote

      boolean canSendCommandToRemote​(MenuCommand command)
      called before any command is sent in order for the state to disallow
      Parameters:
      command - the command to check
      Returns:
      true to send, false to suppress.

    • runLoop

      void runLoop() throws Exception
      called when a state is the current state, the state can read messages and attempt connections in this loop. It must be returned once the state is exited to avoid deadlocking the API. Exceptions can be thrown by the loop safely and will be logged in the connection logic.
      Throws:
      Exception