org.jlab.coda.emu.support.messaging

Class CMSGPortal

java.lang.Object

org.jlab.coda.emu.support.messaging.CMSGPortal

All Implemented Interfaces:

LoggerAppender

public class CMSGPortal
extends java.lang.Object
implements LoggerAppender

This class creates a connection to a cMsg server for the purposes of receiving run control commands and logging dalog messages.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Emu	emu Store a reference to the EMU here (which is the only object that uses this CMSGPortal object).

Constructor Summary

Constructors

Constructor and Description
CMSGPortal(Emu emu) Constructor.

Method Summary

Modifier and Type	Method and Description
void	append(LoggingEvent event) Send a dalogmsg message using the cMsg system.
void	cMsgServerConnect() Create 2 connections to the run control platform's cMsg domain server.
org.jlab.coda.cMsg.cMsg	getCmsgServer() Get the connection object to the cMsg server of runcontrol platform.
java.lang.String	getPlatformHost() Get the IP address the platform is running on.
int	getPlatformPort() Get the TCP port the platform's cMsg domain server is listening on.
org.jlab.coda.cMsg.cMsg	getRcServer() Get the connection object to the rc multicast server of runcontrol platform.
java.lang.String	getRcUDL() Get the UDL used to make the connection to the rc server.
void	rcGuiErrorMessage(java.lang.String text) Send an error message that ends up on the run control gui.
void	rcGuiInfoMessage(java.lang.String text) Send an informational message that ends up on the run control gui.
void	rcGuiSevereMessage(java.lang.String text) Send an error message that ends up on the run control gui.
void	rcGuiWarningMessage(java.lang.String text) Send a warning message that ends up on the run control gui.
void	sendMHandlerMessage(int val, java.lang.String type) Send messages to a callback in this emu so that it can send all rocs the lowest number of evio events received by this event builder in a single ET buffer.
void	sendRocMessage(int lowM, int highM, int highSafeM) Send a message to the connected rocs specifying the lowest and highest number of evio events per single ET buffer that was received by the input channels to this emu.
void	shutdown() Disconnect from the runcontrol platform.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

emu

final Emu emu

Store a reference to the EMU here (which is the only object that uses this CMSGPortal object).

Constructor Detail

CMSGPortal

public CMSGPortal(Emu emu)
           throws EmuException

Constructor.

Parameters:

emu - reference to EMU object

Throws:

EmuException - never thrown

Method Detail

cMsgServerConnect

public void cMsgServerConnect()
                       throws EmuException

Create 2 connections to the run control platform's cMsg domain server. Called during the configure transition since that is when the rc server sends us info about the platform host and cMsg domain server's TCP port.

Throws:

EmuException - if platform did not send its IP addresses and cMsg TCP port; if cannot connect to cMsg domain server in platform.

shutdown

public void shutdown()
              throws org.jlab.coda.cMsg.cMsgException

Disconnect from the runcontrol platform. Called from the EMU when quitting.

Throws:

org.jlab.coda.cMsg.cMsgException - never thrown

getPlatformHost

public java.lang.String getPlatformHost()

Get the IP address the platform is running on. Valid only after first config transition.

Returns:

IP address the platform is running on.

getPlatformPort

public int getPlatformPort()

Get the TCP port the platform's cMsg domain server is listening on. Valid only after first config transition.

Returns:

TCP port the platform's cMsg domain server is listening on.

getRcServer

public org.jlab.coda.cMsg.cMsg getRcServer()

Get the connection object to the rc multicast server of runcontrol platform.

Returns:

connection object to the rc multicast server of runcontrol platform.

getCmsgServer

public org.jlab.coda.cMsg.cMsg getCmsgServer()

Get the connection object to the cMsg server of runcontrol platform.

Returns:

connection object to the cMsg server of runcontrol platform.

getRcUDL

public java.lang.String getRcUDL()

Get the UDL used to make the connection to the rc server.

Returns:

UDL used to make the connection to the rc server.

sendMHandlerMessage

public void sendMHandlerMessage(int val,
                                java.lang.String type)

Send messages to a callback in this emu so that it can send all rocs the lowest number of evio events received by this event builder in a single ET buffer. Using cMsg name server in platform.

Parameters:

val - lowest # of evio events found in a single ET buffer or reset (depending on type value)

type - "M" if val is lowest # of evio events in a single ET buffer as reported by ET input channel or "reset" if clearing M values at prestart

sendRocMessage

public void sendRocMessage(int lowM,
                           int highM,
                           int highSafeM)

Send a message to the connected rocs specifying the lowest and highest number of evio events per single ET buffer that was received by the input channels to this emu. It also includes the value of the highest safe number of evio events for each ROC to place in an ET buffer. Using cMsg domain server in platform.

Parameters:

lowM - lowest number of ROC records per single ET buffer received by the input channels to this emu

highM - highest number of ROC records per single ET buffer received by the input channels to this emu

highSafeM - highest number of ROC records per single ET buffer that each ROC should be sending

append

public void append(LoggingEvent event)

Send a dalogmsg message using the cMsg system.

Specified by:

append in interface LoggerAppender

Parameters:

event - event to be logged

rcGuiInfoMessage

public void rcGuiInfoMessage(java.lang.String text)

Send an informational message that ends up on the run control gui.

Parameters:

text - text of message

rcGuiWarningMessage

public void rcGuiWarningMessage(java.lang.String text)

Send a warning message that ends up on the run control gui. Is the lightest of errors. Component's state does not change. Shows in orange.

Parameters:

text - text of message

rcGuiErrorMessage

public void rcGuiErrorMessage(java.lang.String text)

Send an error message that ends up on the run control gui. Is a medium error. Component must be reset. Shows in red.

Parameters:

text - text of message

rcGuiSevereMessage

public void rcGuiSevereMessage(java.lang.String text)

Send an error message that ends up on the run control gui. Worst error. Component must be killed and restarted in order to function. Shows in purple.

Parameters:

text - text of message