org.jlab.coda.cMsg.TCPSDomain

Class TCPS

java.lang.Object

org.jlab.coda.cMsg.common.cMsgDomainAdapter

org.jlab.coda.cMsg.TCPSDomain.TCPS

All Implemented Interfaces:

cMsgDomainInterface

public class TCPS
extends cMsgDomainAdapter

This class implements a cMsg client in the TCPServer (or TCPS) domain.

Version:

1.0

Author:

Carl Timmer

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.nio.channels.SocketChannel	channel Channel for talking to TCPServer.
(package private) java.util.concurrent.locks.Lock	connectLock Lock for calling connect() or disconnect().
(package private) java.io.DataOutputStream	dataOut Socket output stream associated with channel - sends messages to server.
(package private) java.util.concurrent.locks.Lock	notConnectLock Lock for calling methods other than connect() or disconnect().
(package private) java.util.concurrent.locks.Lock	socketLock Lock to ensure that methods using the socket, write in sequence.
(package private) java.lang.String	tcpServerHost TCPServer's host.
(package private) int	tcpServerPort TCPServer's TCP listening port.

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
TCPS() Constructor.

Method Summary

Modifier and Type	Method and Description
void	connect() Method to connect to the TCPServer from this client.
void	disconnect() Method to close the connection to the tcpServer.
void	send(cMsgMessage message) Method to send a message/command to the TCPServer.

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

flush, 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, syncSend, unsubscribe

Methods inherited from class java.lang.Object

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

Field Detail

tcpServerHost

java.lang.String tcpServerHost

TCPServer's host.

tcpServerPort

int tcpServerPort

TCPServer's TCP listening port.

channel

java.nio.channels.SocketChannel channel

Channel for talking to TCPServer.

dataOut

java.io.DataOutputStream dataOut

Socket output stream associated with channel - sends messages to server.

connectLock

java.util.concurrent.locks.Lock connectLock

Lock for calling connect() or disconnect().

notConnectLock

java.util.concurrent.locks.Lock notConnectLock

Lock for calling methods other than connect() or disconnect().

socketLock

java.util.concurrent.locks.Lock socketLock

Lock to ensure that methods using the socket, write in sequence.

Constructor Detail

TCPS

public TCPS()

Constructor.

Method Detail

connect

public void connect()
             throws cMsgException

Method to connect to the TCPServer from this client.

Specified by:

connect in interface cMsgDomainInterface

Overrides:

connect in class cMsgDomainAdapter

Throws:

cMsgException - if there are problems parsing the UDL or communication problems with the server(s)

disconnect

public void disconnect()

Method to close the connection to the tcpServer. This method results in this object becoming functionally useless.

Specified by:

disconnect in interface cMsgDomainInterface

Overrides:

disconnect in class cMsgDomainAdapter

send

public void send(cMsgMessage message)
          throws cMsgException

Method to send a message/command to the TCPServer. The command is sent as a string in the message's text field.

Specified by:

send in interface cMsgDomainInterface

Overrides:

send in class cMsgDomainAdapter

Parameters:

message - message to send

Throws:

cMsgException - if there are communication problems with the server; text is null or blank