org.vishia.cmd

Class JZtxtcmdThread

java.lang.Object

org.vishia.cmd.JZtxtcmdThreadData

org.vishia.cmd.JZtxtcmdThread

All Implemented Interfaces:

java.lang.Runnable

public class JZtxtcmdThread
extends JZtxtcmdThreadData
implements java.lang.Runnable

This class is uses as Data base for all threads in a JZcmd execution environment. One instance is aggregated in JZtxtcmdExecuter#scriptThread. Any user created thread (in a script) creates an instance of this.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JZtxtcmdThread.MsgItem Item inside the message queues.

Field Summary

Fields

Modifier and Type	Field and Description
private MessageQueue<JZtxtcmdThread.MsgItem>	cmd1 A queue for input and a queue for output data.
private JZtxtcmdExecuter.ExecuteLevel	executeLevel Used only for starting the thread.
private MessageQueue<JZtxtcmdThread.MsgItem>	msg1 A queue for input and a queue for output data.
(package private) char	state State of thread execution. i-init, r-run, y-finished.
private JZtxtcmdScript.ThreadBlock	statement Used only for starting the thread.
static java.lang.String	sVersion Version, history and license.

Fields inherited from class org.vishia.cmd.JZtxtcmdThreadData

error, excColumn, exception, excLine, excSrcfile, excStatement, version

Constructor Summary

Constructors

Constructor and Description
JZtxtcmdThread()

Method Summary

Modifier and Type	Method and Description
JZtxtcmdThread.MsgItem	awaitcmd(int timeout) Waits for a command which can be sent by another thread using sendcmd(String, Object)
java.lang.Object	awaitmsg(int timeout)
protected void	clear()
boolean	join(int time) Waits for finishing the thread.
void	run()
void	sendcmd(java.lang.String cmd, java.lang.Object data) Sends a command from another thread to this thread.
void	sendmsg(java.lang.String cmd, java.lang.Object data)
protected void	startThread(java.lang.String name, JZtxtcmdExecuter.ExecuteLevel startLevel, JZtxtcmdScript.ThreadBlock statementArg)
char	state() State of thread execution.

Methods inherited from class java.lang.Object

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

Field Detail

sVersion

public static final java.lang.String sVersion

Version, history and license.

• 2014-04-24 Hartmut chg: sendcmd(String, Object) etc. uses 2 arguments, internally JZtxtcmdThread.MsgItem is stored.
• 2014-04-24 Hartmut created from 2 inner classes of JZtxtcmdExecuter: JZcmdThread and ThreadData. Both class are joined.

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 ist 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

executeLevel

private JZtxtcmdExecuter.ExecuteLevel executeLevel

Used only for starting the thread.

statement

private JZtxtcmdScript.ThreadBlock statement

Used only for starting the thread.

state

char state

State of thread execution. i-init, r-run, y-finished.

msg1

private MessageQueue<JZtxtcmdThread.MsgItem> msg1

A queue for input and a queue for output data. Use #sendcmd(Object) etc.

cmd1

private MessageQueue<JZtxtcmdThread.MsgItem> cmd1

A queue for input and a queue for output data. Use #sendcmd(Object) etc.

Constructor Detail

JZtxtcmdThread

public JZtxtcmdThread()

Method Detail

startThread

protected void startThread(java.lang.String name,
                           JZtxtcmdExecuter.ExecuteLevel startLevel,
                           JZtxtcmdScript.ThreadBlock statementArg)

run

public void run()

Specified by:

run in interface java.lang.Runnable

clear

protected void clear()

state

public char state()

State of thread execution.

• i: init
• r: runs
• y: finished

sendcmd

public void sendcmd(java.lang.String cmd,
                    java.lang.Object data)

Sends a command from another thread to this thread.

Parameters:

cmd - the string given command.

data - Any data.

awaitcmd

public JZtxtcmdThread.MsgItem awaitcmd(int timeout)

Waits for a command which can be sent by another thread using sendcmd(String, Object)

Parameters:

timeout - milliseconds for wait, use 0 for wait forever.

Returns:

instance with the String given command and an Object.

sendmsg

public void sendmsg(java.lang.String cmd,
                    java.lang.Object data)

awaitmsg

public java.lang.Object awaitmsg(int timeout)

join

public boolean join(int time)

Waits for finishing the thread.

Parameters:

time - timeout for waiting

Returns:

true if the thread is finished, false on timeout.