org.jlab.coda.cMsg.cMsgDomain.server

Class cMsgDomainServerSelect

java.lang.Object

java.lang.Thread

org.jlab.coda.cMsg.cMsgDomain.server.cMsgDomainServerSelect

All Implemented Interfaces:

java.lang.Runnable

class cMsgDomainServerSelect
extends java.lang.Thread

Domain Server which services a number of clients through select and nonblocking sockets.

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.atomic.AtomicBoolean	calledShutdown Keep track of whether the shutdown method of this object has already been called.
(package private) java.util.concurrent.ConcurrentHashMap<cMsgClientData,java.lang.String>	clients Set of all clients in this domain server.
(package private) java.util.concurrent.ConcurrentHashMap<cMsgClientData,java.lang.String>	clients2register Set of all clients waiting to be registered with the selector of this domain server.
(package private) static java.lang.String	domainType Type of domain this is.
(package private) cMsgClientData	myClientInfo Object containing information about the client this object is connected to.
(package private) java.nio.channels.Selector	selector Selector object each client's channel is registered with.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
cMsgDomainServerSelect(cMsgNameServer nameServer, int clientsMax, int debug, boolean noUdp) Constructor.

Method Summary

Modifier and Type	Method and Description
(package private) boolean	addClient(cMsgClientData info) Method to allow another client to send to this domain server.
(package private) boolean	clientIsServer() Is the single client served by this object is a cMsg server?
(package private) void	deleteClient(cMsgClientData cd) Method to gracefully remove client from this domain server.
void	finalize() Method to be run when this server's clients are dead or disconnected and the server threads will be killed.
(package private) int	getClientsMax() Gets the maximum number of clients this object communicates with.
int	getUdpPort() Getter for the UDP port being used.
(package private) int	numberOfClients()
void	run() This method is a thread which uses select to read messages from clients.
(package private) void	setClientsMax(int clientsMax) Sets the maximum number of clients this object communicates with.
(package private) void	shutdown() Method to gracefully shutdown this object's threads and clean things up.
(package private) void	startThreads() Start reading and writing over the sockets.

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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

domainType

static java.lang.String domainType

Type of domain this is.

myClientInfo

cMsgClientData myClientInfo

Object containing information about the client this object is connected to. This is relevant only if this object has a single client - which is the case when it is a another cMsg server. Certain members of this object can only be filled in by this thread, such as the listening port.

clients

java.util.concurrent.ConcurrentHashMap<cMsgClientData,java.lang.String> clients

Set of all clients in this domain server. The value is just a dummy so the concurrent hashmap could be used.

clients2register

java.util.concurrent.ConcurrentHashMap<cMsgClientData,java.lang.String> clients2register

Set of all clients waiting to be registered with the selector of this domain server. The value is just a dummy so the concurrent hashmap could be used.

selector

java.nio.channels.Selector selector

Selector object each client's channel is registered with.

calledShutdown

java.util.concurrent.atomic.AtomicBoolean calledShutdown

Keep track of whether the shutdown method of this object has already been called.

Constructor Detail

cMsgDomainServerSelect

public cMsgDomainServerSelect(cMsgNameServer nameServer,
                              int clientsMax,
                              int debug,
                              boolean noUdp)
                       throws cMsgException,
                              java.io.IOException

Constructor.

Parameters:

nameServer - nameServer object which created (is creating) this object

clientsMax - maximum number of clients serviced by this object at one time

debug - level of debug output.

noUdp - if true, do not create and listen on a udp socket.

Throws:

cMsgException - if listening socket could not be opened or a port to listen on could not be found

java.io.IOException - if selector cannot be opened

Method Detail

getClientsMax

int getClientsMax()

Gets the maximum number of clients this object communicates with.

Returns:

the maximum number of clients this object communicates with

setClientsMax

void setClientsMax(int clientsMax)

Sets the maximum number of clients this object communicates with.

Parameters:

clientsMax - the maximum number of clients this object communicates with

getUdpPort

public int getUdpPort()

Getter for the UDP port being used.

Returns:

UDP port being used

clientIsServer

boolean clientIsServer()

Is the single client served by this object is a cMsg server?

Returns:

true if the single client served by this object is a cMsg server, else false

startThreads

void startThreads()
           throws java.io.IOException

Start reading and writing over the sockets. Start threads to process client requests.

Throws:

java.io.IOException - if I/O problems

numberOfClients

int numberOfClients()

addClient

boolean addClient(cMsgClientData info)
           throws java.io.IOException

Method to allow another client to send to this domain server. Only clientsMax number of clients may use this domain server. Before this method is called, the client has already created 2 permanent TCP sockets to this server.

Parameters:

info - information on client trying to connect to this domain server

Returns:

true if client added, else false.

Throws:

java.io.IOException - if socket to client cannot be opened

finalize

public void finalize()

Method to be run when this server's clients are dead or disconnected and the server threads will be killed.

Finalize methods are run after an object has become unreachable and before the garbage collector is run.

Overrides:

finalize in class java.lang.Object

shutdown

void shutdown()

Method to gracefully shutdown this object's threads and clean things up.

deleteClient

void deleteClient(cMsgClientData cd)

Method to gracefully remove client from this domain server.

Parameters:

cd - client data object

run

public void run()

This method is a thread which uses select to read messages from clients.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread