org.jlab.coda.cMsg.cMsgDomain.server

Class cMsgClientData

java.lang.Object

org.jlab.coda.cMsg.common.cMsgClientInfo

org.jlab.coda.cMsg.cMsgDomain.server.cMsgClientData

class cMsgClientData
extends cMsgClientInfo

Need to store a little extra info not covered in the super class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	cMsgClientData.monitorData Convenience class to store all monitoring quantities.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.nio.ByteBuffer	buffer Direct buffer for reading TCP nonblocking IO.
(package private) int	bytesRead
(package private) java.util.concurrent.atomic.AtomicBoolean	calledSubdomainShutdown Keep track of whether the handleShutdown method of the subdomain handler object has already been called.
(package private) int	clientKey Unique key sent by cMsgNameServer to client as an ID.
(package private) java.lang.String	clientPassword For server clients, the password clients must use to connect to that server.
(package private) cMsg	cMsgSubdomainHandler Reference to cMsg subdomain handler object if appropriate.
(package private) boolean	inCmsgSubdomain Is this client in the cMsg domain?
(package private) java.nio.ByteBuffer	kaBuffer Buffer for sending keep-alive/monitoring info to this client if there are "issues".
(package private) java.nio.channels.SocketChannel	keepAliveChannel Socket channel used by this server to get monitor data from client and to send monitor data to client (dual functions as keepAlive).
(package private) cMsgClientData.monitorData	monData
(package private) boolean	readingSize Internal bookkeeping.
(package private) int	size Size of data in bytes (not including int representing size which is the first data sent).
(package private) cMsgSubdomainInterface	subdomainHandler Reference to subdomain handler object.
(package private) java.net.DatagramSocket	udpSocket Socket to receive UDP sends from the client.
(package private) long	updateTime

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

clientHost, deliverer, description, domainHost, domainPort, domainUdpPort, dottedDecimalAddr, isServer, messageChannel, multicastPort, name, namespace, serverPort, subdomain, UDL, UDLremainder

Constructor Summary

Constructors

Constructor and Description
cMsgClientData(java.lang.String name, int nsPort, int mPort, java.lang.String host, java.lang.String password, int uniqueKey) Constructor used when cMsg server acts as a client and connects a to cMsg server.
cMsgClientData(java.lang.String name, int nsPort, int port, java.lang.String host, java.lang.String dotDec, java.lang.String subdomain, java.lang.String UDLRemainder, java.lang.String UDL, java.lang.String description, int uniqueKey) Constructor specifing client's name, port, host, subdomain, and UDL remainder.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPassword() Gets server client's client-connect password.

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

getClientHost, getDeliverer, getDescription, getDomainHost, getDomainPort, getDomainUdpPort, getDottedDecimalAddr, getMessageChannel, getMessageChannelRemoteSocketAddress, getName, getNamespace, getServerHost, getServerMulticastPort, getServerPort, getSubdomain, getUDL, getUDLremainder, isServer, setDeliverer, setDomainHost, setDomainPort, setDomainUdpPort, setMessageChannel, setNamespace

Methods inherited from class java.lang.Object

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

Field Detail

clientPassword

java.lang.String clientPassword

For server clients, the password clients must use to connect to that server.

udpSocket

java.net.DatagramSocket udpSocket

Socket to receive UDP sends from the client.

keepAliveChannel

java.nio.channels.SocketChannel keepAliveChannel

Socket channel used by this server to get monitor data from client and to send monitor data to client (dual functions as keepAlive).

subdomainHandler

cMsgSubdomainInterface subdomainHandler

Reference to subdomain handler object.

cMsgSubdomainHandler

cMsg cMsgSubdomainHandler

Reference to cMsg subdomain handler object if appropriate.

calledSubdomainShutdown

java.util.concurrent.atomic.AtomicBoolean calledSubdomainShutdown

Keep track of whether the handleShutdown method of the subdomain handler object has already been called.

inCmsgSubdomain

boolean inCmsgSubdomain

Is this client in the cMsg domain?

readingSize

boolean readingSize

Internal bookkeeping.

size

int size

Size of data in bytes (not including int representing size which is the first data sent).

bytesRead

int bytesRead

clientKey

int clientKey

Unique key sent by cMsgNameServer to client as an ID.

buffer

java.nio.ByteBuffer buffer

Direct buffer for reading TCP nonblocking IO.

kaBuffer

java.nio.ByteBuffer kaBuffer

Buffer for sending keep-alive/monitoring info to this client if there are "issues".

monData

cMsgClientData.monitorData monData

updateTime

long updateTime

Constructor Detail

cMsgClientData

public cMsgClientData(java.lang.String name,
                      int nsPort,
                      int port,
                      java.lang.String host,
                      java.lang.String dotDec,
                      java.lang.String subdomain,
                      java.lang.String UDLRemainder,
                      java.lang.String UDL,
                      java.lang.String description,
                      int uniqueKey)

Constructor specifing client's name, port, host, subdomain, and UDL remainder. Used in nameServer for a connecting regular client.

Parameters:

name - client's name

nsPort - name server's listening port

port - client's listening port

host - client's host

dotDec - client's address in dotted decimal form

subdomain - client's subdomain

UDLRemainder - client's UDL's remainder

UDL - client's UDL

description - client's description

uniqueKey - client's unique key (generated by nameserver)

cMsgClientData

public cMsgClientData(java.lang.String name,
                      int nsPort,
                      int mPort,
                      java.lang.String host,
                      java.lang.String password,
                      int uniqueKey)

Constructor used when cMsg server acts as a client and connects a to cMsg server. Used in nameServer for a connecting server client.

Parameters:

name - server client's name

nsPort - name server's TCP listening port

mPort - name server's UDP multicast listening port

host - server client's host

password - server client's password that its clients use to connect

uniqueKey - client's unique key (generated by nameserver)

Method Detail

getPassword

public java.lang.String getPassword()

Gets server client's client-connect password.

Returns:

server client's client-connect password