org.jlab.coda.cMsg.remoteExec

Class CommandReturn

java.lang.Object

org.jlab.coda.cMsg.remoteExec.CommandReturn

public class CommandReturn
extends java.lang.Object

An object of this class is returned by calls to the Commander.startProcess(org.jlab.coda.cMsg.remoteExec.ExecutorInfo, java.lang.String, boolean, org.jlab.coda.cMsg.remoteExec.CommandCallback, java.lang.Object) or Commander.startThread(org.jlab.coda.cMsg.remoteExec.ExecutorInfo, java.lang.String, org.jlab.coda.cMsg.remoteExec.CommandCallback, java.lang.Object, org.jlab.coda.cMsg.remoteExec.ConstructorInfo) methods and is used to track the process of command given to an Executor.

Author:

timmer Date: Oct 14, 2010

Constructor Summary

Constructors

Constructor and Description
CommandReturn(Commander commander, ExecutorInfo executor, CallbackState callbackState) Constructor.
CommandReturn(Commander commander, ExecutorInfo executor, int id, int processId, boolean error, boolean terminated, java.lang.String regularOutput, java.lang.String errorOutput) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	callbackCancelled() Has the callback been cancelled for any reason?
void	executeCallback() Run the registered callback.
CallbackState	getCallbackState() Get the state of the callback.
java.lang.String	getError() Get error output (if any) generated by the started process or thread.
(package private) int	getExecutorId() Get the Executor generated id number.
int	getId() Get the Commander generated id number.
java.lang.String	getOutput() Get output (if any) generated by the started process or thread.
boolean	hasError() Get whether error occurred in the attempt to run the process or thread.
boolean	hasOutput() Get whether the process has any output.
boolean	hasTerminated() Get whether the process has already terminated.
(package private) void	hasTerminated(boolean b) Set whether the process has already terminated.
boolean	isLocked() Is this object locked from further updates?
(package private) void	lock() Lock this object from further updates.
void	registerCallback(CommandCallback processCallback, java.lang.Object userObject) Register a callback to be run when the process ends.
(package private) void	setCallbackState(CallbackState callbackState) Set the state of the callback, but not when locked.
(package private) void	setCallbackStateIfLocked(CallbackState callbackState) Set the state of the callback even if locked.
(package private) void	setError(java.lang.String error) Set error output generated by the started process or thread.
(package private) void	setOutput(java.lang.String output) Set output generated by the started process or thread.
void	setValues(int id, int processId, boolean error, boolean terminated, java.lang.String regularOutput, java.lang.String errorOutput) Set various member values, but not when locked.
void	stop() Stop the process or thread on the executor this object is associated with.
java.lang.String	toString()
void	unregisterCallback() Unregister a callback so it does not get run.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandReturn

CommandReturn(Commander commander,
              ExecutorInfo executor,
              CallbackState callbackState)

Constructor.

Parameters:

commander - Commander object which is calling this method.

executor - ExecutorInfo object the Commander is talking to.

callbackState - state of the callback

CommandReturn

CommandReturn(Commander commander,
              ExecutorInfo executor,
              int id,
              int processId,
              boolean error,
              boolean terminated,
              java.lang.String regularOutput,
              java.lang.String errorOutput)

Constructor.

Parameters:

commander - Commander object which is calling this method.

executor - ExecutorInfo object the Commander is talking to.

id - id number generated by Commander.

processId - associated id number generated by Executor.

error - was there an error running the process/thread?

terminated - has process terminated already?

regularOutput - regular output (if any) of the started process

errorOutput - error output (if any) of the started process

Method Detail

setValues

public void setValues(int id,
                      int processId,
                      boolean error,
                      boolean terminated,
                      java.lang.String regularOutput,
                      java.lang.String errorOutput)

Set various member values, but not when locked.

Parameters:

id - id number generated by Commander.

processId - associated id number generated by Executor.

error - was there an error running the process/thread?

terminated - has process terminated already?

regularOutput - regular output (if any) of the started process

errorOutput - error output (if any) of the started process

stop

public void stop()

Stop the process or thread on the executor this object is associated with.

isLocked

public boolean isLocked()

Is this object locked from further updates?

Returns:

true if locked, else false

lock

void lock()

Lock this object from further updates.

registerCallback

public void registerCallback(CommandCallback processCallback,
                             java.lang.Object userObject)

Register a callback to be run when the process ends. Calling this multiple times results in a replacement of the callback.

Parameters:

processCallback - callback to be run when the process ends.

userObject - argument to be passed to callback.

unregisterCallback

public void unregisterCallback()

Unregister a callback so it does not get run.

executeCallback

public void executeCallback()

Run the registered callback.

callbackCancelled

public boolean callbackCancelled()

Has the callback been cancelled for any reason?

Returns:

true if callback has already been cancelled, else false.

getCallbackState

public CallbackState getCallbackState()

Get the state of the callback.

Returns:

the state of the callback.

setCallbackState

void setCallbackState(CallbackState callbackState)

Set the state of the callback, but not when locked.

Parameters:

callbackState - state of the callback.

setCallbackStateIfLocked

void setCallbackStateIfLocked(CallbackState callbackState)

Set the state of the callback even if locked.

Parameters:

callbackState - state of the callback.

getExecutorId

int getExecutorId()

Get the Executor generated id number.

Returns:

the Executor generated id number.

getId

public int getId()

Get the Commander generated id number.

Returns:

the Commander generated id number.

hasTerminated

void hasTerminated(boolean b)

Set whether the process has already terminated.

Parameters:

b - true if process has terminated, else false.

hasTerminated

public boolean hasTerminated()

Get whether the process has already terminated.

Returns:

true if process has already terminated, else false.

hasError

public boolean hasError()

Get whether error occurred in the attempt to run the process or thread.

Returns:

true if error occurred attempting to run process/thread, else false.

hasOutput

public boolean hasOutput()

Get whether the process has any output.

Returns:

true if the process has output, else false.

getOutput

public java.lang.String getOutput()

Get output (if any) generated by the started process or thread.

Returns:

any output by the process or thread, or null if none

getError

public java.lang.String getError()

Get error output (if any) generated by the started process or thread.

Returns:

any error output by the process or thread, or null if none

setError

void setError(java.lang.String error)

Set error output generated by the started process or thread.

Parameters:

error - error output by the process or thread.

setOutput

void setOutput(java.lang.String output)

Set output generated by the started process or thread.

Parameters:

output - output by the process or thread.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object