org.jlab.coda.cMsg.common

Class cMsgServerFinder

java.lang.Object

org.jlab.coda.cMsg.common.cMsgServerFinder

public class cMsgServerFinder
extends java.lang.Object

This class finds cMsg domain name servers and rc domain multicast servers which are listening on UDP sockets. By convention, all cMsg name servers should have a multicast port starting at 45000 and not exceeding 45099. All these ports will be probed for servers. By convention, all rc multicast servers should have a multicast port starting at 45200 and not exceeding 45299. Twenty of these ports will be probed for servers. Additional ports may be specified.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	cMsgServerFinder.cMsgFinder Class to find cmsg name servers.
(package private) class	cMsgServerFinder.cMsgMulticaster This class defines a thread to multicast a single UDP packet to cmsg name servers.
(package private) class	cMsgServerFinder.cMsgMulticastReceiver This class gets any response to our UDP multicast to cmsg name servers.
(package private) class	cMsgServerFinder.rcFinder Class to find rc multicast servers.
(package private) class	cMsgServerFinder.rcMulticaster This class defines a thread to multicast a single UDP packet to rc multicast servers.
(package private) class	cMsgServerFinder.rcMulticastReceiver This class gets any response to our UDP multicast to rc multicast servers.
(package private) class	cMsgServerFinder.ResponderInfo Class to store info from a multicast responder.

Constructor Summary

Constructors

Constructor and Description
cMsgServerFinder() Constructor.
cMsgServerFinder(int debug) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addCmsgPort(int port) Add a UDP port to the user-specified list of ports to be probed for cmsg name servers.
void	addCmsgPorts(java.util.Collection<java.lang.Integer> col) Add a collection of UDP ports to the list of user-specified ports to be probed for cmsg name servers.
void	addRcPort(int port) Add a UDP port to the list of ports to be probed for rc multicast servers.
void	addRcPorts(java.util.Collection<java.lang.Integer> col) Add a collection of UDP ports to the list of ports to be probed for rc multicast servers.
void	find() Find all reachable cmsg name servers and rc multicast servers by multicasting.
void	findCmsgServers() Find all reachable cmsg name servers by multicasting.
void	findRcServers() Find all reachable rc multicast servers by multicasting.
cMsgMessage[]	getCmsgServers() Return an array of cMsg messages contains payload items of the cmsg name servers information found in the last search.
java.lang.String	getCmsgServersXML() Return a string in XML format of the cmsg name servers found in the last search.
java.lang.String	getPassword() Get the password for connecting to a cmsg name server.
cMsgMessage[]	getRcServers() Return an array of cMsg messages contains payload items of the rc multicast servers information found in the last search.
java.lang.String	getRcServersXML() Return a string in XML format of the rc multicast servers found in the last search.
int	getSleepTime() Get the time to wait for server responses in milliseconds.
boolean	needsUpdate() Tells caller if find() needs to be called since the server search parameters (eg.
void	print() Print out the cmsg name servers and rc multicast servers found in the last search.
void	removeCmsgPort(int port) Remove a user-specified UDP port from the list of ports to be probed for cmsg name servers.
void	removeCmsgPorts() Remove all user-specified UDP ports from list of ports to be probed for cmsg name servers.
void	removeRcPort(int port) Remove a UDP port from the list of user-specified ports to be probed for rc multicast servers.
void	removeRcPorts() Remove all user-specified UDP ports from list of ports to be probed for rc multicast servers.
(package private) void	setDebug(int debug) Set level of debug output.
void	setPassword(java.lang.String password) Set the password for connecting to a cmsg name server.
void	setSleepTime(int sleepTime) Set the time to wait for server responses in milliseconds.
java.lang.String	toString() Return a string in XML format of the cmsg name servers and rc multicast servers found in the last search.

Methods inherited from class java.lang.Object

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

Constructor Detail

cMsgServerFinder

public cMsgServerFinder()

Constructor.

cMsgServerFinder

public cMsgServerFinder(int debug)

Constructor.

Parameters:

debug - level of debug output

Method Detail

getSleepTime

public int getSleepTime()

Get the time to wait for server responses in milliseconds. Defaults to 3 seconds.

Returns:

time to wait for server responses in milliseconds.

setSleepTime

public void setSleepTime(int sleepTime)

Set the time to wait for server responses in milliseconds.

Parameters:

sleepTime - time to wait for server responses in milliseconds. Negative value resets to default (3 sec).

setDebug

void setDebug(int debug)

Set level of debug output. Argument may be one of:

• cMsgConstants.debugNone for no outuput

• cMsgConstants.debugSevere for severe error output

• cMsgConstants.debugError for all error output

• cMsgConstants.debugWarn for warning and error output

• cMsgConstants.debugInfo for information, warning, and error output

Parameters:

debug - level of debug output

getPassword

public java.lang.String getPassword()

Get the password for connecting to a cmsg name server. This is necessary only for a server that requires a password.

Returns:

value for password

setPassword

public void setPassword(java.lang.String password)

Set the password for connecting to a cmsg name server. Use a null string as the arg for servers requiring no password.

Parameters:

password - value to set password with

addRcPort

public void addRcPort(int port)

Add a UDP port to the list of ports to be probed for rc multicast servers.

Parameters:

port - UDP port to be probed for rc multicast servers

addRcPorts

public void addRcPorts(java.util.Collection<java.lang.Integer> col)

Add a collection of UDP ports to the list of ports to be probed for rc multicast servers.

Parameters:

col - collection of UDP ports to be probed for rc multicast servers

removeRcPort

public void removeRcPort(int port)

Remove a UDP port from the list of user-specified ports to be probed for rc multicast servers. The list of 20 default ports will still be probed regardless.

Parameters:

port - UDP port to be removed from probing for rc multicast servers

removeRcPorts

public void removeRcPorts()

Remove all user-specified UDP ports from list of ports to be probed for rc multicast servers. The list of 20 default ports will still be probed regardless.

addCmsgPort

public void addCmsgPort(int port)

Add a UDP port to the user-specified list of ports to be probed for cmsg name servers.

Parameters:

port - UDP port to be probed for cmsg name servers

addCmsgPorts

public void addCmsgPorts(java.util.Collection<java.lang.Integer> col)

Add a collection of UDP ports to the list of user-specified ports to be probed for cmsg name servers.

Parameters:

col - collection of UDP ports to be probed for cmsg name servers

removeCmsgPort

public void removeCmsgPort(int port)

Remove a user-specified UDP port from the list of ports to be probed for cmsg name servers. The list of 20 default ports will still be probed regardless.

Parameters:

port - UDP port to be removed from probing for cmsg name servers

removeCmsgPorts

public void removeCmsgPorts()

Remove all user-specified UDP ports from list of ports to be probed for cmsg name servers. The list of 20 default ports will still be probed regardless.

needsUpdate

public boolean needsUpdate()

Tells caller if find() needs to be called since the server search parameters (eg. expid, ports) have been changed or added to.

Returns:

true if "find" needs to be called again, else false

findCmsgServers

public void findCmsgServers()

Find all reachable cmsg name servers by multicasting. Follow the calling of this method with toString(), getCmsgServers(), or getCmsgServersXML() in order to see the results of the search.

findRcServers

public void findRcServers()

Find all reachable rc multicast servers by multicasting. Follow the calling of this method with toString() or getRcServers(), or getRcServersXML() in order to see the results of the search.

find

public void find()

Find all reachable cmsg name servers and rc multicast servers by multicasting. Follow the calling of this method with toString() in order to see the results of the search.

print

public void print()

Print out the cmsg name servers and rc multicast servers found in the last search.

toString

public java.lang.String toString()

Return a string in XML format of the cmsg name servers and rc multicast servers found in the last search.

Overrides:

toString in class java.lang.Object

Returns:

XML format string listing all servers found

getCmsgServersXML

public java.lang.String getCmsgServersXML()

Return a string in XML format of the cmsg name servers found in the last search.

Returns:

XML format string listing all cmsg name servers found

getRcServersXML

public java.lang.String getRcServersXML()

Return a string in XML format of the rc multicast servers found in the last search.

Returns:

XML format string listing all rc multicast servers found

getCmsgServers

public cMsgMessage[] getCmsgServers()

Return an array of cMsg messages contains payload items of the cmsg name servers information found in the last search. One message for each server.

Returns:

array of cMsg messages contains payload items of the cmsg name servers information, one message for each server

getRcServers

public cMsgMessage[] getRcServers()

Return an array of cMsg messages contains payload items of the rc multicast servers information found in the last search. One message for each server.

Returns:

array of cMsg messages contains payload items of the rc multicast servers information, one message for each server