org.jlab.coda.cMsg.cMsgDomain.server

Class cMsgConnectionHandler

java.lang.Object

java.lang.Thread

org.jlab.coda.cMsg.cMsgDomain.server.cMsgConnectionHandler

All Implemented Interfaces:

java.lang.Runnable

class cMsgConnectionHandler
extends java.lang.Thread

This class creates all permanent connections to clients and passes these sockets to either a cMsgDomainServer or cMsgDomainServerSelect object.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.concurrent.ConcurrentHashMap<java.lang.Integer,org.jlab.coda.cMsg.cMsgDomain.server.cMsgConnectionHandler.clientInfoStorage>	clients Map in which to store the clients currently trying to connect and their associated info.
(package private) int	debug Debug level.
(package private) boolean	killThisThread Kill this thread if true.
(package private) cMsgNameServer	nameServer Name server object.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
cMsgConnectionHandler(cMsgNameServer nameServer, int debug) Constructor.

Method Summary

Modifier and Type	Method and Description
void	allowConnections(cMsgClientData info) This method allows 2 connections from a client to begin.
void	cleanupConnections(org.jlab.coda.cMsg.cMsgDomain.server.cMsgConnectionHandler.clientInfoStorage storage) Cleanup debris when connections are not made, partially made, or gotConnections(org.jlab.coda.cMsg.cMsgDomain.server.cMsgClientData, int) has timed out.
int	getUniqueKey() Get a unique key to use as client identification which is used in forming the 2 permanent client connections using this object.
boolean	gotConnections(cMsgClientData info, int secondsToWait) This method determines whether or not 2 connections from a client were made after the process was initialized by the method allowConnections(org.jlab.coda.cMsg.cMsgDomain.server.cMsgClientData).
(package private) void	killThread() Kills this thread.
void	run() This method is a thread which listens for TCP connections from the client.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

clients

java.util.concurrent.ConcurrentHashMap<java.lang.Integer,org.jlab.coda.cMsg.cMsgDomain.server.cMsgConnectionHandler.clientInfoStorage> clients

Map in which to store the clients currently trying to connect and their associated info.

nameServer

cMsgNameServer nameServer

Name server object.

killThisThread

volatile boolean killThisThread

Kill this thread if true.

debug

int debug

Debug level.

Constructor Detail

cMsgConnectionHandler

public cMsgConnectionHandler(cMsgNameServer nameServer,
                             int debug)

Constructor.

Parameters:

nameServer - server which contains this object.

debug - debug level which controls debugging output.

Method Detail

killThread

void killThread()

Kills this thread.

getUniqueKey

public int getUniqueKey()

Get a unique key to use as client identification which is used in forming the 2 permanent client connections using this object.

Returns:

unique key

allowConnections

public void allowConnections(cMsgClientData info)

This method allows 2 connections from a client to begin. It should be used in conjunction with gotConnections(org.jlab.coda.cMsg.cMsgDomain.server.cMsgClientData, int) which notifies caller that connections were made or timeout occurred.

Be sure to call this method before sending the name server response to the the initial client communication.

Parameters:

info - client info object

gotConnections

public boolean gotConnections(cMsgClientData info,
                              int secondsToWait)

This method determines whether or not 2 connections from a client were made after the process was initialized by the method allowConnections(org.jlab.coda.cMsg.cMsgDomain.server.cMsgClientData). This method returns when the connections are complete or after the timeout period (whichever is sooner).

Be sure to call this method after finishing the name server response to the initial client communication.

Parameters:

info - client info object

secondsToWait - number of seconds to wait for connections to be made before returning false

Returns:

true if connections made, else false

cleanupConnections

public void cleanupConnections(org.jlab.coda.cMsg.cMsgDomain.server.cMsgConnectionHandler.clientInfoStorage storage)

Cleanup debris when connections are not made, partially made, or gotConnections(org.jlab.coda.cMsg.cMsgDomain.server.cMsgClientData, int) has timed out.

Parameters:

storage - object storing client info

run

public void run()

This method is a thread which listens for TCP connections from the client. There are 2 connections from each client. The first is a socket for the main communication between this server and the client. The second socket is for keep alives between them.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread