net.sourceforge.anotherfsm

Class TimeoutStateMachine

java.lang.Object

net.sourceforge.anotherfsm.ProcessorAdapter

net.sourceforge.anotherfsm.DeterministicStateMachine

net.sourceforge.anotherfsm.SynchronizedStateMachine

net.sourceforge.anotherfsm.TimeoutStateMachine

All Implemented Interfaces:

java.lang.AutoCloseable, Processor, StateMachine

Direct Known Subclasses:

TimeoutConnectionFsm

public class TimeoutStateMachine
extends SynchronizedStateMachine

Deterministic state machine with timeouts for states. The object is thread safe and can be used in multithreaded environment. Building of the object is NOT synchronized and should be done just in one thread. Only the processing of the events is synchronized. Note this object executes an additional thread for a timer and generating of timeout events. Code of callbacks/listeners for timeout events is executed under this thread.

Author:

Michal Turek

See Also:

TimeoutEvent, start(), close()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	TimeoutStateMachine.TimeoutTask The timeout task for scheduling the timeout transitions.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	daemon The inner thread used for timer is a daemon thread.
private java.lang.Object	lastStateEnterId The unique ID of the last state enter to forbid timeout in incorrect state.
private java.lang.Object	lastStateEnterIdNonLoop The unique ID of the last state enter to forbid timeout in incorrect state.
private java.util.Timer	timer The timer for scheduling timeout transitions.

Fields inherited from class net.sourceforge.anotherfsm.ProcessorAdapter

logger

Fields inherited from interface net.sourceforge.anotherfsm.StateMachine

INITIAL_STATE_NAME

Constructor Summary

Constructors

Constructor and Description
TimeoutStateMachine(java.lang.String name) Create the state machine.
TimeoutStateMachine(java.lang.String name, boolean daemon) Create the state machine.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Finish processing of the events and free all allocated resources.
(package private) java.lang.String	getThreadName() Helper method to get the name of the internally executed thread.
(package private) void	notifyEnter(State previous, Event event, State current) Process all state enter callbacks.
private void	proccessTimeoutTransition(Transition timeoutTransition, java.lang.Object stateEnterId, java.lang.Object stateEnterIdNonLoop) Process the timeout transition.
private void	scheduleTimeoutTransition(boolean loopTransition, TimeoutEvent event) Schedule a new timeout transition, a state was entered.
void	start() Building of the processor is finished, prepare it to the events processing.

Methods inherited from class net.sourceforge.anotherfsm.SynchronizedStateMachine

getActiveState, getActiveStates, isInFinalState, process

Methods inherited from class net.sourceforge.anotherfsm.DeterministicStateMachine

addListener, addListener, addPreprocessor, addState, addTransition, easterEgg, getStates, getTransition, getTransitions, notifyExit, notifyTransition, setStartState, toString

Methods inherited from class net.sourceforge.anotherfsm.ProcessorAdapter

getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.anotherfsm.Processor

getName

Field Detail

timer

private java.util.Timer timer

The timer for scheduling timeout transitions.

daemon

private final boolean daemon

The inner thread used for timer is a daemon thread.

lastStateEnterId

private java.lang.Object lastStateEnterId

The unique ID of the last state enter to forbid timeout in incorrect state. Instance of any object is enough since every two objects are different. Updated during all state enters.

lastStateEnterIdNonLoop

private java.lang.Object lastStateEnterIdNonLoop

The unique ID of the last state enter to forbid timeout in incorrect state. Instance of any object is enough since every two objects are different. Updated only during non-loop state enters.

Constructor Detail

TimeoutStateMachine

public TimeoutStateMachine(java.lang.String name)

Create the state machine. The inner thread used for timer will NOT be a daemon.

Parameters:

name - the name of the state machine

TimeoutStateMachine

public TimeoutStateMachine(java.lang.String name,
                   boolean daemon)

Create the state machine.

Parameters:

name - the name of the state machine

daemon - the inner thread used for timer is a daemon thread

See Also:

Thread

Method Detail

getThreadName

java.lang.String getThreadName()

Helper method to get the name of the internally executed thread.

Returns:

the thread name

start

public void start()
           throws FsmException

Description copied from interface: Processor

Building of the processor is finished, prepare it to the events processing. It is expected this method is called just once.

Specified by:

start in interface Processor

Specified by:

start in interface StateMachine

Overrides:

start in class DeterministicStateMachine

Throws:

FsmException - if something fails

See Also:

Processor.close()

close

public void close()

Description copied from interface: Processor

Finish processing of the events and free all allocated resources. This method can be called multiple times. Calling methods of the object after its Processor.close() should be avoided. The behavior is not defined and may cause unpredictable behavior, e.g. NullPointerException.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface Processor

Specified by:

close in interface StateMachine

Overrides:

close in class DeterministicStateMachine

See Also:

Processor.start()

notifyEnter

void notifyEnter(State previous,
               Event event,
               State current)
           throws FsmException

Description copied from class: DeterministicStateMachine

Process all state enter callbacks.

Overrides:

notifyEnter in class DeterministicStateMachine

Parameters:

previous - the previous state

event - the event

current - the current state

Throws:

FsmException - if something fails

scheduleTimeoutTransition

private void scheduleTimeoutTransition(boolean loopTransition,
                             TimeoutEvent event)

Schedule a new timeout transition, a state was entered.

Parameters:

loopTransition - the transition was loop transition

event - the timeout event

proccessTimeoutTransition

private void proccessTimeoutTransition(Transition timeoutTransition,
                             java.lang.Object stateEnterId,
                             java.lang.Object stateEnterIdNonLoop)

Process the timeout transition.

Parameters:

timeoutTransition - the transition with TimeoutEvent that should be processed

stateEnterId - the unique ID of the state enter

stateEnterIdNonLoop - the unique ID of the non-loop state enter