Module com.thecoderscorner.tcmenu.javaapi

Package com.thecoderscorner.menu.remote.states

Class ConnectionHasFailedState

java.lang.Object

com.thecoderscorner.menu.remote.states.ConnectionHasFailedState

All Implemented Interfaces:

RemoteConnectorState

public class ConnectionHasFailedState
extends Object
implements RemoteConnectorState

Constructor Summary

Constructors

Constructor	Description
ConnectionHasFailedState(RemoteConnectorContext context)

Method Summary

Modifier and Type	Method	Description
boolean	canSendCommandToRemote(MenuCommand command)	called before any command is sent in order for the state to disallow
void	enterState()	called when a state machine class becomes active
void	exitState(RemoteConnectorState nextState)	called when a state machine class is deactivated
AuthStatus	getAuthenticationStatus()
void	runLoop()	called when a state is the current state, the state can read messages and attempt connections in this loop.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConnectionHasFailedState

public ConnectionHasFailedState(RemoteConnectorContext context)

Method Details

enterState

public void enterState()

Description copied from interface: RemoteConnectorState

called when a state machine class becomes active

Specified by:

enterState in interface RemoteConnectorState

exitState

public void exitState(RemoteConnectorState nextState)

Description copied from interface: RemoteConnectorState

called when a state machine class is deactivated

Specified by:

exitState in interface RemoteConnectorState

getAuthenticationStatus

public AuthStatus getAuthenticationStatus()

Specified by:

getAuthenticationStatus in interface RemoteConnectorState

Returns:

the current authentication status as determined by the state.

canSendCommandToRemote

public boolean canSendCommandToRemote(MenuCommand command)

Description copied from interface: RemoteConnectorState

called before any command is sent in order for the state to disallow

Specified by:

canSendCommandToRemote in interface RemoteConnectorState

Parameters:

command - the command to check

Returns:

true to send, false to suppress.

runLoop

public void runLoop()
             throws Exception

Description copied from interface: RemoteConnectorState

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.

Specified by:

runLoop in interface RemoteConnectorState

Throws:

Exception