org.jlab.coda.cMsg.FileDomain

Class File

java.lang.Object

org.jlab.coda.cMsg.common.cMsgDomainAdapter

org.jlab.coda.cMsg.FileDomain.File

All Implemented Interfaces:

cMsgDomainInterface

public class File
extends cMsgDomainAdapter

This class implements a client in the cMsg File domain which stores messages in files.

Version:

1.0

Author:

Elliott Wolin

Field Summary

Fields inherited from class org.jlab.coda.cMsg.common.cMsgDomainAdapter

connected, debug, description, domain, host, name, receiving, shutdownHandler, UDL, UDLremainder

Constructor Summary

Constructors

Constructor and Description
File() Constructor for File domain.

Method Summary

Modifier and Type	Method and Description
void	connect() Opens a file.
void	disconnect() Closes file.
void	flush(int timeout) Flushes output.
void	send(cMsgMessage msg) Writes to file.
int	syncSend(cMsgMessage message, int timeout) Calls send to write to file.

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

getCurrentUDL, getDebug, getDescription, getDomain, getHost, getInfo, getName, getServerHost, getServerPort, getShutdownHandler, getUDL, getUDLRemainder, isConnected, isReceiving, monitor, sendAndGet, setDebug, setDescription, setName, setShutdownHandler, setUDL, setUDLRemainder, shutdownClients, shutdownServers, start, stop, subscribe, subscribeAndGet, unsubscribe

Methods inherited from class java.lang.Object

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

Constructor Detail

File

public File()

Constructor for File domain.

UDL: cMsg:file//fileName?textOnly=value.

Default is to print entire message to file. If textOnly=true then only print timestamp and message text to file.

Method Detail

connect

public void connect()
             throws cMsgException

Opens a file.

Specified by:

connect in interface cMsgDomainInterface

Overrides:

connect in class cMsgDomainAdapter

Throws:

cMsgException - if cannot open file or domain specific part of UDL is null

disconnect

public void disconnect()

Closes file.

Specified by:

disconnect in interface cMsgDomainInterface

Overrides:

disconnect in class cMsgDomainAdapter

send

public void send(cMsgMessage msg)
          throws cMsgException

Writes to file.

Specified by:

send in interface cMsgDomainInterface

Overrides:

send in class cMsgDomainAdapter

Parameters:

msg - message to write to file

Throws:

cMsgException - if file is closed (connect was not called, or disconnect was called)

syncSend

public int syncSend(cMsgMessage message,
                    int timeout)
             throws cMsgException

Calls send to write to file.

Specified by:

syncSend in interface cMsgDomainInterface

Overrides:

syncSend in class cMsgDomainAdapter

Parameters:

message - message to write to file

timeout - time in milliseconds to wait for a response

Returns:

0

Throws:

cMsgException - if file is closed (connect was not called, or disconnect was called)

flush

public void flush(int timeout)
           throws cMsgException

Flushes output.

Specified by:

flush in interface cMsgDomainInterface

Overrides:

flush in class cMsgDomainAdapter

Parameters:

timeout - ignored

Throws:

cMsgException - if file is closed (connect was not called, or disconnect was called)