org.jlab.coda.et

Class EtSystem

java.lang.Object

org.jlab.coda.et.EtSystem

public class EtSystem
extends java.lang.Object

This class implements an object which allows a user to interact with an ET system. It is not the ET system itself, but rather a proxy which communicates over the network or through JNI with the real ET system.

Author:

Carl Timmer

Constructor Summary

Constructors

Constructor and Description
EtSystem(EtSystemOpenConfig config) Construct a new EtSystem object.
EtSystem(EtSystemOpenConfig config, int debug) Construct a new EtSystem object.
EtSystem(EtSystemOpen sys, int debug) Construct a new EtSystem object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	alive() Is the ET system alive and are we connected to it?
EtAttachment	attach(EtStation station) Create an attachment to a station.
void	close() Close the ET system.
EtStation	createStation(EtStationConfig config, java.lang.String name) Creates a new station placed at the end of the ordered list of stations.
EtStation	createStation(EtStationConfig config, java.lang.String name, int position) Creates a new station at a specified position in the ordered list of stations.
EtStation	createStation(EtStationConfig config, java.lang.String name, int position, int parallelPosition) Creates a new station at a specified position in the ordered list of stations and in a specified position in an ordered list of parallel stations if it is a parallel station.
void	detach(EtAttachment att) Remove an attachment from a station.
void	dumpEvents(EtAttachment att, EtEvent[] evs) Dispose of unwanted events in an ET system.
void	dumpEvents(EtAttachment att, EtEvent[] evs, int offset, int length) Dispose of unwanted events in an ET system.
void	dumpEvents(EtAttachment att, java.util.List<EtEvent> eventList) Dispose of unwanted events in an ET system.
int	getAttachmentsMax() Gets the maximum number of attachments allowed in the ET system.
EtSystemOpenConfig	getConfig() Gets a copy of the configuration object used to specify how to open the ET system.
org.jlab.coda.et.data.AllData	getData() Gets all information about the ET system.
int	getDebug() Gets the debug output level.
EtEvent[]	getEvents(EtAttachment att, org.jlab.coda.et.enums.Mode mode, org.jlab.coda.et.enums.Modify modify, int microSec, int count) Get events from an ET system.
long	getEventSize() Gets the "normal" event size in bytes.
int	getGroupCount() Gets the number of groups events are divided into.
int[]	getGroups() Gets the array defining groups events are divided into.
int	getHeartbeat() Gets the ET system heartbeat.
int[]	getHistogram() Gets histogram containing data showing how many events in GRAND_CENTRAL's input list when new events are requested by users.
java.lang.String	getHost() Gets the ET system's host name.
java.io.DataInputStream	getInputStream() Get the data input stream to talk to ET system server.
int	getLanguage() Gets the ET system's implementation language.
int	getNumAttachments() Gets the number of attachments in the ET system.
int	getNumEvents() Gets the number of events in the ET system.
int	getNumProcesses() Gets the number of local processes in the ET system.
int	getNumStations() Gets the number of stations in the ET system.
int	getNumTemps() Gets the number of temp events in the ET system.
java.io.DataOutputStream	getOutputStream() Get the data output stream to receive from the ET system server.
int	getPid() Gets the UNIX pid of the ET system process.
int	getProcessesMax() Gets the maximum number of local processes allowed in the ET system.
int	getStationParallelPosition(EtStation station) Gets the position of a parallel station in its ordered list of parallel stations.
int	getStationPosition(EtStation station) Gets the position of a station in the ordered list of stations.
int	getStationsMax() Gets the maximum number of stations allowed in the ET system.
int	getTcpPort() Gets the tcp server port number.
int	getTempsMax() Gets the maximum number of temp events allowed in the ET system.
void	kill() Kill the ET system.
EtEvent[]	newEvents(EtAttachment att, org.jlab.coda.et.enums.Mode mode, boolean noBuffer, int microSec, int count, int size, int group) Get new (unused) events from a specified group of such events in an ET system.
EtEvent[]	newEvents(EtAttachment att, org.jlab.coda.et.enums.Mode mode, int microSec, int count, int size) Get new (unused) events from an ET system.
void	open() Open the ET system and set up buffered communication.
void	putEvents(EtAttachment att, EtEvent[] evs) Put events into an ET system.
void	putEvents(EtAttachment att, EtEvent[] evs, int offset, int length) Put events into an ET system.
void	putEvents(EtAttachment att, java.util.List<EtEvent> eventList) Put events into an ET system.
void	removeStation(EtStation station) Removes an existing station.
void	setDebug(int val) Sets the debug output level.
void	setStationPosition(EtStation station, int position, int parallelPosition) Changes the position of a station in the ordered list of stations.
boolean	stationAttached(EtStation station, EtAttachment att) Is given attachment attached to a station?
boolean	stationExists(java.lang.String name) Does given station exist?
EtStation	stationNameToObject(java.lang.String name) Gets a station's object representation from its name.
void	wakeUpAll(EtStation station) Wake up all attachments waiting to read events from a station's empty input list.
void	wakeUpAttachment(EtAttachment att) Wake up an attachment that is waiting to read events from a station's empty input list.

Methods inherited from class java.lang.Object

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

Constructor Detail

EtSystem

public EtSystem(EtSystemOpenConfig config,
        int debug)
         throws org.jlab.coda.et.exception.EtException

Construct a new EtSystem object.

Parameters:

config - EtSystemOpenConfig object to specify how to open the ET system of interest (copy is stored & used)

debug - debug level (e.g. EtConstants.debugInfo)

Throws:

org.jlab.coda.et.exception.EtException - if config is null or not self-consistent

EtSystem

public EtSystem(EtSystemOpenConfig config)
         throws org.jlab.coda.et.exception.EtException

Construct a new EtSystem object. Debug level set to print only errors.

Parameters:

config - EtSystemOpenConfig object to specify how to open the ET system of interest (copy is stored & used)

Throws:

org.jlab.coda.et.exception.EtException - if config is not self-consistent

EtSystem

public EtSystem(EtSystemOpen sys,
        int debug)
         throws java.io.IOException,
                org.jlab.coda.et.exception.EtException,
                org.jlab.coda.et.exception.EtTooManyException

Construct a new EtSystem object. Not meant for general use. Use one of the other constructors.

Parameters:

sys - EtSystemOpen object to specify a connection to the ET system of interest

debug - debug level (e.g. EtConstants.debugInfo)

Throws:

java.io.IOException - if problems with network communications

java.net.UnknownHostException - if the host address(es) is(are) unknown

org.jlab.coda.et.exception.EtException - if arg is null; 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.

Method Detail

getInputStream

public java.io.DataInputStream getInputStream()

Get the data input stream to talk to ET system server.

Returns:

data input stream to talk to ET system server

getOutputStream

public java.io.DataOutputStream getOutputStream()

Get the data output stream to receive from the ET system server.

Returns:

data output stream to receive from the ET system server

getDebug

public int getDebug()

Gets the debug output level.

Returns:

debug output level

setDebug

public void setDebug(int val)
              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:

val - debug level

Throws:

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

getConfig

public EtSystemOpenConfig getConfig()

Gets a copy of the configuration object used to specify how to open the ET system.

Returns:

copy of the configuration object used to specify how to open the ET system.

open

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

Open the ET system and set up buffered communication.

Throws:

java.io.IOException - if problems with network communications

java.net.UnknownHostException - 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.

close

public void close()

Close the ET system.

kill

public void kill()
          throws java.io.IOException,
                 org.jlab.coda.et.exception.EtClosedException

Kill the ET system.

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

alive

public boolean alive()

Is the ET system alive and are we connected to it?

Returns:

true if the ET system is alive and we're connected to it, otherwise false

wakeUpAttachment

public void wakeUpAttachment(EtAttachment att)
                      throws java.io.IOException,
                             org.jlab.coda.et.exception.EtException,
                             org.jlab.coda.et.exception.EtClosedException

Wake up an attachment that is waiting to read events from a station's empty input list.

Parameters:

att - attachment to wake up

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtException - if arg is null; if the attachment object is invalid

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

wakeUpAll

public void wakeUpAll(EtStation station)
               throws java.io.IOException,
                      org.jlab.coda.et.exception.EtException,
                      org.jlab.coda.et.exception.EtClosedException

Wake up all attachments waiting to read events from a station's empty input list.

Parameters:

station - station whose attachments are to wake up

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtException - if arg is null; if the station object is invalid

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

createStation

public EtStation createStation(EtStationConfig config,
                      java.lang.String name)
                        throws java.io.IOException,
                               org.jlab.coda.et.exception.EtDeadException,
                               org.jlab.coda.et.exception.EtClosedException,
                               org.jlab.coda.et.exception.EtException,
                               org.jlab.coda.et.exception.EtExistsException,
                               org.jlab.coda.et.exception.EtTooManyException

Creates a new station placed at the end of the ordered list of stations. If the station is added to a group of parallel stations, it is placed at the end of the list of parallel stations.

Parameters:

config - station configuration

name - station name

Returns:

new station object

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

org.jlab.coda.et.exception.EtException - if not connected to ET system; if the select method's class cannot be loaded; if the position is less than 1 (GRAND_CENTRAL's spot); if the name is GRAND_CENTRAL (already taken); if the configuration's cue size is too big; if the configuration needs a select class name if the configuration inconsistent if trying to add incompatible parallel station; if trying to add parallel station to head of existing parallel group;

org.jlab.coda.et.exception.EtExistsException - if the station already exists but with a different configuration

org.jlab.coda.et.exception.EtTooManyException - if the maximum number of stations has been created already

createStation

public EtStation createStation(EtStationConfig config,
                      java.lang.String name,
                      int position)
                        throws java.io.IOException,
                               org.jlab.coda.et.exception.EtDeadException,
                               org.jlab.coda.et.exception.EtClosedException,
                               org.jlab.coda.et.exception.EtException,
                               org.jlab.coda.et.exception.EtExistsException,
                               org.jlab.coda.et.exception.EtTooManyException

Creates a new station at a specified position in the ordered list of stations. If the station is added to a group of parallel stations, it is placed at the end of the list of parallel stations.

Parameters:

config - station configuration

name - station name

position - position in the linked list to put the station.

Returns:

new station object

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

org.jlab.coda.et.exception.EtException - if not connected to ET system; if the select method's class cannot be loaded; if the position is less than 1 (GRAND_CENTRAL's spot); if the name is GRAND_CENTRAL (already taken); if the configuration's cue size is too big; if the configuration needs a select class name if the configuration inconsistent if trying to add incompatible parallel station; if trying to add parallel station to head of existing parallel group;

org.jlab.coda.et.exception.EtExistsException - if the station already exists but with a different configuration

org.jlab.coda.et.exception.EtTooManyException - if the maximum number of stations has been created already

createStation

public EtStation createStation(EtStationConfig config,
                      java.lang.String name,
                      int position,
                      int parallelPosition)
                        throws java.io.IOException,
                               org.jlab.coda.et.exception.EtDeadException,
                               org.jlab.coda.et.exception.EtClosedException,
                               org.jlab.coda.et.exception.EtException,
                               org.jlab.coda.et.exception.EtExistsException,
                               org.jlab.coda.et.exception.EtTooManyException

Creates a new station at a specified position in the ordered list of stations and in a specified position in an ordered list of parallel stations if it is a parallel station.

Parameters:

config - station configuration

name - station name

position - position in the main list to put the station.

parallelPosition - position in the list of parallel stations to put the station.

Returns:

new station object

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

org.jlab.coda.et.exception.EtException - if arg is null; if the select method's class cannot be loaded; if the position is less than 1 (GRAND_CENTRAL's spot); if the name is GRAND_CENTRAL (already taken); if the name is too long; if the configuration's cue size is too big; if the configuration needs a select class name; if the configuration inconsistent if trying to add incompatible parallel station; if trying to add parallel station to head of existing parallel group;

org.jlab.coda.et.exception.EtExistsException - if the station already exists but with a different configuration

org.jlab.coda.et.exception.EtTooManyException - if the maximum number of stations has been created already

removeStation

public void removeStation(EtStation station)
                   throws java.io.IOException,
                          org.jlab.coda.et.exception.EtDeadException,
                          org.jlab.coda.et.exception.EtClosedException,
                          org.jlab.coda.et.exception.EtException

Removes an existing station.

Parameters:

station - station object

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

org.jlab.coda.et.exception.EtException - if arg is null; if attachments to the station still exist; if the station is GRAND_CENTRAL (which must always exist); if the station does not exist; if the station object is invalid

setStationPosition

public void setStationPosition(EtStation station,
                      int position,
                      int parallelPosition)
                        throws java.io.IOException,
                               org.jlab.coda.et.exception.EtDeadException,
                               org.jlab.coda.et.exception.EtClosedException,
                               org.jlab.coda.et.exception.EtException

Changes the position of a station in the ordered list of stations.

Parameters:

station - station object

position - position in the main station list (starting at 0)

parallelPosition - position in list of parallel stations (starting at 0)

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

org.jlab.coda.et.exception.EtException - if arg is null; if the station does not exist; if trying to move GRAND_CENTRAL; if position is < 1 (GRAND_CENTRAL is always first); if parallelPosition < 0; if station object is invalid; if trying to move an incompatible parallel station to an existing group of parallel stations or to the head of an existing group of parallel stations.

getStationPosition

public int getStationPosition(EtStation station)
                       throws java.io.IOException,
                              org.jlab.coda.et.exception.EtDeadException,
                              org.jlab.coda.et.exception.EtClosedException,
                              org.jlab.coda.et.exception.EtException

Gets the position of a station in the ordered list of stations.

Parameters:

station - station object

Returns:

position of a station in the main linked list of stations

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

org.jlab.coda.et.exception.EtException - if arg is null; if the station does not exist; if station object is invalid

getStationParallelPosition

public int getStationParallelPosition(EtStation station)
                               throws java.io.IOException,
                                      org.jlab.coda.et.exception.EtDeadException,
                                      org.jlab.coda.et.exception.EtClosedException,
                                      org.jlab.coda.et.exception.EtException

Gets the position of a parallel station in its ordered list of parallel stations.

Parameters:

station - station object

Returns:

position of a station in the linked list of stations

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

org.jlab.coda.et.exception.EtException - if arg is null; if the station does not exist; if station object is invalid

attach

public EtAttachment attach(EtStation station)
                    throws java.io.IOException,
                           org.jlab.coda.et.exception.EtDeadException,
                           org.jlab.coda.et.exception.EtClosedException,
                           org.jlab.coda.et.exception.EtException,
                           org.jlab.coda.et.exception.EtTooManyException

Create an attachment to a station.

Parameters:

station - station object

Returns:

an attachment object

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

org.jlab.coda.et.exception.EtException - if arg is null; if the station does not exist or is not in active/idle state; if station object is invalid

org.jlab.coda.et.exception.EtTooManyException - if no more attachments are allowed to the station and/or ET system

detach

public void detach(EtAttachment att)
            throws java.io.IOException,
                   org.jlab.coda.et.exception.EtDeadException,
                   org.jlab.coda.et.exception.EtClosedException,
                   org.jlab.coda.et.exception.EtException

Remove an attachment from a station.

Parameters:

att - attachment object

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

org.jlab.coda.et.exception.EtException - if arg is null; if not attached to station; if the attachment object is invalid

stationAttached

public boolean stationAttached(EtStation station,
                      EtAttachment att)
                        throws java.io.IOException,
                               org.jlab.coda.et.exception.EtDeadException,
                               org.jlab.coda.et.exception.EtClosedException,
                               org.jlab.coda.et.exception.EtException

Is given attachment attached to a station?

Parameters:

station - station object

att - attachment object

Returns:

true if an attachment is attached to a station, and false otherwise

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

org.jlab.coda.et.exception.EtException - if arg is null; if the station does not exist; if station object is invalid; if attachment object is invalid

stationExists

public boolean stationExists(java.lang.String name)
                      throws java.io.IOException,
                             org.jlab.coda.et.exception.EtDeadException,
                             org.jlab.coda.et.exception.EtClosedException,
                             org.jlab.coda.et.exception.EtException

Does given station exist?

Parameters:

name - station name

Returns:

true if a station exists, and false otherwise

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

org.jlab.coda.et.exception.EtException - if arg is null;

stationNameToObject

public EtStation stationNameToObject(java.lang.String name)
                              throws java.io.IOException,
                                     org.jlab.coda.et.exception.EtDeadException,
                                     org.jlab.coda.et.exception.EtClosedException,
                                     org.jlab.coda.et.exception.EtException

Gets a station's object representation from its name.

Parameters:

name - station name

Returns:

station object, or null if no such station exists

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

org.jlab.coda.et.exception.EtException - if arg is null;

newEvents

public EtEvent[] newEvents(EtAttachment att,
                  org.jlab.coda.et.enums.Mode mode,
                  int microSec,
                  int count,
                  int size)
                    throws org.jlab.coda.et.exception.EtException,
                           org.jlab.coda.et.exception.EtDeadException,
                           org.jlab.coda.et.exception.EtClosedException,
                           org.jlab.coda.et.exception.EtEmptyException,
                           org.jlab.coda.et.exception.EtBusyException,
                           org.jlab.coda.et.exception.EtTimeoutException,
                           org.jlab.coda.et.exception.EtWakeUpException,
                           java.io.IOException

Get new (unused) events from an ET system.

Parameters:

att - attachment object

mode - if there are no new events available, this parameter specifies whether to wait for some by sleeping Mode.SLEEP, to wait for a set time Mode.TIMED, or to return immediately Mode.ASYNC.

microSec - the number of microseconds to wait if a timed wait is specified

count - the number of events desired

size - the size of events in bytes

Returns:

an array of new events obtained from ET system. Count may be different from that requested.

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtException - if not connected to ET system; if arguments have bad values; if attachment object is invalid; for other general errors

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

org.jlab.coda.et.exception.EtEmptyException - if the mode is asynchronous and the station's input list is empty

org.jlab.coda.et.exception.EtBusyException - if the mode is asynchronous and the station's input list is being used (the mutex is locked)

org.jlab.coda.et.exception.EtTimeoutException - if the mode is timed wait and the time has expired

org.jlab.coda.et.exception.EtWakeUpException - if the attachment has been commanded to wakeup, EventList.wakeUp(org.jlab.coda.et.system.AttachmentLocal), EventList.wakeUpAll()

newEvents

public EtEvent[] newEvents(EtAttachment att,
                  org.jlab.coda.et.enums.Mode mode,
                  boolean noBuffer,
                  int microSec,
                  int count,
                  int size,
                  int group)
                    throws org.jlab.coda.et.exception.EtException,
                           org.jlab.coda.et.exception.EtDeadException,
                           org.jlab.coda.et.exception.EtClosedException,
                           org.jlab.coda.et.exception.EtEmptyException,
                           org.jlab.coda.et.exception.EtBusyException,
                           org.jlab.coda.et.exception.EtTimeoutException,
                           org.jlab.coda.et.exception.EtWakeUpException,
                           java.io.IOException

Get new (unused) events from a specified group of such events in an ET system. Will access local C-based ET systems through JNI/shared memory, but other ET systems through sockets.

Parameters:

att - attachment object

mode - if there are no new events available, this parameter specifies whether to wait for some by sleeping Mode.SLEEP, to wait for a set time Mode.TIMED, or to return immediately Mode.ASYNC.

noBuffer - if true, the new events are to have no byte array and no associated ByteBuffer created. Also the user must supply the ByteBuffer using EtEventImpl.setDataBuffer(java.nio.ByteBuffer). Only used if connecting remotely.

microSec - the number of microseconds to wait if a timed wait is specified

count - the number of events desired

size - the size of events in bytes

group - group number from which to draw new events. Some ET systems have unused events divided into groups whose numbering starts at 1. For ET system not so divided, all events belong to group 1.

Returns:

an array of new events obtained from ET system. Count may be different from that requested.

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtException - if arguments have bad values; if attachment object is invalid; if group number is too high; for other general errors

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

org.jlab.coda.et.exception.EtEmptyException - if the mode is asynchronous and the station's input list is empty

org.jlab.coda.et.exception.EtBusyException - if the mode is asynchronous and the station's input list is being used (the mutex is locked)

org.jlab.coda.et.exception.EtTimeoutException - if the mode is timed wait and the time has expired

org.jlab.coda.et.exception.EtWakeUpException - if the attachment has been commanded to wakeup, EventList.wakeUp(org.jlab.coda.et.system.AttachmentLocal), EventList.wakeUpAll()

getEvents

public EtEvent[] getEvents(EtAttachment att,
                  org.jlab.coda.et.enums.Mode mode,
                  org.jlab.coda.et.enums.Modify modify,
                  int microSec,
                  int count)
                    throws org.jlab.coda.et.exception.EtException,
                           org.jlab.coda.et.exception.EtDeadException,
                           org.jlab.coda.et.exception.EtClosedException,
                           org.jlab.coda.et.exception.EtEmptyException,
                           org.jlab.coda.et.exception.EtBusyException,
                           org.jlab.coda.et.exception.EtTimeoutException,
                           org.jlab.coda.et.exception.EtWakeUpException,
                           java.io.IOException

Get events from an ET system. Will access local C-based ET systems through JNI/shared memory, but other ET systems through sockets. The data ByteBuffer object in each event has its limit set to the data length (not the buffer's full capacity).

NOTE: This method must implement the SLEEP mode using the TIMED mode when employing network communications due to the fact that we may block for extended periods of time will in a synchronized block of code. This would not allow other, vital methods to be called simultaneously (e.g. wakeUpAll(EtStation)).

Parameters:

att - attachment object

mode - if there are no new events available, this parameter specifies whether to wait for some by sleeping Mode.SLEEP, to wait for a set time Mode.TIMED, or to return immediately Mode.ASYNC.

modify - this specifies whether this application plans on modifying the data in events obtained Modify.ANYTHING, or only modifying headers Modify.HEADER. The default assumed ,Modify.NOTHING, is that no values are modified resulting in the events being put back into the ET system (by remote server) immediately upon being copied and that copy sent to this method's caller.

microSec - the number of microseconds to wait if a timed wait is specified

count - the number of events desired

Returns:

an array of events obtained from ET system. Count may be different from that requested.

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtException - if arguments have bad values; if the attachment's station is GRAND_CENTRAL; if the attachment object is invalid; for other general errors

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

org.jlab.coda.et.exception.EtEmptyException - if the mode is asynchronous and the station's input list is empty

org.jlab.coda.et.exception.EtBusyException - if the mode is asynchronous and the station's input list is being used (the mutex is locked)

org.jlab.coda.et.exception.EtTimeoutException - if the mode is timed wait and the time has expired

org.jlab.coda.et.exception.EtWakeUpException - if the attachment has been commanded to wakeup, EventList.wakeUp(org.jlab.coda.et.system.AttachmentLocal), EventList.wakeUpAll()

putEvents

public void putEvents(EtAttachment att,
             java.util.List<EtEvent> eventList)
               throws java.io.IOException,
                      org.jlab.coda.et.exception.EtException,
                      org.jlab.coda.et.exception.EtDeadException,
                      org.jlab.coda.et.exception.EtClosedException

Put events into an ET system. Will access local C-based ET systems through JNI/shared memory, but other ET systems through sockets.

Parameters:

att - attachment object

eventList - list of event objects

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtException - if invalid arg(s); if not connected to ET system; if events are not owned by this attachment;

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

putEvents

public void putEvents(EtAttachment att,
             EtEvent[] evs)
               throws java.io.IOException,
                      org.jlab.coda.et.exception.EtException,
                      org.jlab.coda.et.exception.EtDeadException,
                      org.jlab.coda.et.exception.EtClosedException

Put events into an ET system. Will access local C-based ET systems through JNI/shared memory, but other ET systems through sockets.

Parameters:

att - attachment object

evs - array of event objects

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtException - if invalid arg(s); if not connected to ET system; if events are not owned by this attachment;

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

putEvents

public void putEvents(EtAttachment att,
             EtEvent[] evs,
             int offset,
             int length)
               throws java.io.IOException,
                      org.jlab.coda.et.exception.EtException,
                      org.jlab.coda.et.exception.EtDeadException,
                      org.jlab.coda.et.exception.EtClosedException

Put events into an ET system. Will access local C-based ET systems through JNI/shared memory, but other ET systems through sockets.

Parameters:

att - attachment object

evs - array of event objects

offset - offset into array

length - number of array elements to put

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtException - if invalid arg(s); if events are not owned by this attachment; if null data buffer & whole event's being modified;

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

dumpEvents

public void dumpEvents(EtAttachment att,
              EtEvent[] evs)
                throws java.io.IOException,
                       org.jlab.coda.et.exception.EtException,
                       org.jlab.coda.et.exception.EtDeadException,
                       org.jlab.coda.et.exception.EtClosedException

Dispose of unwanted events in an ET system. The events are recycled and not made available to any other user. Will access local C-based ET systems through JNI/shared memory, but other ET systems through sockets.

Parameters:

att - attachment object

evs - array of event objects

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtException - if invalid arg(s); if not connected to ET system; if events are not owned by this attachment;

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

dumpEvents

public void dumpEvents(EtAttachment att,
              java.util.List<EtEvent> eventList)
                throws java.io.IOException,
                       org.jlab.coda.et.exception.EtException,
                       org.jlab.coda.et.exception.EtDeadException,
                       org.jlab.coda.et.exception.EtClosedException

Dispose of unwanted events in an ET system. The events are recycled and not made available to any other user. Will access local C-based ET systems through JNI/shared memory, but other ET systems through sockets.

Parameters:

att - attachment object

eventList - list of event objects

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtException - if invalid arg(s); if not connected to ET system; if events are not owned by this attachment;

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

dumpEvents

public void dumpEvents(EtAttachment att,
              EtEvent[] evs,
              int offset,
              int length)
                throws java.io.IOException,
                       org.jlab.coda.et.exception.EtException,
                       org.jlab.coda.et.exception.EtDeadException,
                       org.jlab.coda.et.exception.EtClosedException

Dispose of unwanted events in an ET system. The events are recycled and not made available to any other user. Will access local C-based ET systems through JNI/shared memory, but other ET systems through sockets.

Parameters:

att - attachment object

evs - array of event objects

offset - offset into array

length - number of array elements to put

Throws:

java.io.IOException - if problems with network communications

org.jlab.coda.et.exception.EtException - if invalid arg(s); if events are not owned by this attachment;

org.jlab.coda.et.exception.EtDeadException - if the ET system processes are dead

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

getNumStations

public int getNumStations()
                   throws java.io.IOException,
                          org.jlab.coda.et.exception.EtClosedException

Gets the number of stations in the ET system.

Returns:

number of stations in the ET system

Throws:

java.io.IOException - if there are problems with network communication

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

getStationsMax

public int getStationsMax()
                   throws java.io.IOException,
                          org.jlab.coda.et.exception.EtClosedException

Gets the maximum number of stations allowed in the ET system.

Returns:

maximum number of stations allowed in the ET system

Throws:

java.io.IOException - if there are problems with network communication

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

getNumAttachments

public int getNumAttachments()
                      throws java.io.IOException,
                             org.jlab.coda.et.exception.EtClosedException

Gets the number of attachments in the ET system.

Returns:

number of attachments in the ET system

Throws:

java.io.IOException - if there are problems with network communication

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

getAttachmentsMax

public int getAttachmentsMax()
                      throws java.io.IOException,
                             org.jlab.coda.et.exception.EtClosedException

Gets the maximum number of attachments allowed in the ET system.

Returns:

maximum number of attachments allowed in the ET system

Throws:

java.io.IOException - if there are problems with network communication

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

getNumProcesses

public int getNumProcesses()
                    throws java.io.IOException,
                           org.jlab.coda.et.exception.EtClosedException

Gets the number of local processes in the ET system. This is only relevant in C-language, Solaris systems.

Returns:

number of processes in the ET system

Throws:

java.io.IOException - if there are problems with network communication

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

getProcessesMax

public int getProcessesMax()
                    throws java.io.IOException,
                           org.jlab.coda.et.exception.EtClosedException

Gets the maximum number of local processes allowed in the ET system. This is only relevant in C-language, Solaris systems.

Returns:

maximum number of processes allowed in the ET system

Throws:

java.io.IOException - if there are problems with network communication

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

getNumTemps

public int getNumTemps()
                throws java.io.IOException,
                       org.jlab.coda.et.exception.EtClosedException

Gets the number of temp events in the ET system. This is only relevant in C-language systems.

Returns:

number of temp events in the ET system

Throws:

java.io.IOException - if there are problems with network communication

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

getTempsMax

public int getTempsMax()
                throws java.io.IOException,
                       org.jlab.coda.et.exception.EtClosedException

Gets the maximum number of temp events allowed in the ET system. This is only relevant in C-language systems.

Returns:

maximum number of temp events in the ET system

Throws:

java.io.IOException - if there are problems with network communication

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

getHeartbeat

public int getHeartbeat()
                 throws java.io.IOException,
                        org.jlab.coda.et.exception.EtClosedException

Gets the ET system heartbeat. This is only relevant in C-language systems.

Returns:

ET system heartbeat

Throws:

java.io.IOException - if there are problems with network communication

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

getPid

public int getPid()
           throws java.io.IOException,
                  org.jlab.coda.et.exception.EtClosedException

Gets the UNIX pid of the ET system process. This is only relevant in C-language systems.

Returns:

UNIX pid of the ET system process

Throws:

java.io.IOException - if there are problems with network communication

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

getGroupCount

public int getGroupCount()
                  throws java.io.IOException,
                         org.jlab.coda.et.exception.EtClosedException

Gets the number of groups events are divided into.

Returns:

number of groups events are divided into

Throws:

java.io.IOException - if there are problems with network communication

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

getGroups

public int[] getGroups()
                throws java.io.IOException,
                       org.jlab.coda.et.exception.EtClosedException

Gets the array defining groups events are divided into. The index+1 is the group number, the value is the number of events in that group.

Returns:

array defining groups events are divided into

Throws:

java.io.IOException - if there are problems with network communication

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

getNumEvents

public int getNumEvents()

Gets the number of events in the ET system.

Returns:

number of events in the ET system

getEventSize

public long getEventSize()

Gets the "normal" event size in bytes.

Returns:

normal event size in bytes

getLanguage

public int getLanguage()

Gets the ET system's implementation language.

Returns:

ET system's implementation language

getHost

public java.lang.String getHost()

Gets the ET system's host name.

Returns:

ET system's host name

getTcpPort

public int getTcpPort()

Gets the tcp server port number.

Returns:

tcp server port number

getData

public org.jlab.coda.et.data.AllData getData()
                                      throws org.jlab.coda.et.exception.EtException,
                                             java.io.IOException,
                                             org.jlab.coda.et.exception.EtClosedException

Gets all information about the ET system.

Returns:

object containing ET system information

Throws:

java.io.IOException - if there are problems with network communication

org.jlab.coda.et.exception.EtException - if error in data format/protocol

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed

getHistogram

public int[] getHistogram()
                   throws java.io.IOException,
                          org.jlab.coda.et.exception.EtException,
                          org.jlab.coda.et.exception.EtClosedException

Gets histogram containing data showing how many events in GRAND_CENTRAL's input list when new events are requested by users. This feature is not available on Java ET systems.

Returns:

integer array containing histogram

Throws:

java.io.IOException - if there are problems with network communication

org.jlab.coda.et.exception.EtException - if error in data format/protocol

org.jlab.coda.et.exception.EtClosedException - if the ET system is closed