eu.hgross.blaubot.core.statemachine.states

Interface IBlaubotState

All Known Implementing Classes:

FreeState, KingState, PeasantState, PrinceState, StoppedState

public interface IBlaubotState

A state representing one state of the ConnectionStateMachine. A state may do it's setup in the handleState() method and wait for events received from it's on...() methods. These methods are partly equivalent to the IBlaubotConnectionManagerListener and IBlaubotDiscoveryEventListener methods. After each call of one of the on...() methods, a IBlaubotState has to be returned. If the ConnectionStateMachine should stay in the current state (this), simply return this - the state will not be dismissed then. If a state is dismissed by the ConnectionStateMachine, the onDismiss() method will be called to allow a state to clean up.

Method Summary

Modifier and Type	Method and Description
void	handleState(StateMachineSession stateMachineSession) Gets called if this state was set as currentState by the ConnectionStateMachine.
IBlaubotState	onAdminMessage(AbstractAdminMessage adminMessage) Gets called when an AbstractAdminMessage was received.
IBlaubotState	onConnectionClosed(IBlaubotConnection connection) Gets called if a previously established connection from a remote IBlaubotDevice was closed due to an exception or intentionally.
IBlaubotState	onConnectionEstablished(IBlaubotConnection connection) Gets called if a new connection from a remote IBlaubotDevice was established.
IBlaubotState	onDeviceDiscoveryEvent(AbstractBlaubotDeviceDiscoveryEvent discoveryEvent) Gets called if a IBlaubotBeacon discovered a IBlaubotDevice.
IBlaubotState	onTimeoutEvent(AbstractTimeoutStateMachineEvent timeoutEvent) This is a helper for Timeout-Events needed for some IBlaubotStates.

Method Detail

handleState

void handleState(StateMachineSession stateMachineSession)

Gets called if this state was set as currentState by the ConnectionStateMachine.

Parameters:

stateMachineSession - a session object with access to the relevant Blaubot components.

onAdminMessage

IBlaubotState onAdminMessage(AbstractAdminMessage adminMessage)

Gets called when an AbstractAdminMessage was received.

Parameters:

adminMessage - the received admin message

Returns:

the next state based on this event, could be a new state or the identity

onDeviceDiscoveryEvent

IBlaubotState onDeviceDiscoveryEvent(AbstractBlaubotDeviceDiscoveryEvent discoveryEvent)

Gets called if a IBlaubotBeacon discovered a IBlaubotDevice. Note: For each discoverable IBlaubotState a corresponding AbstractBlaubotDeviceDiscoveryEvent subclass can be found in the de.hsrm.blaubot.statemachine.events package.

Parameters:

discoveryEvent - the discovery event.

Returns:

the next state based on this event, could be a new state or the identity

onConnectionEstablished

IBlaubotState onConnectionEstablished(IBlaubotConnection connection)

Gets called if a new connection from a remote IBlaubotDevice was established.

Parameters:

connection - the established connection

Returns:

the next state based on this event, could be a new state or the identity

onConnectionClosed

IBlaubotState onConnectionClosed(IBlaubotConnection connection)

Gets called if a previously established connection from a remote IBlaubotDevice was closed due to an exception or intentionally.

Parameters:

connection - the closed connection

Returns:

the next state based on this event, could be a new state or the identity

onTimeoutEvent

IBlaubotState onTimeoutEvent(AbstractTimeoutStateMachineEvent timeoutEvent)

This is a helper for Timeout-Events needed for some IBlaubotStates. A IBlaubotState can subclass the AbstractTimeoutStateMachineEvent and push it to the ConnectionStateMachine. A timeout event contains the state that issued the timeout so a IBlaubotState can check if the timeout event belongs to himself or ignore it when this is not the case.

Parameters:

timeoutEvent - the occured event

Returns:

the next state based on this event, could be a new state or the identity