|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
public interface Node
Interface to an ISI Node, which hosts devices.
| Field Summary | |
|---|---|
static java.lang.String |
SERVER_NAME
Server name |
| Method Summary | |
|---|---|
void |
addEventCallback(NodeEventCallback callback)
Register to receive notification of node events. |
byte[] |
addSchedule(byte[] port,
byte[] scheduleName,
byte[] schedule,
boolean overwrite)
Add Schedule |
void |
annotate(byte[] annotation)
Append annotation to node's data stream. |
void |
cpuLease(int requestorID,
long when,
long howLong)
Request that the CPU come on at a certain time in the future and/or remain on for a certain duration. |
void |
enterSafeMode()
Put node and its devices into "safe" mode. |
void |
enterSafeMode(long timeoutSec)
|
int |
establishLease(long leaseMillisec,
byte[] clientNote)
Request a lease of the Node's primary comms medium |
int |
establishLease(long leaseMillisec,
byte[] clientNote,
boolean usePrimary)
Request a lease of either the primary or auxillary comms medium. |
void |
exitApplication()
Shutdown all services and exits the SIAM application. |
void |
exitApplication(boolean doSafemode,
boolean doHalt,
boolean enableBackups,
boolean doNotify,
boolean recursive,
int quitDelaySec,
int haltDelaySec,
java.lang.String msg)
Shutdown all services and exits the SIAM application. |
Device |
getDevice(byte[] commPortName)
Get device service (if any) associated with specified port. |
Device |
getDevice(long deviceId)
Get specified device service proxy. |
DevicePacketSet |
getDevicePackets(long sensorID,
long startTime,
long endTime)
Get DevicePacket objects, from specified sensor, within specified time window. |
DevicePacketSet |
getDevicePackets(long sensorID,
long startTime,
long endTime,
int typeMask)
Get DevicePacket objects, from specified sensor, within specified time window; only return packets of type specified in typemask parameter. |
DevicePacketSet |
getDevicePackets(long sensorId,
long startTime,
long endTime,
int numBytes,
int timeout)
Get DevicePacket objects, from specified sensor, within specified time window. |
DevicePacketSet |
getDevicePackets(long sensorId,
long startTime,
long endTime,
int numBytes,
int typeMask,
int timeout)
Get DevicePacket objects, from specified sensor, within specified time window. |
Device[] |
getDevices()
Get all device service proxies. |
long |
getId()
Unique identifier for Node instance |
LeaseDescription[] |
getLeases(boolean usePrimary)
Get list of all active leases managed by the node. |
Location |
getLocation()
Return Location of Node. |
byte[] |
getMetadata()
Get Node metadata. |
byte[] |
getName()
Name of Node service class. |
NodeInfo |
getNodeInfo()
Get basic information about node and its subnodes |
PortConfiguration[] |
getPortConfiguration()
Get configuration of Node ports. |
Port[] |
getPorts()
Get array of Node's Port objects. |
PowerSwitch[] |
getPowerSwitches()
Get array of Node's power switches. |
java.util.Vector |
getProperties()
Get Vector of node properties; each Vector element consists of byte array with form "key=value". |
RemoteSerialPort |
getRemoteSerialPort(byte[] portName)
Get remote serial port. |
RemoteSerialPort |
getRemoteSerialPort(byte[] portName,
int timeout)
Get remote serial port with specified timeout in milliseconds. |
byte[] |
getSchedule()
Get Printable Schedule (use default lookahead) |
byte[] |
getSchedule(byte[] port,
long lookAheadSeconds)
Get Printable Schedule for a specified device, lookahead |
byte[] |
getSchedule(long lookAheadSeconds)
Get Printable Schedule, specify lookahead |
byte[] |
getStatus(boolean logPacket)
Return byte string with node health/status information. |
Subnode[] |
getSubnodeObjects()
Get list of immediate subnode objects. |
java.net.InetAddress[] |
getSubnodes()
Get list of immediate subnode IP addresses. |
java.net.InetAddress |
host()
Return InetAddress of device service host. |
void |
initialize()
Initialize the device. |
byte[] |
instrumentRegistryStatus()
Get InstrumentRegistry status |
Instrument |
lookupService(java.lang.String registryName)
Find an Instrument in the InstrumentRegistry by registryName |
void |
powerDownPort(byte[] commPortName)
Power down specified port and enable the comms if a service is not already using it |
int |
powerOff()
Turn Node power off. |
void |
powerUpPort(byte[] commPortName,
int currentLimit)
Power up specified port and enable the comms if a service is not already using it |
void |
readLog4jConfig()
Reload log4j configuration |
byte[] |
removeSchedule(byte[] port,
byte[] scheduleName)
Remove Schedule |
void |
removeSubnode(java.net.InetAddress address)
Remove specified subnode from list. |
void |
renewLease(int leaseID,
long leaseMillisec)
Renew a lease with the Node's primary comms medium |
void |
renewLease(int leaseID,
long leaseMillisec,
boolean userPrimary)
Renew a lease with the Node's primary or secondary comms medium |
void |
restartService(byte[] portName)
Resume service (if any) associated with specified port. |
void |
resumeNormalMode()
Return from "safe" mode; resume normal operations. |
byte[] |
resumeSchedule(byte[] port,
byte[] scheduleName)
Resume Schedule Entry |
void |
resumeService(byte[] portName)
Resume service (if any) associated with specified port. |
byte[] |
runCommand(byte[] cmd,
int timeoutSec)
Tell node to execute a Linux command. |
void |
scanPort(byte[] commPortName)
Load service for specified port. |
void |
scanPort(byte[] commPortName,
byte[] serviceSource)
Scan specified port, load service, optionally specifying source of the service. |
void |
scanPorts()
Scan all ports, load services. |
void |
setProperties(byte[] propertyStrings)
Set value of specified node service properties. |
void |
shoreLinkDownCallback(java.lang.String interfaceName,
java.lang.String serialName,
java.net.InetAddress localAddress,
java.net.InetAddress remoteAddress)
Called when IP link to shore is disconnected |
void |
shoreLinkUpCallback(java.lang.String interfaceName,
java.lang.String serialName,
java.net.InetAddress localAddress,
java.net.InetAddress remoteAddress)
Called when IP link to shore is connected |
byte[] |
shutdownDeviceService(byte[] commPortName)
Shutdown and remove device service from specified port. |
NodeSessionInfo |
startSession(boolean renewWDT,
byte[] initScript,
int initScriptTimeoutSec)
Prepare node for telemetry retrieval over low-bandwidth link; combines several operations into one RMI method invocation. |
boolean |
summarizing(long deviceID)
Return true if specified device can supply Summary packets. |
byte[] |
suspendSchedule(byte[] port,
byte[] scheduleName)
Suspend Schedule Entry |
void |
suspendService(byte[] portName)
Suspend service (if any) associated with specified port. |
byte[] |
syncSchedule(byte[] port,
byte[] scheduleName,
long delayMillis)
Synchronize a (default sample) schedule entry |
void |
terminateLease(int leaseID)
Terminate the session with the communications link. |
void |
terminateLease(int leaseID,
boolean usePrimary)
Terminate the session with the priamry or auxillary communications link. |
int |
terminateLeases(byte[] noteMatch)
Terminate all leases with notations that match the specified note. |
int |
test()
Run Node's self-test routine. |
| Methods inherited from interface org.mbari.siam.distributed.RemoteService |
|---|
ping |
| Field Detail |
|---|
static final java.lang.String SERVER_NAME
| Method Detail |
|---|
java.net.InetAddress host()
throws java.rmi.RemoteException,
java.net.UnknownHostException
java.rmi.RemoteException
java.net.UnknownHostException
byte[] getName()
throws java.rmi.RemoteException
java.rmi.RemoteException
long getId()
throws java.rmi.RemoteException
java.rmi.RemoteException
void initialize()
throws java.rmi.RemoteException,
InitializeException
java.rmi.RemoteException
InitializeException
int powerOff()
throws java.rmi.RemoteException
java.rmi.RemoteException
PortConfiguration[] getPortConfiguration()
throws java.rmi.RemoteException
java.rmi.RemoteException
Device getDevice(long deviceId)
throws java.rmi.RemoteException,
DeviceNotFound
java.rmi.RemoteException
DeviceNotFound
Device[] getDevices()
throws java.rmi.RemoteException
java.rmi.RemoteException
byte[] shutdownDeviceService(byte[] commPortName)
throws java.rmi.RemoteException,
PortNotFound,
DeviceNotFound
java.rmi.RemoteException
PortNotFound
DeviceNotFound
void scanPorts()
throws java.rmi.RemoteException
java.rmi.RemoteException
void scanPort(byte[] commPortName)
throws java.rmi.RemoteException,
PortNotFound,
DeviceNotFound,
java.io.IOException,
PortOccupiedException,
java.io.IOException,
DuplicateIdException
java.rmi.RemoteException
PortNotFound
DeviceNotFound
java.io.IOException
PortOccupiedException
DuplicateIdException
void scanPort(byte[] commPortName,
byte[] serviceSource)
throws java.rmi.RemoteException,
PortNotFound,
DeviceNotFound,
java.io.IOException,
PortOccupiedException,
java.io.IOException,
DuplicateIdException
java.rmi.RemoteException
PortNotFound
DeviceNotFound
java.io.IOException
PortOccupiedException
DuplicateIdException
Device getDevice(byte[] commPortName)
throws java.rmi.RemoteException,
PortNotFound,
DeviceNotFound
java.rmi.RemoteException
PortNotFound
DeviceNotFound
Port[] getPorts()
throws java.rmi.RemoteException
java.rmi.RemoteException
PowerSwitch[] getPowerSwitches()
throws java.rmi.RemoteException
java.rmi.RemoteException
DevicePacketSet getDevicePackets(long sensorID,
long startTime,
long endTime)
throws java.rmi.RemoteException,
DeviceNotFound,
NoDataException
java.rmi.RemoteException
DeviceNotFound
NoDataException
DevicePacketSet getDevicePackets(long sensorID,
long startTime,
long endTime,
int typeMask)
throws java.rmi.RemoteException,
DeviceNotFound,
NoDataException
java.rmi.RemoteException
DeviceNotFound
NoDataException
DevicePacketSet getDevicePackets(long sensorId,
long startTime,
long endTime,
int numBytes,
int timeout)
throws java.rmi.RemoteException,
TimeoutException,
java.lang.IllegalArgumentException,
DeviceNotFound,
NoDataException
java.rmi.RemoteException
TimeoutException
java.lang.IllegalArgumentException
DeviceNotFound
NoDataException
DevicePacketSet getDevicePackets(long sensorId,
long startTime,
long endTime,
int numBytes,
int typeMask,
int timeout)
throws java.rmi.RemoteException,
TimeoutException,
java.lang.IllegalArgumentException,
DeviceNotFound,
NoDataException
java.rmi.RemoteException
TimeoutException
java.lang.IllegalArgumentException
DeviceNotFound
NoDataException
boolean summarizing(long deviceID)
throws java.rmi.RemoteException,
DeviceNotFound
java.rmi.RemoteException
DeviceNotFound
void suspendService(byte[] portName)
throws java.rmi.RemoteException,
PortNotFound,
DeviceNotFound
java.rmi.RemoteException
PortNotFound
DeviceNotFound
void resumeService(byte[] portName)
throws java.rmi.RemoteException,
PortNotFound,
DeviceNotFound
java.rmi.RemoteException
PortNotFound
DeviceNotFound
void restartService(byte[] portName)
throws java.rmi.RemoteException,
PortNotFound,
DeviceNotFound,
InitializeException,
java.lang.Exception
java.rmi.RemoteException
PortNotFound
DeviceNotFound
InitializeException
java.lang.Exception
RemoteSerialPort getRemoteSerialPort(byte[] portName)
throws java.rmi.RemoteException,
java.net.UnknownHostException,
PortNotFound,
PortOccupiedException,
java.io.IOException
java.rmi.RemoteException
java.net.UnknownHostException
PortNotFound
PortOccupiedException
java.io.IOException
RemoteSerialPort getRemoteSerialPort(byte[] portName,
int timeout)
throws java.rmi.RemoteException,
java.net.UnknownHostException,
PortNotFound,
PortOccupiedException,
RangeException,
java.io.IOException
java.rmi.RemoteException
java.net.UnknownHostException
PortNotFound
PortOccupiedException
RangeException
java.io.IOException
int test()
throws java.rmi.RemoteException
java.rmi.RemoteException
Location getLocation()
throws java.rmi.RemoteException,
UnknownLocationException
java.rmi.RemoteException
UnknownLocationException
byte[] getMetadata()
throws java.rmi.RemoteException
java.rmi.RemoteException
byte[] getSchedule()
throws java.rmi.RemoteException
java.rmi.RemoteException
byte[] getSchedule(long lookAheadSeconds)
throws java.rmi.RemoteException
java.rmi.RemoteException
byte[] getSchedule(byte[] port,
long lookAheadSeconds)
throws java.rmi.RemoteException
java.rmi.RemoteException
byte[] addSchedule(byte[] port,
byte[] scheduleName,
byte[] schedule,
boolean overwrite)
throws java.rmi.RemoteException
java.rmi.RemoteException
byte[] removeSchedule(byte[] port,
byte[] scheduleName)
throws java.rmi.RemoteException
java.rmi.RemoteException
byte[] suspendSchedule(byte[] port,
byte[] scheduleName)
throws java.rmi.RemoteException
java.rmi.RemoteException
byte[] resumeSchedule(byte[] port,
byte[] scheduleName)
throws java.rmi.RemoteException
java.rmi.RemoteException
byte[] syncSchedule(byte[] port,
byte[] scheduleName,
long delayMillis)
throws java.rmi.RemoteException
java.rmi.RemoteException
void addEventCallback(NodeEventCallback callback)
throws java.rmi.RemoteException
java.rmi.RemoteException
int establishLease(long leaseMillisec,
byte[] clientNote)
throws java.rmi.RemoteException,
LeaseRefused
leaseMillisec - lease period in millisecondsclientNote - note attached by client
java.rmi.RemoteException
LeaseRefused
int establishLease(long leaseMillisec,
byte[] clientNote,
boolean usePrimary)
throws java.rmi.RemoteException,
LeaseRefused
java.rmi.RemoteException
LeaseRefused
void renewLease(int leaseID,
long leaseMillisec)
throws java.rmi.RemoteException,
LeaseRefused
leaseID - lease ID returned by establishLease()leaseMillisec - lease period in milliseconds
java.rmi.RemoteException
LeaseRefused
void renewLease(int leaseID,
long leaseMillisec,
boolean userPrimary)
throws java.rmi.RemoteException,
LeaseRefused
leaseID - lease ID returned by establishLease()leaseMillisec - lease period in milliseconds
java.rmi.RemoteException
LeaseRefused
void terminateLease(int leaseID)
throws java.rmi.RemoteException,
LeaseRefused
leaseID - lease ID returned by establishLease()
java.rmi.RemoteException
LeaseRefused
void terminateLease(int leaseID,
boolean usePrimary)
throws java.rmi.RemoteException,
LeaseRefused
leaseID - lease ID returned by establishLease()
java.rmi.RemoteException
LeaseRefused
int terminateLeases(byte[] noteMatch)
throws java.rmi.RemoteException,
LeaseRefused
java.rmi.RemoteException
LeaseRefused
void cpuLease(int requestorID,
long when,
long howLong)
throws java.rmi.RemoteException
requestorID - Unique ID (externally assigned) to identify who is requesting
the CPU to remain on. Allows for multiple requestors each
requesting that the CPU be on.when - Milliseconds until the requestor needs the CPU on. Use 0
(zero) to request that the CPU remain on starting now.howLong - Number of milliseconds that the CPU should remain on. Use 0
(zero) to cancel an earlier request.
java.rmi.RemoteException
byte[] getStatus(boolean logPacket)
throws java.rmi.RemoteException
java.rmi.RemoteException
void exitApplication()
throws java.rmi.RemoteException
java.rmi.RemoteException
void powerUpPort(byte[] commPortName,
int currentLimit)
throws java.rmi.RemoteException,
PortOccupiedException,
PortNotFound,
RangeException,
NotSupportedException
java.rmi.RemoteException
PortOccupiedException
PortNotFound
RangeException
NotSupportedException
void powerDownPort(byte[] commPortName)
throws java.rmi.RemoteException,
PortOccupiedException,
PortNotFound
java.rmi.RemoteException
PortOccupiedException
PortNotFound
java.net.InetAddress[] getSubnodes()
throws java.rmi.RemoteException
java.rmi.RemoteException
Subnode[] getSubnodeObjects()
throws java.rmi.RemoteException
java.rmi.RemoteException
void removeSubnode(java.net.InetAddress address)
throws java.rmi.RemoteException,
java.lang.Exception
java.rmi.RemoteException
java.lang.Exception
LeaseDescription[] getLeases(boolean usePrimary)
throws java.rmi.RemoteException
java.rmi.RemoteException
java.util.Vector getProperties()
throws java.rmi.RemoteException
java.rmi.RemoteException
byte[] runCommand(byte[] cmd,
int timeoutSec)
throws java.rmi.RemoteException,
java.io.IOException,
TimeoutException
java.rmi.RemoteException
java.io.IOException
TimeoutException
void enterSafeMode()
throws java.rmi.RemoteException,
java.lang.Exception
java.rmi.RemoteException
java.lang.Exception
void enterSafeMode(long timeoutSec)
throws java.rmi.RemoteException,
java.lang.Exception
java.rmi.RemoteException
java.lang.Exception
void resumeNormalMode()
throws java.rmi.RemoteException,
java.lang.Exception
java.rmi.RemoteException
java.lang.Exception
void annotate(byte[] annotation)
throws java.rmi.RemoteException
java.rmi.RemoteException
void exitApplication(boolean doSafemode,
boolean doHalt,
boolean enableBackups,
boolean doNotify,
boolean recursive,
int quitDelaySec,
int haltDelaySec,
java.lang.String msg)
throws java.rmi.RemoteException,
java.lang.Exception
java.rmi.RemoteException
java.lang.Exception
void setProperties(byte[] propertyStrings)
throws java.rmi.RemoteException,
InvalidPropertyException
java.rmi.RemoteException
InvalidPropertyException
NodeInfo getNodeInfo()
throws java.lang.Exception,
java.rmi.RemoteException
java.lang.Exception
java.rmi.RemoteException
NodeSessionInfo startSession(boolean renewWDT,
byte[] initScript,
int initScriptTimeoutSec)
throws java.rmi.RemoteException,
java.lang.Exception
java.rmi.RemoteException
java.lang.Exception
void shoreLinkUpCallback(java.lang.String interfaceName,
java.lang.String serialName,
java.net.InetAddress localAddress,
java.net.InetAddress remoteAddress)
throws java.rmi.RemoteException,
java.lang.Exception
java.rmi.RemoteException
java.lang.Exception
void shoreLinkDownCallback(java.lang.String interfaceName,
java.lang.String serialName,
java.net.InetAddress localAddress,
java.net.InetAddress remoteAddress)
throws java.rmi.RemoteException,
java.lang.Exception
java.rmi.RemoteException
java.lang.Exception
Instrument lookupService(java.lang.String registryName)
throws java.rmi.RemoteException
java.rmi.RemoteException
byte[] instrumentRegistryStatus()
throws java.rmi.RemoteException
java.rmi.RemoteException
void readLog4jConfig()
throws java.rmi.RemoteException
java.rmi.RemoteException
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||