org.yamcs.ui

Class CommandQueueControlClient

java.lang.Object

org.yamcs.ui.CommandQueueControlClient

All Implemented Interfaces:

EventListener, ConnectionListener, WebSocketClientCallback, WebSocketResponseHandler

public class CommandQueueControlClient
extends Object
implements ConnectionListener, WebSocketClientCallback, WebSocketResponseHandler

Controls yamcs command queues via Web Allows to register one CommandQueueListener per (instance, yprocessor)

Author:

nm

Constructor Summary

Constructors

Constructor and Description
CommandQueueControlClient(YamcsConnector yconnector)

Method Summary

Modifier and Type	Method and Description
void	addCommandQueueListener(CommandQueueListener cmdQueueListener)
void	connected(String url)
void	connecting(String url)
void	connectionFailed(String url, YamcsException exception)
void	disconnected()
void	log(String message)
void	onException(Web.WebSocketServerMessage.WebSocketExceptionData e)
void	onMessage(Web.WebSocketServerMessage.WebSocketSubscriptionData data)
void	rejectCommand(Commanding.CommandQueueEntry cqe) Send a message to the server to reject the command
void	releaseCommand(Commanding.CommandQueueEntry cqe, boolean rebuild) Send a message to the server to release the command
void	setQueueState(Commanding.CommandQueueInfo cqi, boolean rebuild) Send a message to the server to change the queue state.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yamcs.api.ws.WebSocketClientCallback

connected, connectionFailed, onInvalidIdentification

Methods inherited from interface org.yamcs.api.ws.WebSocketResponseHandler

onCompletion

Constructor Detail

CommandQueueControlClient

public CommandQueueControlClient(YamcsConnector yconnector)

Method Detail

addCommandQueueListener

public void addCommandQueueListener(CommandQueueListener cmdQueueListener)

connected

public void connected(String url)

Specified by:

connected in interface ConnectionListener

setQueueState

public void setQueueState(Commanding.CommandQueueInfo cqi,
                          boolean rebuild)

Send a message to the server to change the queue state. If newState=ENABLED, then changing the queue state may result in some commands being sent.

Parameters:

cqi - command queue info

rebuild - The rebuild flag indicates that the command shall be rebuild (new timestamp, new pvt checks, etc) if the queue enabling results in commands being sent TODO

releaseCommand

public void releaseCommand(Commanding.CommandQueueEntry cqe,
                           boolean rebuild)
                    throws YamcsApiException,
                           YamcsException

Send a message to the server to release the command

Parameters:

cqe - - reference to the command to be released

rebuild - - indicate that the binary shall be rebuilt (new timestamp, new pvt checks, etc)

Throws:

YamcsException

YamcsApiException

rejectCommand

public void rejectCommand(Commanding.CommandQueueEntry cqe)

Send a message to the server to reject the command

Parameters:

cqe -

connecting

public void connecting(String url)

Specified by:

connecting in interface ConnectionListener

connectionFailed

public void connectionFailed(String url,
                             YamcsException exception)

Specified by:

connectionFailed in interface ConnectionListener

disconnected

public void disconnected()

Specified by:

disconnected in interface ConnectionListener

Specified by:

disconnected in interface WebSocketClientCallback

log

public void log(String message)

Specified by:

log in interface ConnectionListener

onMessage

public void onMessage(Web.WebSocketServerMessage.WebSocketSubscriptionData data)

Specified by:

onMessage in interface WebSocketClientCallback

onException

public void onException(Web.WebSocketServerMessage.WebSocketExceptionData e)

Specified by:

onException in interface WebSocketResponseHandler