org.jlab.coda.et

Class EtSystemOpenConfig

java.lang.Object

org.jlab.coda.et.EtSystemOpenConfig

public class EtSystemOpenConfig
extends java.lang.Object

This class defines a set of configuration parameters used to open an ET system.

Author:

Carl Timmer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	broadcastIP Broadcast address.

Constructor Summary

Constructors

Constructor and Description
EtSystemOpenConfig() No arg constructor.
EtSystemOpenConfig(EtSystemOpenConfig config) Constructor to create a new EtSystemOpenConfig object from another.
EtSystemOpenConfig(java.lang.String etName, int uPort, java.lang.String hostName) Constructor for broadcasting on all subnets.
EtSystemOpenConfig(java.lang.String etName, int uPort, java.lang.String hostName, java.util.Collection<java.lang.String> bAddrs) Constructor for broadcasting on given subnets.
EtSystemOpenConfig(java.lang.String etName, java.lang.String hostName) Constructor for broadcasting on all subnets.
EtSystemOpenConfig(java.lang.String etName, java.lang.String hostName, java.util.Collection<java.lang.String> bAddrs, java.util.Collection<java.lang.String> mAddrs, boolean remoteOnly, int method, int tPort, int uPort, int mPort, int ttlNum, int policy) Most general constructor for creating a new EtSystemOpenConfig object.
EtSystemOpenConfig(java.lang.String etName, java.lang.String hostName, java.util.Collection<java.lang.String> mAddrs, int mPort, int ttlNum) Constructor for multicasting.
EtSystemOpenConfig(java.lang.String etName, java.lang.String hostName, java.util.Collection<java.lang.String> mAddrs, int uPort, int mPort, int ttlNum) Constructor for multicasting.
EtSystemOpenConfig(java.lang.String etName, java.lang.String hostName, int tPort) Constructor for connecting directly to tcp server.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBroadcastAddr(java.lang.String addr) Adds a broadcast address to the set.
void	addMulticastAddr(java.lang.String addr) Adds a multicast address to the set.
void	broadcasting(boolean on) Set true if we're broadcasting to find ET system.
java.util.HashSet<java.lang.String>	getBroadcastAddrs() Gets multicast addresses.
java.lang.String	getEtName() Gets the ET system name.
java.lang.String	getHost() Gets the ET system host name or general location of ET system.
java.util.HashSet<java.lang.String>	getMulticastAddrs() Gets multicast addresses.
int	getMulticastPort() Gets port number to multicast to.
int	getNetworkContactMethod() Gets the means used to contact an ET system.
java.lang.String	getNetworkInterface() Get the network interface used for connecting to the ET system.
int	getNumMulticastAddrs() Gets the number of multicast addresses.
int	getResponsePolicy() Gets policy on what to do about multiple responding ET systems to a broadcast or multicast.
int	getTcpPort() Gets TCP server port number of the ET system.
int	getTcpRecvBufSize() Get the TCP send buffer size in bytes.
int	getTcpSendBufSize() Get the TCP receive buffer size in bytes.
int	getTTL() Gets time-to-live value for multicasting.
int	getUdpPort() Gets UDP port number for broadcasting or sending udp packets to known hosts.
long	getWaitTime() If no ET system is available, the number of milliseconds we wait while trying to open it.
boolean	isBroadcasting() Are we broadcasting to find ET system?
boolean	isConnectRemotely() Are we going to connect to an ET system remotely only (=true), or will we also try to use memory mapping and JNI with local C-based ET systems?
boolean	isNoDelay() Get the TCP no-delay setting.
void	removeMulticastAddr(java.lang.String addr) Removes a multicast address from the set.
boolean	selfConsistent() Determine if vital parameters are set and all settings are self consistent.
void	setBroadcastAddrs(java.util.Collection<java.lang.String> addrs) Sets the collection of broadcast addresses.
void	setConnectRemotely(boolean connectRemotely) Sets whether we going to connect to an ET system remotely only (=true), or whether we will try to use memory mapping and JNI with local C-based ET systems.
void	setEtName(java.lang.String etName) Sets the ET system name.
void	setHost(java.lang.String hostName) Sets the ET system host name or broad/multicast destination.
void	setMulticastAddrs(java.util.Collection<java.lang.String> addrs) Sets the collection of multicast addresses.
void	setMulticastPort(int port) Sets the port number to multicast to.
void	setNetworkContactMethod(int method) Sets the means or method of contacting an ET system.
void	setNetworkInterface(java.lang.String networkInterface) Set the network interface (in dotted-decimal format) used for connecting to the ET system.
void	setNoDelay(boolean noDelay) Set the TCP no-delay setting.
void	setResponsePolicy(int policy) Sets the policy on what to do about multiple responding ET systems to a broadcast or multicast.
void	setTcpPort(int port) Sets the TCP server port number of the ET system.
void	setTcpRecvBufSize(int tcpRecvBufSize) Set the TCP receive buffer size in bytes.
void	setTcpSendBufSize(int tcpSendBufSize) Set the TCP send buffer size in bytes.
void	setTTL(int ttlNum) Sets the time-to-live value for multicasting.
void	setUdpPort(int port) Sets the UDP port number for broadcasting and sending udp packets to known hosts.
void	setWaitTime(long waitTime) If no ET system is available, set the number of milliseconds we wait while trying to open it.
java.lang.String	toString() Method to create a string representation of this object

Methods inherited from class java.lang.Object

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

Field Detail

broadcastIP

public static final java.lang.String broadcastIP

Broadcast address.

See Also:

Constant Field Values

Constructor Detail

EtSystemOpenConfig

public EtSystemOpenConfig()

No arg constructor. Will broadcast to local subnet addresses, but ET name and host need to be set explicitly.

EtSystemOpenConfig

public EtSystemOpenConfig(java.lang.String etName,
                  java.lang.String hostName,
                  java.util.Collection<java.lang.String> bAddrs,
                  java.util.Collection<java.lang.String> mAddrs,
                  boolean remoteOnly,
                  int method,
                  int tPort,
                  int uPort,
                  int mPort,
                  int ttlNum,
                  int policy)
                   throws org.jlab.coda.et.exception.EtException

Most general constructor for creating a new EtSystemOpenConfig object.

Parameters:

etName - ET system name

hostName - may open an ET system on the given host which could be the: 1) actual ET system's host name, 2) dotted decimal address of ET system's host, or 3) general location of ET system such as EtConstants.hostAnywhere, EtConstants.hostLocal, or EtConstants.hostRemote

bAddrs - collection of broadcast addresses (as Strings) to broadcast on in order to find ET system. If = null, set to list of all local subnets' broadcast addresses.

mAddrs - collection of multicast addresses (as Strings) to multicast to in order to find ET system. If = null, set to default which is a list containing only EtConstants.multicastAddr = 239.200.0.0.

remoteOnly - true if talking to ET system only through sockets (as if remote), or false if also using JNI/shared memory for talking to local C-based ET systems

method - means used to contact an ET system over the network: EtConstants.broadcast, EtConstants.multicast, EtConstants.direct, or EtConstants.broadAndMulticast

tPort - TCP server port number of the ET system. If = 0, set to default which is EtConstants.serverPort = 11111.

uPort - UDP port number for broadcasting or sending udp packets to known hosts. If = 0, set to default which is EtConstants.broadcastPort = 11111.

mPort - Port number to multicast to. If = 0, set to default which is EtConstants.multicastPort = 11112.

ttlNum - Time-to_live value for multicasting. If = 0, set to default which is 32.

policy - policy on what to do about multiple responding ET systems to a broadcast or multicast: EtConstants.policyFirst, EtConstants.policyLocal, or EtConstants.policyError

Throws:

org.jlab.coda.et.exception.EtException - if null, blank, or too-long etName; if null or blank hostName; if method value is not valid; if method is direct and no actual host name was specified; if port numbers are < 1024 or > 65535 (except if = 0 which uses default value); if ttl is < 0 or > 254; if policy value is not valid

EtSystemOpenConfig

public EtSystemOpenConfig(java.lang.String etName,
                  java.lang.String hostName)
                   throws org.jlab.coda.et.exception.EtException

Constructor for broadcasting on all subnets. First responder is chosen.

Parameters:

etName - ET system name

hostName - may open an ET system on the given host which could be the: 1) actual ET system's host name, 2) dotted decimal address of ET system's host, or 3) general location of ET system such as EtConstants.hostAnywhere, EtConstants.hostLocal, or EtConstants.hostRemote

Throws:

org.jlab.coda.et.exception.EtException - if args are null or blank;

EtSystemOpenConfig

public EtSystemOpenConfig(java.lang.String etName,
                  int uPort,
                  java.lang.String hostName)
                   throws org.jlab.coda.et.exception.EtException

Constructor for broadcasting on all subnets. First responder is chosen.

Parameters:

etName - ET system name

uPort - UDP port number to broadcasting to. If = 0, set to default which is EtConstants.broadcastPort = 11111.

hostName - may open an ET system on the given host which could be the: 1) actual ET system's host name, 2) dotted decimal address of ET system's host, or 3) general location of ET system such as EtConstants.hostAnywhere, EtConstants.hostLocal, or EtConstants.hostRemote

Throws:

org.jlab.coda.et.exception.EtException - if no broadcast addresses were specified; if port number is < 1024 or > 65535

EtSystemOpenConfig

public EtSystemOpenConfig(java.lang.String etName,
                  int uPort,
                  java.lang.String hostName,
                  java.util.Collection<java.lang.String> bAddrs)
                   throws org.jlab.coda.et.exception.EtException

Constructor for broadcasting on given subnets. First responder is chosen.

Parameters:

etName - ET system name

uPort - UDP port number to broadcasting to. If = 0, set to default which is EtConstants.broadcastPort = 11111.

hostName - may open an ET system on the given host which could be the: 1) actual ET system's host name, 2) dotted decimal address of ET system's host, or 3) general location of ET system such as EtConstants.hostAnywhere, EtConstants.hostLocal, or EtConstants.hostRemote

bAddrs - collection of broadcast addresses (as Strings) to broadcast on in order to find ET system. If = null, set to list of all local subnets' broadcast addresses.

Throws:

org.jlab.coda.et.exception.EtException - if no broadcast addresses were specified; if port number is < 1024 or > 65535

EtSystemOpenConfig

public EtSystemOpenConfig(java.lang.String etName,
                  java.lang.String hostName,
                  java.util.Collection<java.lang.String> mAddrs,
                  int mPort,
                  int ttlNum)
                   throws org.jlab.coda.et.exception.EtException

Constructor for multicasting. First responder is chosen.

Parameters:

etName - ET system name

hostName - may open an ET system on the given host which could be the: 1) actual ET system's host name, 2) dotted decimal address of ET system's host, or 3) general location of ET system such as EtConstants.hostAnywhere, EtConstants.hostLocal, or EtConstants.hostRemote

mAddrs - collection of multicast addresses (as Strings) to multicast to in order to find ET system. If = null, set to default which is a list containing only EtConstants.multicastAddr = 239.200.0.0.

mPort - Port number to multicast to. If = 0, set to default which is EtConstants.multicastPort = 11112.

ttlNum - Time-to_live value for multicasting. If = 0, set to default which is 32.

Throws:

org.jlab.coda.et.exception.EtException - if no multicast addresses were specified; if port number is < 1024 or > 65535; if ttl is < 0 or > 254

EtSystemOpenConfig

public EtSystemOpenConfig(java.lang.String etName,
                  java.lang.String hostName,
                  java.util.Collection<java.lang.String> mAddrs,
                  int uPort,
                  int mPort,
                  int ttlNum)
                   throws org.jlab.coda.et.exception.EtException

Constructor for multicasting. First responder is chosen.

Parameters:

etName - ET system name

hostName - may open an ET system on the given host which could be the: 1) actual ET system's host name, 2) dotted decimal address of ET system's host, or 3) general location of ET system such as EtConstants.hostAnywhere, EtConstants.hostLocal, or EtConstants.hostRemote

mAddrs - collection of multicast addresses (as Strings) to multicast to in order to find ET system. If = null, set to default which is a list containing only EtConstants.multicastAddr = 239.200.0.0.

uPort - UDP port number for broadcasting or sending udp packets to known hosts. If = 0, set to default which is EtConstants.broadcastPort = 11111.

mPort - Port number to multicast to. If = 0, set to default which is EtConstants.multicastPort = 11112.

ttlNum - Time-to_live value for multicasting. If = 0, set to default which is 32.

Throws:

org.jlab.coda.et.exception.EtException - if no multicast addresses were specified; if port numbers are < 1024 or > 65535, or ttl is < 0 or > 254

EtSystemOpenConfig

public EtSystemOpenConfig(java.lang.String etName,
                  java.lang.String hostName,
                  int tPort)
                   throws org.jlab.coda.et.exception.EtException

Constructor for connecting directly to tcp server. First responder is chosen.

Parameters:

etName - ET system name

hostName - ET system host name

tPort - TCP server port number of the ET system. If = 0, set to default which is EtConstants.serverPort = 11111.

Throws:

org.jlab.coda.et.exception.EtException - if no actual host name was specified; if port number is < 1024 or > 65535

EtSystemOpenConfig

public EtSystemOpenConfig(EtSystemOpenConfig config)

Constructor to create a new EtSystemOpenConfig object from another.

Parameters:

config - EtSystemOpenConfig object from which to create a new configuration

Method Detail

toString

public java.lang.String toString()

Method to create a string representation of this object

Overrides:

toString in class java.lang.Object

Returns:

string representation of this object

selfConsistent

public boolean selfConsistent()

Determine if vital parameters are set and all settings are self consistent.

Returns:

true if setting are self consistent, else false

getEtName

public java.lang.String getEtName()

Gets the ET system name.

Returns:

ET system name

getHost

public java.lang.String getHost()

Gets the ET system host name or general location of ET system.

Returns:

ET system host name or general location of ET system

getBroadcastAddrs

public java.util.HashSet<java.lang.String> getBroadcastAddrs()

Gets multicast addresses.

Returns:

multicast addresses

getMulticastAddrs

public java.util.HashSet<java.lang.String> getMulticastAddrs()

Gets multicast addresses.

Returns:

multicast addresses

getNetworkContactMethod

public int getNetworkContactMethod()

Gets the means used to contact an ET system.

Returns:

means used to contact an ET system

getResponsePolicy

public int getResponsePolicy()

Gets policy on what to do about multiple responding ET systems to a broadcast or multicast.

Returns:

policy on what to do about multiple responding ET systems to a broadcast or multicast

getUdpPort

public int getUdpPort()

Gets UDP port number for broadcasting or sending udp packets to known hosts.

Returns:

UDP port number for broadcast or sending udp packets to known hosts

getTcpPort

public int getTcpPort()

Gets TCP server port number of the ET system.

Returns:

TCP server port number of the ET system

getMulticastPort

public int getMulticastPort()

Gets port number to multicast to.

Returns:

port number to multicast to

getTTL

public int getTTL()

Gets time-to-live value for multicasting.

Returns:

time-to-live value for multicasting

getNumMulticastAddrs

public int getNumMulticastAddrs()

Gets the number of multicast addresses.

Returns:

the number of multicast addresses

isBroadcasting

public boolean isBroadcasting()

Are we broadcasting to find ET system?

Returns:

boolean indicating wether we are broadcasting to find ET system

broadcasting

public void broadcasting(boolean on)

Set true if we're broadcasting to find ET system.

isConnectRemotely

public boolean isConnectRemotely()

Are we going to connect to an ET system remotely only (=true), or will we also try to use memory mapping and JNI with local C-based ET systems?

Returns:

true if connecting to ET system remotely only, else false

getWaitTime

public long getWaitTime()

If no ET system is available, the number of milliseconds we wait while trying to open it.

Returns:

the number of milliseconds we wait while trying to open ET system

getNetworkInterface

public java.lang.String getNetworkInterface()

Get the network interface used for connecting to the ET system.

Returns:

the network interface used for connecting to the ET system or null if none specified.

getTcpSendBufSize

public int getTcpSendBufSize()

Get the TCP receive buffer size in bytes.

Returns:

TCP receive buffer size in bytes

getTcpRecvBufSize

public int getTcpRecvBufSize()

Get the TCP send buffer size in bytes.

Returns:

TCP send buffer size in bytes

isNoDelay

public boolean isNoDelay()

Get the TCP no-delay setting.

Returns:

TCP no-delay setting

setEtName

public void setEtName(java.lang.String etName)

Sets the ET system name.

Parameters:

etName - ET system name

setHost

public void setHost(java.lang.String hostName)

Sets the ET system host name or broad/multicast destination. May be dotted decimal format. May also be EtConstants.hostAnywhere, EtConstants.hostLocal/"localhost", or EtConstants.hostRemote.

Parameters:

hostName - system host name or broad/multicast destination

removeMulticastAddr

public void removeMulticastAddr(java.lang.String addr)

Removes a multicast address from the set.

Parameters:

addr - multicast address to be removed

setConnectRemotely

public void setConnectRemotely(boolean connectRemotely)

Sets whether we going to connect to an ET system remotely only (=true), or whether we will try to use memory mapping and JNI with local C-based ET systems.

Parameters:

connectRemotely - true if connecting to ET system remotely only, else false

setWaitTime

public void setWaitTime(long waitTime)

If no ET system is available, set the number of milliseconds we wait while trying to open it.

Parameters:

waitTime - the number of milliseconds we wait while trying to open ET system

addBroadcastAddr

public void addBroadcastAddr(java.lang.String addr)
                      throws org.jlab.coda.et.exception.EtException

Adds a broadcast address to the set.

Parameters:

addr - broadcast address to be added

Throws:

org.jlab.coda.et.exception.EtException - if the address is not a broadcast address

setBroadcastAddrs

public void setBroadcastAddrs(java.util.Collection<java.lang.String> addrs)
                       throws org.jlab.coda.et.exception.EtException

Sets the collection of broadcast addresses.

Parameters:

addrs - collection of broadcast addresses (as Strings) or null

Throws:

org.jlab.coda.et.exception.EtException - if one of the addresses is not a broadcast address

addMulticastAddr

public void addMulticastAddr(java.lang.String addr)
                      throws org.jlab.coda.et.exception.EtException

Adds a multicast address to the set.

Parameters:

addr - multicast address to be added

Throws:

org.jlab.coda.et.exception.EtException - if the address is not a multicast address

setMulticastAddrs

public void setMulticastAddrs(java.util.Collection<java.lang.String> addrs)
                       throws org.jlab.coda.et.exception.EtException

Sets the collection of multicast addresses.

Parameters:

addrs - collection of multicast addresses (as Strings) or null

Throws:

org.jlab.coda.et.exception.EtException - if one of the addresses is not a multicast address

setNetworkContactMethod

public void setNetworkContactMethod(int method)
                             throws org.jlab.coda.et.exception.EtException

Sets the means or method of contacting an ET system. Its values may be EtConstants.broadcast for broadcasting, EtConstants.multicast for multicasting, EtConstants.direct for connecting directly to the ET tcp server, and EtConstants.broadAndMulticast for using both broadcasting and multicasting.

Parameters:

method - means or method of contacting an ET system

Throws:

org.jlab.coda.et.exception.EtException - if the argument has a bad value

setResponsePolicy

public void setResponsePolicy(int policy)
                       throws org.jlab.coda.et.exception.EtException

Sets the policy on what to do about multiple responding ET systems to a broadcast or multicast. The possible values are EtConstants.policyFirst which chooses the first ET system to respond, EtConstants.policyLocal which chooses the first local ET system to respond and if none then the first response, or EtConstants.policyError which throws an EtTooManyException exception.

Parameters:

policy - policy on what to do about multiple responding ET systems

Throws:

org.jlab.coda.et.exception.EtException - if the argument has a bad value or if the policy says to choose a local ET system but the host is set to chose a remote system.

setUdpPort

public void setUdpPort(int port)
                throws org.jlab.coda.et.exception.EtException

Sets the UDP port number for broadcasting and sending udp packets to known hosts.

Parameters:

port - UDP port number for broadcasting and sending udp packets to known hosts; set to 0 for default = EtConstants.broadcastPort.

Throws:

org.jlab.coda.et.exception.EtException - if the port number is < 1024 or > 65535

setTcpPort

public void setTcpPort(int port)
                throws org.jlab.coda.et.exception.EtException

Sets the TCP server port number of the ET system.

Parameters:

port - TCP server port number of the ET system; set to 0 for default = EtConstants.serverPort.

Throws:

org.jlab.coda.et.exception.EtException - if the port number is < 1024 or > 65535

setMulticastPort

public void setMulticastPort(int port)
                      throws org.jlab.coda.et.exception.EtException

Sets the port number to multicast to.

Parameters:

port - port number to multicast to; set to 0 for default = EtConstants.multicastPort.

Throws:

org.jlab.coda.et.exception.EtException - if the port number is < 1024 or > 65535

setTTL

public void setTTL(int ttlNum)
            throws org.jlab.coda.et.exception.EtException

Sets the time-to-live value for multicasting.

Parameters:

ttlNum - time-to-live value for multicasting (-1 < ttl < 255); set to 0 for default = EtConstants.multicastTTL.

Throws:

org.jlab.coda.et.exception.EtException - if the port number is < 0 or > 254

setNetworkInterface

public void setNetworkInterface(java.lang.String networkInterface)
                         throws org.jlab.coda.et.exception.EtException

Set the network interface (in dotted-decimal format) used for connecting to the ET system. The interface may be specified by giving a specific IP address or a broadcast (subnet) address. If it is a broadcast address, it will convert that to the specific IP associated with it in other parts of the code.

Parameters:

networkInterface - the network interface used for connecting to the ET system, or null if none specified. Address may be either a specific or broadcast IP dotted-decimal.

Throws:

org.jlab.coda.et.exception.EtException - if the interface is not in dotted-decimal format or is an invalid IP address.

setTcpSendBufSize

public void setTcpSendBufSize(int tcpSendBufSize)
                       throws org.jlab.coda.et.exception.EtException

Set the TCP send buffer size in bytes. A value of 0 means use the operating system default.

Parameters:

tcpSendBufSize - TCP send buffer size in bytes

Throws:

org.jlab.coda.et.exception.EtException - if the argument is less than 0

setTcpRecvBufSize

public void setTcpRecvBufSize(int tcpRecvBufSize)
                       throws org.jlab.coda.et.exception.EtException

Set the TCP receive buffer size in bytes. A value of 0 means use the operating system default.

Parameters:

tcpRecvBufSize - TCP receive buffer size in bytes

Throws:

org.jlab.coda.et.exception.EtException - if the argument is less than 0

setNoDelay

public void setNoDelay(boolean noDelay)

Set the TCP no-delay setting. It is off by default.

Parameters:

noDelay - TCP no-delay setting