Interface: IPHXMonitorable

Package: com.phoenix_int.aserver

Known Implementing Classes

• PHXRunShare

Related Interfaces and Classes

• IPHXComponent, IPHXAnalysis, IPHXDriver, IPHXHaltableComponent, PHXSimpleSelfManager, PHXSimpleSelfManager2, PHXSimpleSelfManager3, PHXComponentBranch, PHXComponentDescription, PHXComponentVersion, PHXGroup, PHXMethodDescriptor, PHXPropertyDescriptor, PHXVariableInfo, PHXDFTException, PHXNoSuchObjectException, PHXNoSuchWriteableObjectException, PHXInvokeReturn, PHXNameAlreadyInUseException, PHXInvalidNameException

Declaration

public interface IPHXMonitorable

This is the interface that analyses which provide information about running processes should implement.

Method Summary

Method Detail

listProcesses

PHXProcessInfo[] listProcesses()
                        throws java.io.IOException

Lists all the running processes associated with a component.

Throws:

• java.io.IOException - If there was a problem reading information about running processes

listMonitorableFiles

java.lang.String[] listMonitorableFiles()
                                 throws java.io.IOException

Lists all items that may be monitored for output as a component is running. Note that this is normally in addition to any PHXRawFile output variables that your component exposes. Because of this, these names must not conflict with any variable names.

Throws:

• java.io.IOException

getMonitor

java.lang.Object getMonitor(java.lang.String monitorName)
                     throws PHXNoSuchObjectException

Gets a specified monitor. This method can return PHXRawFile objects to publish files for monitoring that don't appear as a regular variable, or PHXMonitorableStream objects to publish random streams of monitor data.

Returns:

• either a PHXRawFile or a PHXMonitorableStream object

Throws:

• PHXNoSuchObjectException