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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CommandSender.CommandHandler
static interface	CommandSender.ReplyHandler

Constructor Summary

Constructors

Constructor and Description
CommandSender(String dest) Constructor
CommandSender(String dest, CommandSender.ReplyHandler handler) Constructor

Method Summary

Modifier and Type	Method and Description
void	addHandler(CommandSender.ReplyHandler handler) Adds a reply handler
void	removeHandler(CommandSender.ReplyHandler handler) Removes a reply handler
void	sendCommand(boolean reply, int timeout, String path, String cmnd, Object... args) Sends a command.
void	sendCommand(boolean reply, String path, String cmnd, Object... args) Sends a command.
void	sendCommand(int timeout, String path, String cmnd, Object... args) Sends a command without expecting a reply.
void	sendCommand(String path, String cmnd, Object... args) Sends a command without expecting a reply.
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

CommandSender

public CommandSender(String dest,
                     CommandSender.ReplyHandler handler)

Constructor

Parameters:

dest - The name of the destination subsystem for the commands

handler - The handler for command replies

Method Detail

sendCommand

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

Sends a command without expecting a reply. 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

sendCommand

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

Sends a command without expecting a reply.

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

sendCommand

public void sendCommand(boolean reply,
                        String path,
                        String cmnd,
                        Object... args)

Sends a command. The default timeout is used

Parameters:

reply - Whether to handle the command reply

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

sendCommand

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

Sends a command.

Parameters:

reply - Whether to handle the command reply

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

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.

addHandler

public void addHandler(CommandSender.ReplyHandler handler)

Adds a reply handler

Parameters:

handler - The handler to add

removeHandler

public void removeHandler(CommandSender.ReplyHandler handler)

Removes a reply handler

Parameters:

handler - The handler to remove