org.jlab.coda.et

Class EtSystemOpen

java.lang.Object

org.jlab.coda.et.EtSystemOpen

public class EtSystemOpen
extends java.lang.Object

This class opens (finds and connects to) an ET system. The use of this class is hidden from the user. There is no reason to use it explicitly.

Author:

Carl Timmer

Constructor Summary

Constructors

Constructor and Description
EtSystemOpen(EtSystemOpenConfig config) Constructor which stores copy of argument.

Method Summary

Methods

Modifier and Type	Method and Description
void	connect() Creates a connection to an ET system.
void	disconnect() Disconnect from the ET system server.
java.lang.String[]	getAllHosts() Gets all host names when multiple ET systems respond.
int[]	getAllPorts() Gets all port numbers when multiple ET systems respond.
java.util.ArrayList<java.lang.String>	getBroadcastAddresses() Gets list of all the broadcast addresses (dot decimal) of the host the opened ET system is running on.
EtSystemOpenConfig	getConfig() Gets a copy of the EtSystemOpenConfig configuration object.
int	getDebug() Gets the debug output level.
int	getEndian() Gets the endian value of the opened ET system.
long	getEventSize() Gets the size of the normal events in bytes of the opened ET system.
java.lang.String	getHostAddress() Gets the address (dot decimal) of the host the opened ET system is running on.
java.util.ArrayList<java.lang.String>	getHostAddresses() Gets list of all the IP addresses (dot decimal) of the host the opened ET system is running on.
org.jlab.coda.et.EtJniAccess	getJni() Gets the object used to access native methods when using local, C-based ET system.
int	getLanguage() Gets the language used to implement the opened ET system.
java.lang.String	getName() Gets the name of the ET system (file).
int	getNumEvents() Gets the total number of events of the opened ET system.
java.util.LinkedHashMap<java.util.ArrayList<java.lang.String>[],java.lang.Integer>	getResponders() Gets a map of the hosts and ports of responding ET systems to broad/multicasts.
int	getSelectInts() Gets the number of station select integers of the opened ET system.
java.net.Socket	getSocket() Gets the socket connecting this object to the ET system.
int	getTcpPort() Gets the tcp server port number of the opened ET system.
int	getVersion() Gets the major version number of the opened ET system.
boolean	isBit64() Gets whether the operating system is 64 bit or not.
boolean	isConnected() Gets whether the ET system is connected (opened) or not.
void	setDebug(int debug) Sets the debug output level.
boolean	usingJniLibrary() Gets whether a local, C-based ET system was opened and a JNI library was used to access events directly instead of over sockets.

Methods inherited from class java.lang.Object

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

Constructor Detail

EtSystemOpen

public EtSystemOpen(EtSystemOpenConfig config)

Constructor which stores copy of argument.

Parameters:

config - EtSystemOpenConfig object

Method Detail

setDebug

public void setDebug(int debug)
              throws org.jlab.coda.et.exception.EtException

Sets the debug output level. Must be either EtConstants.debugNone, EtConstants.debugSevere, EtConstants.debugError, EtConstants.debugWarn, or EtConstants.debugInfo.

Parameters:

debug - debug level

Throws:

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

getNumEvents

public int getNumEvents()

Gets the total number of events of the opened ET system.

Returns:

total number of events

getEventSize

public long getEventSize()

Gets the size of the normal events in bytes of the opened ET system.

Returns:

size of normal events in bytes

getTcpPort

public int getTcpPort()

Gets the tcp server port number of the opened ET system.

Returns:

tcp server port number

getHostAddress

public java.lang.String getHostAddress()

Gets the address (dot decimal) of the host the opened ET system is running on.

Returns:

the address (dot decimal) of the host the opened ET system is running on

getHostAddresses

public java.util.ArrayList<java.lang.String> getHostAddresses()

Gets list of all the IP addresses (dot decimal) of the host the opened ET system is running on.

Returns:

list of all the IP addresses (dot decimal) of the host the opened ET system is running on

getBroadcastAddresses

public java.util.ArrayList<java.lang.String> getBroadcastAddresses()

Gets list of all the broadcast addresses (dot decimal) of the host the opened ET system is running on.

Returns:

list of all the broadcast addresses (dot decimal) of the host the opened ET system is running on

getName

public java.lang.String getName()

Gets the name of the ET system (file).

Returns:

ET system name

getEndian

public int getEndian()

Gets the endian value of the opened ET system.

Returns:

endian value

getVersion

public int getVersion()

Gets the major version number of the opened ET system.

Returns:

major ET version number

getLanguage

public int getLanguage()

Gets the language used to implement the opened ET system.

Returns:

language

getSelectInts

public int getSelectInts()

Gets the number of station select integers of the opened ET system.

Returns:

number of select integers

getSocket

public java.net.Socket getSocket()

Gets the socket connecting this object to the ET system.

Returns:

socket

getDebug

public int getDebug()

Gets the debug output level.

Returns:

debug output level

getConfig

public EtSystemOpenConfig getConfig()

Gets a copy of the EtSystemOpenConfig configuration object.

Returns:

copy of configuration object

isConnected

public boolean isConnected()

Gets whether the ET system is connected (opened) or not.

Returns:

status of connection to ET system

isBit64

public boolean isBit64()

Gets whether the operating system is 64 bit or not.

Returns:

true if the operating system is 64 bit, else false

getResponders

public java.util.LinkedHashMap<java.util.ArrayList<java.lang.String>[],java.lang.Integer> getResponders()

Gets a map of the hosts and ports of responding ET systems to broad/multicasts.

Returns:

a map of the hosts and ports of responding ET systems to broad/multicasts

usingJniLibrary

public boolean usingJniLibrary()

Gets whether a local, C-based ET system was opened and a JNI library was used to access events directly instead of over sockets.

Returns:

true if opening a local, C-based ET system and using JNI library to access events.

getJni

public org.jlab.coda.et.EtJniAccess getJni()

Gets the object used to access native methods when using local, C-based ET system.

getAllHosts

public java.lang.String[] getAllHosts()

Gets all host names when multiple ET systems respond.

Returns:

all host names from responding ET systems

getAllPorts

public int[] getAllPorts()

Gets all port numbers when multiple ET systems respond.

Returns:

all port numbers from responding ET systems

connect

public void connect()
             throws java.io.IOException,
                    org.jlab.coda.et.exception.EtException,
                    org.jlab.coda.et.exception.EtTooManyException

Creates a connection to an ET system.

Throws:

java.io.IOException - if problems with network communications; if the host address(es) is(are) unknown

org.jlab.coda.et.exception.EtException - if the responding ET system has the wrong name, runs a different version of ET, or has a different value for EtConstants.stationSelectInts

org.jlab.coda.et.exception.EtTooManyException - if there were more than one valid response when policy is set to EtConstants.policyError and we are looking either remotely or anywhere for the ET system.

disconnect

public void disconnect()

Disconnect from the ET system server.