stella

Interface CommandLaunching

All Superinterfaces:

PropertySupplying, ReplyDeliverer

All Known Subinterfaces:

OffsetCaster

All Known Implementing Classes:

AbstractCommandLauncher, AdapterCaster, AdapterTelescopeCaster, AuxiliaryCaster, CalibrationCaster, CasterClient, CasterTorso, CCDCaster, DistinctCaster, EnvironmentCaster, GregorTelescopeCaster, MasterLauncher, PilarLauncher, PilarTelescopeCaster, SpectrographCaster, TelescopeCaster, TelescopeClient, TelescopeSubsidiaryCaster, TestCaster, TestCaster, WifsipCaster, WifsipTelescopeCaster

public interface CommandLaunching
extends ReplyDeliverer, PropertySupplying

This interface defines command-casting abilities. Classes that implement this interface are able to send command to a command server. The way they do it (either RMI or socket based) is not specified in this interface. Sub-interface may break this generality to e.g. provide a point-to-point protocol (event casting is not single-connection based).

This interface should act as a common functionality for describing command servers.

Sequencers (Sequencing) rely on this interface. They need ReplyDeliverer properties to get essential acknolwedge and done messages forwarded and ErrorCaster properties to receive incoming errors to alter the task flow if necessary. PropertySupplying is a generic interface for all objects in MasterMind.

Field Summary

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Method Summary

Modifier and Type	Method and Description
void	castCommand(CommandEvent ce) The interface to the command casting routine.
String	getClientName() Returns the name of this command launcher.
CommandEvent	getExitCommand() Returns the command that should be sent on a server exit.
CommandEvent	getShutdownCommand() Returns the command that initiates a shutdown on the device or prepares it for a shutdown.
boolean	handles(CommandEvent ce) Returns true if the caster can handles this command event.
boolean	isReady() Returns true if the device is ready to receive commands.
void	recastCommand() Resends the last command, stops acknowledge/done waits.

Methods inherited from interface stella.ReplyDeliverer

announceInterest, registerReplySubscriber

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Method Detail

castCommand

void castCommand(CommandEvent ce)

The interface to the command casting routine.

recastCommand

void recastCommand()

Resends the last command, stops acknowledge/done waits.

handles

boolean handles(CommandEvent ce)

Returns true if the caster can handles this command event.

isReady

boolean isReady()

Returns true if the device is ready to receive commands.

getClientName

String getClientName()

Returns the name of this command launcher.

getShutdownCommand

CommandEvent getShutdownCommand()

Returns the command that initiates a shutdown on the device or prepares it for a shutdown.

getExitCommand

CommandEvent getExitCommand()

Returns the command that should be sent on a server exit. If the master mind dies (its VM exits), one of the last things it should do is send this command to the servers, if they request these.