stella.rmi

Interface RemoteSwitch

All Superinterfaces:

Remote, RemoteParameter, RemoteTrigger, RmiCaster

All Known Subinterfaces:

RemoteLight

All Known Implementing Classes:

AbstractRemoteSwitch, SwitchRelay, SwitchSkeleton, SwitchSsh

public interface RemoteSwitch
extends RemoteTrigger

The interface defining remote control of lighting control. Methods are defined to switch the light on and off as well as a time-out controlled light-on.

Field Summary

Fields inherited from interface globals.rmi.RemoteTrigger

NAMING_EXTENSION

Method Summary

Modifier and Type	Method and Description
boolean	switchOff() Switches off.
boolean	switchOn(long ms) Switches on.

Methods inherited from interface globals.rmi.RemoteTrigger

remoteGetTrigger, remoteIsTrue, remoteToggleTime

Methods inherited from interface globals.rmi.RemoteParameter

addRmiListener, remoteGet, removeRmiListener

Methods inherited from interface util.rmi.RmiCaster

bindToRegistry, isValid, unbindFromRegistry

Method Detail

switchOn

boolean switchOn(long ms)
          throws RemoteException

Switches on. The switch remains on until the switchOff() method is called or the time out given expires.

Parameters:

ms - The maximum illumination time, in ms. Zero for unlimitied.

Returns:

True, if turning on of the switch was successful.

Throws:

RemoteException

switchOff

boolean switchOff()
           throws RemoteException

Switches off.

Returns:

True, if turning off of the light was successful.

Throws:

RemoteException