org.jlab.coda.cMsg.common

Class cMsgClientInfo

java.lang.Object

org.jlab.coda.cMsg.common.cMsgClientInfo

Direct Known Subclasses:

cMsgClientData

public class cMsgClientInfo
extends java.lang.Object

This class stores a cMsg client's information.

Version:

1.0

Author:

Carl Timmer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	clientHost Client's host.
protected cMsgMessageDeliverer	deliverer Object for delivering messages to this client.
protected java.lang.String	description Client supplied description.
protected java.lang.String	domainHost Domain server's host.
protected int	domainPort Domain server's TCP port.
protected int	domainUdpPort Domain server's UDP port.
protected java.lang.String	dottedDecimalAddr Client's address in dotted decimal form.
protected boolean	isServer Is this client another cMsg server?
protected java.nio.channels.SocketChannel	messageChannel Socket channel used to get messages to and receive messages/requests from client.
protected int	multicastPort If this client is a cMsg server, this quantity is the UDP multicast port of the server which has just become a client of cMsg server where this object lives.
protected java.lang.String	name Client's name.
protected java.lang.String	namespace cMsg subdomain namespace client is using.
protected int	serverPort If this client is a cMsg server, this quantity is the TCP listening port of the server which has just become a client of cMsg server where this object lives.
protected java.lang.String	subdomain Subdomain client wishes to use.
protected java.lang.String	UDL Client supplied UDL.
protected java.lang.String	UDLremainder Remainder from client's UDL.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientHost() Gets host client is running on.
cMsgMessageDeliverer	getDeliverer() Gets the object used to deliver messages to this client.
java.lang.String	getDescription() Gets client's description.
java.lang.String	getDomainHost() Gets host domain server is running on.
int	getDomainPort() Gets TCP port domain server is listening on.
int	getDomainUdpPort() Gets UDP port domain server is listening on.
java.lang.String	getDottedDecimalAddr() Gets client's address in dotted decimal form.
java.nio.channels.SocketChannel	getMessageChannel() Gets the SocketChannel used to send messages to and receives messages/requests from this client.
java.net.InetSocketAddress	getMessageChannelRemoteSocketAddress() Gets the InetAddress object of the client end of the socket the client uses for sending/receiving messages to/from server.
java.lang.String	getName() Gets client's name.
java.lang.String	getNamespace() Gets the namespace of client's cMsg subdomain.
java.lang.String	getServerHost() Gets host connecting name server (client of this server) is running on.
int	getServerMulticastPort() Gets the UDP multicasting port the connecting name server (client of this server) is listening on.
int	getServerPort() Gets the TCP port the connecting name server (client of this server) is listening on.
java.lang.String	getSubdomain() Gets subdomain client is using.
java.lang.String	getUDL() Gets client's UDL.
java.lang.String	getUDLremainder() Gets remainder of the UDL the client used to connect to the domain server.
boolean	isServer() States whether this client is a cMsg server or not.
void	setDeliverer(cMsgMessageDeliverer deliverer) Sets the object used to deliver messages to this client.
void	setDomainHost(java.lang.String domainHost) Sets host domain server is running on.
void	setDomainPort(int domainPort) Sets TCP port domain server is listening on.
void	setDomainUdpPort(int domainUdpPort) Sets UDP port domain server is listening on.
void	setMessageChannel(java.nio.channels.SocketChannel messageChannel) Sets the SocketChannel used to send messages to and receives messages/requests from this client.
void	setNamespace(java.lang.String namespace) Sets the namespace of client's cMsg subdomain.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

Client's name.

dottedDecimalAddr

protected java.lang.String dottedDecimalAddr

Client's address in dotted decimal form.

description

protected java.lang.String description

Client supplied description.

UDL

protected java.lang.String UDL

Client supplied UDL.

UDLremainder

protected java.lang.String UDLremainder

Remainder from client's UDL.

subdomain

protected java.lang.String subdomain

Subdomain client wishes to use.

namespace

protected java.lang.String namespace

cMsg subdomain namespace client is using.

clientHost

protected java.lang.String clientHost

Client's host.

domainHost

protected java.lang.String domainHost

Domain server's host.

domainPort

protected int domainPort

Domain server's TCP port.

domainUdpPort

protected int domainUdpPort

Domain server's UDP port.

isServer

protected boolean isServer

Is this client another cMsg server?

serverPort

protected int serverPort

If this client is a cMsg server, this quantity is the TCP listening port of the server which has just become a client of cMsg server where this object lives. (I hope you got that).

multicastPort

protected int multicastPort

If this client is a cMsg server, this quantity is the UDP multicast port of the server which has just become a client of cMsg server where this object lives. (I hope you got that).

messageChannel

protected java.nio.channels.SocketChannel messageChannel

Socket channel used to get messages to and receive messages/requests from client.

deliverer

protected cMsgMessageDeliverer deliverer

Object for delivering messages to this client.

Constructor Detail

cMsgClientInfo

public cMsgClientInfo()

Default constructor.

cMsgClientInfo

public cMsgClientInfo(java.lang.String name,
                      int nsPort,
                      int dPort,
                      java.lang.String host,
                      java.lang.String dotDec,
                      java.lang.String subdomain,
                      java.lang.String UDLRemainder,
                      java.lang.String UDL,
                      java.lang.String description)

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

Parameters:

name - client's name

dotDec - client's address in dotted decimal form

nsPort - name server's listening port

dPort - domain server's listening port

host - client's host

subdomain - client's subdomain

UDLRemainder - client's UDL's remainder

UDL - client's UDL

description - client's description

cMsgClientInfo

public cMsgClientInfo(java.lang.String name,
                      int nsPort,
                      int mPort,
                      java.lang.String host)

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 - client's name

nsPort - name server's TCP listening port

mPort - name server's UDP multicast listening port

host - client's host

Method Detail

getName

public java.lang.String getName()

Gets client's name.

Returns:

client's name

getDottedDecimalAddr

public java.lang.String getDottedDecimalAddr()

Gets client's address in dotted decimal form.

Returns:

client's address in dotted decimal form

getDescription

public java.lang.String getDescription()

Gets client's description.

Returns:

client's description

getUDL

public java.lang.String getUDL()

Gets client's UDL.

Returns:

client's UDL

getUDLremainder

public java.lang.String getUDLremainder()

Gets remainder of the UDL the client used to connect to the domain server.

Returns:

remainder of the UDL

getSubdomain

public java.lang.String getSubdomain()

Gets subdomain client is using.

Returns:

subdomain client is using

getNamespace

public java.lang.String getNamespace()

Gets the namespace of client's cMsg subdomain.

Returns:

namespace of client's cMsg subdomain

setNamespace

public void setNamespace(java.lang.String namespace)

Sets the namespace of client's cMsg subdomain.

Parameters:

namespace - namespace of client's cMsg subdomain

getClientHost

public java.lang.String getClientHost()

Gets host client is running on.

Returns:

host client is running on

getDomainHost

public java.lang.String getDomainHost()

Gets host domain server is running on.

Returns:

host domain server is running on

setDomainHost

public void setDomainHost(java.lang.String domainHost)

Sets host domain server is running on.

Parameters:

domainHost - host domain server is running on

getDomainPort

public int getDomainPort()

Gets TCP port domain server is listening on.

Returns:

TCP port domain server is listening on

setDomainPort

public void setDomainPort(int domainPort)

Sets TCP port domain server is listening on.

Parameters:

domainPort - TCP port domain server is listening on

getDomainUdpPort

public int getDomainUdpPort()

Gets UDP port domain server is listening on. Meaningful only if client is sending by UDP.

Returns:

UDP port domain server is listening on

setDomainUdpPort

public void setDomainUdpPort(int domainUdpPort)

Sets UDP port domain server is listening on. Meaningful only if client is sending by UDP.

Parameters:

domainUdpPort - TCP port domain server is listening on

getServerHost

public java.lang.String getServerHost()

Gets host connecting name server (client of this server) is running on.

Returns:

host connecting name server is running on

getServerPort

public int getServerPort()

Gets the TCP port the connecting name server (client of this server) is listening on.

Returns:

TCP port connecting name server is listening on

getServerMulticastPort

public int getServerMulticastPort()

Gets the UDP multicasting port the connecting name server (client of this server) is listening on.

Returns:

TCP port connecting name server is listening on

isServer

public boolean isServer()

States whether this client is a cMsg server or not.

Returns:

true if this client is a cMsg server

getMessageChannel

public java.nio.channels.SocketChannel getMessageChannel()

Gets the SocketChannel used to send messages to and receives messages/requests from this client.

Returns:

the SocketChannel used to send messages to and receives messages/requests from this client

setMessageChannel

public void setMessageChannel(java.nio.channels.SocketChannel messageChannel)

Sets the SocketChannel used to send messages to and receives messages/requests from this client.

Parameters:

messageChannel - the SocketChannel used to send messages to and receives messages/requests from this client

getMessageChannelRemoteSocketAddress

public java.net.InetSocketAddress getMessageChannelRemoteSocketAddress()

Gets the InetAddress object of the client end of the socket the client uses for sending/receiving messages to/from server.

Returns:

InetAddress object of the client end of the socket the client uses for sending/receiving messages to/from server

getDeliverer

public cMsgMessageDeliverer getDeliverer()

Gets the object used to deliver messages to this client.

Returns:

object used to deliver messages to this client

setDeliverer

public void setDeliverer(cMsgMessageDeliverer deliverer)

Sets the object used to deliver messages to this client.

Parameters:

deliverer - object used to deliver messages to this client