org.jlab.coda.cMsg.cMsgDomain.subdomains

Class LogFile

java.lang.Object

org.jlab.coda.cMsg.common.cMsgSubdomainAdapter

org.jlab.coda.cMsg.cMsgDomain.subdomains.LogFile

All Implemented Interfaces:

cMsgSubdomainInterface

public class LogFile
extends cMsgSubdomainAdapter

cMsg subdomain handler for LogFile subdomain which stores messages in a file. Current implementation uses a PrintWriter.

Version:

1.0

Author:

Elliott Wolin

Constructor Summary

Constructors

Constructor and Description
LogFile()

Method Summary

Modifier and Type	Method and Description
void	handleClientShutdown() Close file if no one else is using it.
void	handleSendRequest(cMsgMessageFull msg) Write message to a file.
int	handleSyncSendRequest(cMsgMessageFull msg) Write message to a file.
boolean	hasSend() Method to tell if the "send" cMsg API function is implemented by this interface implementation in the "handleSendRequest" method.
boolean	hasSyncSend() Method to tell if the "syncSend" cMsg API function is implemented by this interface implementation in the "handleSyncSendRequest" method.
void	registerClient(cMsgClientInfo info) Open file in which to store messages using append mode.
void	setUDLRemainder(java.lang.String UDLRemainder) Method to give the subdomain handler the appropriate part of the UDL the client used to talk to the domain server.

Methods inherited from class org.jlab.coda.cMsg.common.cMsgSubdomainAdapter

handleSendAndGetRequest, handleShutdownClientsRequest, handleSubscribeAndGetRequest, handleSubscribeRequest, handleUnSendAndGetRequest, handleUnsubscribeAndGetRequest, handleUnsubscribeRequest, hasSendAndGet, hasShutdown, hasSubscribe, hasSubscribeAndGet, hasUnsubscribe

Methods inherited from class java.lang.Object

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

Constructor Detail

LogFile

public LogFile()

Method Detail

hasSend

public boolean hasSend()

Method to tell if the "send" cMsg API function is implemented by this interface implementation in the "handleSendRequest" method.

Specified by:

hasSend in interface cMsgSubdomainInterface

Overrides:

hasSend in class cMsgSubdomainAdapter

Returns:

true

hasSyncSend

public boolean hasSyncSend()

Method to tell if the "syncSend" cMsg API function is implemented by this interface implementation in the "handleSyncSendRequest" method.

Specified by:

hasSyncSend in interface cMsgSubdomainInterface

Overrides:

hasSyncSend in class cMsgSubdomainAdapter

Returns:

true

setUDLRemainder

public void setUDLRemainder(java.lang.String UDLRemainder)
                     throws cMsgException

Method to give the subdomain handler the appropriate part of the UDL the client used to talk to the domain server.

Specified by:

setUDLRemainder in interface cMsgSubdomainInterface

Overrides:

setUDLRemainder in class cMsgSubdomainAdapter

Parameters:

UDLRemainder - last part of the UDL appropriate to the subdomain handler

Throws:

cMsgException - never

registerClient

public void registerClient(cMsgClientInfo info)
                    throws cMsgException

Open file in which to store messages using append mode.

Specified by:

registerClient in interface cMsgSubdomainInterface

Overrides:

registerClient in class cMsgSubdomainAdapter

Parameters:

info - information about client

Throws:

cMsgException - if cannot find or read file

handleSendRequest

public void handleSendRequest(cMsgMessageFull msg)
                       throws cMsgException

Write message to a file.

Specified by:

handleSendRequest in interface cMsgSubdomainInterface

Overrides:

handleSendRequest in class cMsgSubdomainAdapter

Parameters:

msg - message from sender

Throws:

cMsgException - never

handleSyncSendRequest

public int handleSyncSendRequest(cMsgMessageFull msg)
                          throws cMsgException

Write message to a file.

Specified by:

handleSyncSendRequest in interface cMsgSubdomainInterface

Overrides:

handleSyncSendRequest in class cMsgSubdomainAdapter

Parameters:

msg - message from sender

Returns:

0

Throws:

cMsgException - never

handleClientShutdown

public void handleClientShutdown()
                          throws cMsgException

Close file if no one else is using it.

Specified by:

handleClientShutdown in interface cMsgSubdomainInterface

Overrides:

handleClientShutdown in class cMsgSubdomainAdapter

Throws:

cMsgException - never