org.vishia.util

Class ThreadRun

java.lang.Object

org.vishia.util.ThreadRun

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class ThreadRun
extends java.lang.Object
implements java.io.Closeable

This class builds a Thread which runs a routine in a cycle. The intension for an extra class is: On debugging, if a source is changed while running a program, it can reloaded normally for example on eclipse working. But sometimes that is only possible if the CPU does not run in the byteCode of that source. If the thread's loop is part of that source, the class may not able to reload and the debugging is 'out of sync' with the sources. This extra class enables the change of the working class because the CPU is on waiting in this class usual, respectively a thread can hold here by setting a breakpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ThreadRun.Step

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	bIsNotified
private boolean	bThreadWaits
protected int	ctTimeoverflow
private int	cycletime
private java.lang.String	name
private int	nextCycle
private java.lang.Runnable	run
private boolean	runThread If this variable is true, the thread runs.
private ThreadRun.Step	step The step routine.
protected int	stepTimeMeasure
protected float	stepTimeMeasureMid
protected boolean	stopThread Helper variable to stop one or more threads without changing the source.
private java.lang.Thread	thread
static int	version Version, history and license.
private int	waitMillisec The cyclically wait.

Constructor Summary

Constructors

Constructor and Description
ThreadRun(java.lang.String name, ThreadRun.Step step, int cycletime)

Method Summary

Modifier and Type	Method and Description
void	close() Closes this thread.
void	forceStep(boolean forceNextStep) Force the execution of step of this thread invoked from another thread.
protected void	run() The threads run routine.
void	start()

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final int version

Version, history and license.

• 2016-01-23 Hartmut chg: If the wait time was set faulty with a large value, it waits for a long time and blocks. Therefore the maximal wait time is set to 2 seconds. Typically this class should be used for millisecond-handlings. It may okay for all usages?
• 2014-09-21 Hartmut TODO some variables to class for inspect-ability. Separate const and volatile variables.
• 2013-12-11 Hartmut: Created

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

thread

private final java.lang.Thread thread

name

private final java.lang.String name

stopThread

protected boolean stopThread

Helper variable to stop one or more threads without changing the source.

runThread

private boolean runThread

If this variable is true, the thread runs. Set false on close();

bThreadWaits

private boolean bThreadWaits

bIsNotified

private boolean bIsNotified

waitMillisec

private int waitMillisec

The cyclically wait.

ctTimeoverflow

protected int ctTimeoverflow

stepTimeMeasure

protected int stepTimeMeasure

stepTimeMeasureMid

protected float stepTimeMeasureMid

cycletime

private final int cycletime

nextCycle

private int nextCycle

step

private final ThreadRun.Step step

The step routine.

run

private final java.lang.Runnable run

Constructor Detail

ThreadRun

public ThreadRun(java.lang.String name,
                 ThreadRun.Step step,
                 int cycletime)

Method Detail

start

public void start()

forceStep

public void forceStep(boolean forceNextStep)

Force the execution of step of this thread invoked from another thread. If this routine is invoked from the own thread (in its step.run()-Routine), then the next wait() is skipped, the step() routine is invoked without wait for the next time.

Parameters:

forceNextStep - if it is in its step-routine, it does not wait after the current step but starts the next step immediately. If it is in its wait cycle, this value effects nothing.

close

public void close()

Closes this thread. It will end if the step-routine will finished or if the thread waits yet. If the thread waits it will be waken up to finish. If the step routine hangs or has its own timing, waits of anything other etc. the close action is delayed. Not that a step routine should not hang in a proper application.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

See Also:

Closeable.close()

run

protected void run()

The threads run routine.

See Also:

Runnable.run()