net.sourceforge.anotherfsm

Class TimeoutStateMachine

java.lang.Object

net.sourceforge.anotherfsm.DeterministicStateMachine

net.sourceforge.anotherfsm.SynchronizedStateMachine

net.sourceforge.anotherfsm.TimeoutStateMachine

All Implemented Interfaces:

java.lang.AutoCloseable, Processor, StateMachine

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()

Field Summary

Fields

Modifier and Type	Field and Description
protected FsmLogger	logger The 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.
java.lang.String	getName() Get the name of the processor.
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, setStartState, toString

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

logger

protected final FsmLogger logger

The logger.

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

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()

getName

public java.lang.String getName()

Description copied from interface: Processor

Get the name of the processor.

Specified by:

getName in interface Processor

Returns:

the name