org.lsst.ccs.bus.utils

Class SynchronousCommandAgent

java.lang.Object

org.lsst.ccs.bus.utils.SynchronousCommandAgent

public class SynchronousCommandAgent
extends Object

a utility code that helps sending commands that wait for a reply.

Author:

bamade

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	CURLOG

Constructor Summary

Constructors

Constructor and Description
SynchronousCommandAgent(MessagingFactory fac)

Method Summary

Modifier and Type	Method and Description
Object	getAckForCommand(Command command, long millisTimeout)
CommandListener	getCommmandListener()
Object	invoke(Command command, long millisTimeout) execute a command synchronously on the bus.
String	invokeAsync(Command command) exceptionally one can send asynchronous commands: the replies are just traced.
Future<Object>	invokeFuture(Command command) execute a command on the bus, returning a Future to an expected reply

Methods inherited from class java.lang.Object

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

Field Detail

CURLOG

public static final Logger CURLOG

Constructor Detail

SynchronousCommandAgent

public SynchronousCommandAgent(MessagingFactory fac)

Method Detail

getCommmandListener

public CommandListener getCommmandListener()

invoke

public Object invoke(Command command,
                     long millisTimeout)
              throws Exception

execute a command synchronously on the bus. (do not do it frequently!)

Parameters:

command -

millisTimeout - timeout for waiting for command execution

Returns:

Throws:

Exception - if an exception was fired by the remote executon of the command or the timeout expired.

getAckForCommand

public Object getAckForCommand(Command command,
                               long millisTimeout)
                        throws Exception

Throws:

Exception

invokeFuture

public Future<Object> invokeFuture(Command command)

execute a command on the bus, returning a Future to an expected reply

Parameters:

command -

Returns:

a future to the reply payload

invokeAsync

public String invokeAsync(Command command)

exceptionally one can send asynchronous commands: the replies are just traced.

Parameters:

command -

Returns:

the correlationId of the command