org.lsst.sal

Class SALReceivedCommand<C extends SALCommand>

java.lang.Object

org.lsst.sal.SALReceivedCommand<C>

Type Parameters:

C -

public abstract class SALReceivedCommand<C extends SALCommand>
extends Object

SALReceivedCommand is returned when accepting a command. It wraps the received command and provides methods for acknowledging receipt, and reporting completion or error status.

Author:

tonyj

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SALReceivedCommand(int cmdId, C command)

Method Summary

Modifier and Type	Method and Description
abstract void	acknowledgeCommand(Duration timeToComplete) (optionally) called by the receiver of the command to acknowledge the command was received and accepted.
int	getCmdId() Get the command id of the received command
C	getCommand() Get the actual command received,
abstract void	rejectCommand(String reason) Called by the receiver of the command to indicate that the command was rejected.
abstract void	reportComplete() Called by the receiver of the command to indicate the command has been completed successfully.
abstract void	reportError(Exception ex) Called by the receiver to indicate that the command execution failed.

Methods inherited from class java.lang.Object

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

Constructor Detail

SALReceivedCommand

protected SALReceivedCommand(int cmdId,
                             C command)

Method Detail

acknowledgeCommand

public abstract void acknowledgeCommand(Duration timeToComplete)
                                 throws SALException

(optionally) called by the receiver of the command to acknowledge the command was received and accepted.

Parameters:

timeToComplete - The estimated time for completion of the command.

Throws:

SALException - If a communication exception occurs.

reportComplete

public abstract void reportComplete()
                             throws SALException

Called by the receiver of the command to indicate the command has been completed successfully.

Throws:

SALException - If a communication exception occurs.

reportError

public abstract void reportError(Exception ex)
                          throws SALException

Called by the receiver to indicate that the command execution failed.

Parameters:

ex - The exception containing the reason for failure.

Throws:

SALException - If a communication exception occurs.

rejectCommand

public abstract void rejectCommand(String reason)
                            throws SALException

Called by the receiver of the command to indicate that the command was rejected.

Parameters:

reason - The reason for rejection.

Throws:

SALException - If a communication exception occurs.

getCmdId

public int getCmdId()

Get the command id of the received command

Returns:

The command id, a positive integer,

getCommand

public C getCommand()

Get the actual command received,

Returns:

The command