hypercast.MonitorAndControl
Interface I_Portal

All Superinterfaces:
I_Stats
All Known Implementing Classes:
Portal

public interface I_Portal
extends I_Stats

See Also:
Portal

Method Summary
 void closePortal()
          Closes the portal.
 void openPortal()
          Opens the Portal.
 void setSilentOff()
          Causes a Portal to begin sending MonitorAdvertise messages to a Monitor
 void setSilentOn()
          Causes a Portal to cease sending MonitorAdvertise messages to a Monitor
 void startTranscript(java.lang.String filename)
          Causes MCMessages to be recorded in a transcript file.
 void stopTranscript()
          Stops transcripting.
 
Methods inherited from interface hypercast.I_Stats
getReadSchema, getStats, getStatsName, getWriteSchema, setStats, setStatsName
 

Method Detail

openPortal

public void openPortal()
Opens the Portal. This causes the PortalAdvertiser thread to unblock so that MCAdvertiseMessages begin to flow from the Portal to the Monitor. A Portal cannot be used until it is opened.


closePortal

public void closePortal()
Closes the portal. This causes the PortalAdvertiser thread to block so that MCAdvertiseMessages cease to flow from the Portal to the Monitor.


startTranscript

public void startTranscript(java.lang.String filename)
                     throws java.io.FileNotFoundException,
                            java.lang.IllegalStateException,
                            HyperCastWarningRuntimeException
Causes MCMessages to be recorded in a transcript file. Depending on the options present in the configuration file either messages that are sent, received, or both will be recorded.

Parameters:
filename - The name of the transcript file.
Throws:
HyperCastWarningRuntimeException - If the header cannot be written to the transcript file.
HyperCastWarningRuntimeException - If the configuration specifies that neither sent nor received messsages should be recorded.
java.io.FileNotFoundException - If the specified file cannot be accessed
java.lang.IllegalStateException - If a transcript is already started

stopTranscript

public void stopTranscript()
                    throws java.lang.IllegalStateException,
                           HyperCastWarningRuntimeException
Stops transcripting.

Throws:
java.lang.IllegalStateException - If no transcript is active.
HyperCastWarningRuntimeException

setSilentOn

public void setSilentOn()
Causes a Portal to cease sending MonitorAdvertise messages to a Monitor


setSilentOff

public void setSilentOff()
Causes a Portal to begin sending MonitorAdvertise messages to a Monitor