org.lsst.ccs.subsystem.common.ui.jas

Class CommandSender

java.lang.Object

org.lsst.ccs.subsystem.common.ui.jas.CommandSender

public class CommandSender
extends Object

Class for sending a command and receiving the response.

Author:

saxton

Constructor Summary

Constructors

Constructor and Description
CommandSender(String dest) Constructor

Method Summary

Modifier and Type	Method and Description
Object	sendCommand(int timeout, String path, String cmnd, Object... args) Sends a command and receives the response.
Object	sendCommand(String path, String cmnd, Object... args) Sends a command and receives the response.
Object	sendCommandRaw(int timeout, String path, String cmnd, Object... args) Sends a command and receives the response.
Object	sendCommandRaw(String path, String cmnd, Object... args) Sends a command and receives the response.
void	setTimeout(int timeout) Sets the default timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandSender

public CommandSender(String dest)

Constructor

Parameters:

dest - The name of the destination subsystem for the commands

Method Detail

sendCommand

public Object sendCommand(String path,
                          String cmnd,
                          Object... args)

Sends a command and receives the response. The default timeout is used

Parameters:

path - The path within the destination to receive the command, or null if the top level

cmnd - The command to execute

args - The command arguments

Returns:

The command response

sendCommand

public Object sendCommand(int timeout,
                          String path,
                          String cmnd,
                          Object... args)

Sends a command and receives the response.

Parameters:

timeout - The command timeout (ms)

path - The path within the destination to receive the command, or null if the top level

cmnd - The command to execute

args - The command arguments

Returns:

The command response

sendCommandRaw

public Object sendCommandRaw(String path,
                             String cmnd,
                             Object... args)
                      throws Exception

Sends a command and receives the response. The default timeout is used

Parameters:

path - The path within the destination to receive the command, or null if the top level

cmnd - The command to execute

args - The command arguments

Returns:

The command response

Throws:

Exception

sendCommandRaw

public Object sendCommandRaw(int timeout,
                             String path,
                             String cmnd,
                             Object... args)
                      throws Exception

Sends a command and receives the response.

Parameters:

timeout - The command timeout (ms)

path - The path within the destination to receive the command, or null if the top level

cmnd - The command to execute

args - The command arguments

Returns:

The command response

Throws:

Exception

setTimeout

public void setTimeout(int timeout)

Sets the default timeout.

Parameters:

timeout - The default timeout (ms). If zero, the command waits forever. If positive, the maximum of this value and the ACK custom timeout is used. If negative, its absolute value is used. The initial value is 5000.