Package org.jmacs

core classes.

See:
Description

Interface Summary

IControlsGui	control panel GUI, for controlling a given device.
IControlsGui.IContext	passed to IControlGuis, allowing them to submit commands.
IDiClient	device-interface client.
IDiDriver	device-interface (DI) driver.
IDiDriver.IClient	wishes to be able to behave as client in some way.
IDiDriver.IClient.IControlOnly	wishes to be able to send commands to other DIs.
IDiDriver.IClient.IFull	wishes to be able to both subscribe and send commands.
IDiDriver.IClient.ISubscribeOnly	wishes to be able to request to receive status samples from other DIs automatically.
IDiDriver.IContext	passed to IDiDriver.IClients.
IDiDriver.IContext.IControlOnly	passed to IDiDriver.IClient.IControllers.
IDiDriver.IContext.IFull	passed to IDiDriver.IClient.IFulls.
IDiDriver.IContext.ISubscribeOnly	passed to IDiDriver.IClient.ISubscribers.
IMonitorGui	monitor window GUI, for displaying the device's status.
IMonitorGui.IContext	passed to monitor windows implementing IMonitorGui.IContextAware, allowing them to submit commands.
IMonitorGui.IContextAware	have the IMonitorGui also implement this if it is to submit commands.
IResultHandler	result handler, to be implemented by IControlsGui and IMonitorGui if any commands return a non-null result.
ISamplingDependent	for implementation by IDiDrivers dependent on status-sampling parameters.
ISpi	service-provider interface, to be implemented by the JMACS Server vendor.

Class Summary

CloneableSerializable	convenience that may be used as the base class of status classes.
DiClients	utility class, for use in device-deployment code.
IDiDriver.IContext.TimestampContainer	timestamp field will be set if instance is supplied when calling IContext.getStatus.

Exception Summary

ClientDiDroppedException	thrown by IDiDriver.IContext methods if the client DI has itself been dropped.
ClientDiException	thrown by IDiDriver.IContext methods if the intended server-DI isn't currently reachable.
DiDriverException	thrown by DI driver (IDiDriver) methods.
NoSuchServerDiException	thrown by IDiDriver.IContext methods if the intended server-DI isn't currently registered.
ServerDownException	thrown by IDiDriver.IContext methods if the JMACS server is currently down.

Package org.jmacs Description

core classes. These are of interest to both the JMACS Server implementer and the device-interface developer and deployer.

To the JMACS Server implementer, please implement ISpi.

To the device-interface developer, this may be accessed using DiClients.getSpi(). If programmatic monitoring and control is required, please use the org.jmacs.pd package instead. For an example of how to write a device interface, please visit the jmacs.org website.

To the device deployer, please also see DiClients, which describes how properties (including org.jmacs.spiClassname) and the security policy may be set.