com.thecoderscorner.menu.remote.states.RemoteConnectorState Interface Reference

Inheritance diagram for com.thecoderscorner.menu.remote.states.RemoteConnectorState:

Public Member Functions
void	enterState ()
void	exitState (RemoteConnectorState nextState)
AuthStatus	getAuthenticationStatus ()
boolean	canSendCommandToRemote (MenuCommand command)
void	runLoop () throws Exception

Member Function Documentation

canSendCommandToRemote()

boolean com.thecoderscorner.menu.remote.states.RemoteConnectorState.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.

Implemented in com.thecoderscorner.menu.remote.states.StreamNotConnectedState, com.thecoderscorner.menu.remote.states.SocketAwaitJoinState, com.thecoderscorner.menu.remote.states.SerialAwaitFirstMsgState, com.thecoderscorner.menu.remote.states.SendPairingMessageState, com.thecoderscorner.menu.remote.states.PairingAuthSuccessState, com.thecoderscorner.menu.remote.states.PairingAuthFailedState, com.thecoderscorner.menu.remote.states.NoOperationInitialState, com.thecoderscorner.menu.remote.states.JoinMessageArrivedState, com.thecoderscorner.menu.remote.states.ConnectionReadyState, com.thecoderscorner.menu.remote.states.ConnectionHasFailedState, com.thecoderscorner.menu.remote.states.BootstrapInProgressState, and com.thecoderscorner.menu.remote.states.AwaitingBootstrapState.

enterState()

void com.thecoderscorner.menu.remote.states.RemoteConnectorState.enterState

(

)

called when a state machine class becomes active

Implemented in com.thecoderscorner.menu.remote.states.StreamNotConnectedState, com.thecoderscorner.menu.remote.states.SocketAwaitJoinState, com.thecoderscorner.menu.remote.states.SendPairingMessageState, com.thecoderscorner.menu.remote.states.PairingAuthSuccessState, com.thecoderscorner.menu.remote.states.PairingAuthFailedState, com.thecoderscorner.menu.remote.states.NoOperationInitialState, com.thecoderscorner.menu.remote.states.JoinMessageArrivedState, com.thecoderscorner.menu.remote.states.ConnectionReadyState, com.thecoderscorner.menu.remote.states.ConnectionHasFailedState, and com.thecoderscorner.menu.remote.states.BaseMessageProcessingState.

exitState()

void com.thecoderscorner.menu.remote.states.RemoteConnectorState.exitState

(

RemoteConnectorState

nextState

)

called when a state machine class is deactivated

Implemented in com.thecoderscorner.menu.remote.states.StreamNotConnectedState, com.thecoderscorner.menu.remote.states.PairingAuthSuccessState, com.thecoderscorner.menu.remote.states.PairingAuthFailedState, com.thecoderscorner.menu.remote.states.NoOperationInitialState, com.thecoderscorner.menu.remote.states.ConnectionReadyState, com.thecoderscorner.menu.remote.states.ConnectionHasFailedState, and com.thecoderscorner.menu.remote.states.BaseMessageProcessingState.

getAuthenticationStatus()

AuthStatus com.thecoderscorner.menu.remote.states.RemoteConnectorState.getAuthenticationStatus

(

)

Returns

the current authentication status as determined by the state.

Implemented in com.thecoderscorner.menu.remote.states.StreamNotConnectedState, com.thecoderscorner.menu.remote.states.SocketAwaitJoinState, com.thecoderscorner.menu.remote.states.SerialAwaitFirstMsgState, com.thecoderscorner.menu.remote.states.SendPairingMessageState, com.thecoderscorner.menu.remote.states.PairingAuthSuccessState, com.thecoderscorner.menu.remote.states.PairingAuthFailedState, com.thecoderscorner.menu.remote.states.NoOperationInitialState, com.thecoderscorner.menu.remote.states.JoinMessageArrivedState, com.thecoderscorner.menu.remote.states.ConnectionReadyState, com.thecoderscorner.menu.remote.states.ConnectionHasFailedState, com.thecoderscorner.menu.remote.states.BootstrapInProgressState, and com.thecoderscorner.menu.remote.states.AwaitingBootstrapState.

runLoop()

void com.thecoderscorner.menu.remote.states.RemoteConnectorState.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.

Implemented in com.thecoderscorner.menu.remote.states.StreamNotConnectedState, com.thecoderscorner.menu.remote.states.PairingAuthSuccessState, com.thecoderscorner.menu.remote.states.PairingAuthFailedState, com.thecoderscorner.menu.remote.states.NoOperationInitialState, com.thecoderscorner.menu.remote.states.ConnectionHasFailedState, and com.thecoderscorner.menu.remote.states.BaseMessageProcessingState.

---

The documentation for this interface was generated from the following file:

• src/main/java/com/thecoderscorner/menu/remote/states/RemoteConnectorState.java