org.jlab.coda.et
Class AttachmentData

java.lang.Object
  org.jlab.coda.et.AttachmentData

public class AttachmentData

extends java.lang.Object

This class holds all information about an attachment. It parses the information from a stream of data sent by an ET system.

Field Summary

(package private) int	blocked Flag indicating if this attachment is blocked waiting to read events.
(package private) long	eventsDump Number of events dumped (recycled by returning to GRAND_CENTRAL) through the station.
(package private) long	eventsGet Number of events gotten from the station.
(package private) long	eventsMake Number of new events gotten from the station.
(package private) int	eventsOwned The number of events owned by this attachment
(package private) long	eventsPut Number of events put back into the station.
(package private) java.lang.String	host Name of the host running this attachment.
(package private) int	num Attachment's id number.
(package private) int	pid Unix process id of the program that created this attachment (only relevant in C ET systems).
(package private) int	proc Id number of ET process that created this attachment (only relevant in C ET systems).
(package private) int	quit Flag indicating if this attachment has been told to quit trying to read events and return.
(package private) int	stat Id number of the attachment's station.
(package private) java.lang.String	stationName Name of the station this attachment is associated with.

Constructor Summary

AttachmentData()

Method Summary

boolean	blocked() Indicates if this attachment is blocked waiting to read events.
long	getEventsDump() Get the number of events dumped (recycled by returning to GRAND_CENTRAL) through the station.
long	getEventsGet() Get the number of events gotten from the station.
long	getEventsMake() Get the number of new events gotten from the station.
int	getEventsOwned() Get the number of events owned by this attachment
long	getEventsPut() Get the number of events put back into the station.
java.lang.String	getHost() Get the name of the host running this attachment.
int	getId() Get the attachment's id number.
int	getPid() Get the Unix process id of the program that created this attachment (only relevant in C ET systems).
int	getProc() Get the id number of ET process that created this attachment (only relevant in C ET systems).
int	getStationId() Get the id number of the station to which this attachment belongs.
java.lang.String	getStationName() Get the name of the station this attachment is associated with.
boolean	quitting() Indicates if this attachment has been told to quit trying to read events and return.
(package private) void	read(java.io.DataInputStream dis) Reads the attachment information from a data stream which is sent out by an ET system over the network.

Methods inherited from class java.lang.Object

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

Field Detail

num

int num

Attachment's id number.

See Also:

Attachment.id, AttachmentLocal.id

proc

int proc

Id number of ET process that created this attachment (only relevant in C ET systems).

stat

int stat

Id number of the attachment's station.

See Also:

Attachment.station, AttachmentLocal.station

pid

int pid

Unix process id of the program that created this attachment (only relevant in C ET systems).

See Also:

AttachmentLocal.pid

blocked

int blocked

Flag indicating if this attachment is blocked waiting to read events. Its value is Constants.attBlocked if blocked and Constants.attUnblocked otherwise. This is not boolean for C ET system compatibility.

See Also:

AttachmentLocal.waiting

quit

int quit

Flag indicating if this attachment has been told to quit trying to read events and return. Its value is Constants.attQuit if it has been told to quit and Constants.attContinue otherwise. This is not boolean for C ET system compatibility.

See Also:

AttachmentLocal.wakeUp

eventsOwned

int eventsOwned

The number of events owned by this attachment

eventsPut

long eventsPut

Number of events put back into the station.

See Also:

Attachment.getEventsPut(), AttachmentLocal.eventsPut

eventsGet

long eventsGet

Number of events gotten from the station.

See Also:

Attachment.getEventsGet(), AttachmentLocal.eventsGet

eventsDump

long eventsDump

Number of events dumped (recycled by returning to GRAND_CENTRAL) through the station.

See Also:

Attachment.getEventsDump(), AttachmentLocal.eventsDump

eventsMake

long eventsMake

Number of new events gotten from the station.

See Also:

Attachment.getEventsMake(), AttachmentLocal.eventsMake

host

java.lang.String host

Name of the host running this attachment.

See Also:

AttachmentLocal.host

stationName

java.lang.String stationName

Name of the station this attachment is associated with.

Constructor Detail

AttachmentData

public AttachmentData()

Method Detail

getId

public int getId()

Get the attachment's id number.

See Also:

Attachment.id, AttachmentLocal.id

getProc

public int getProc()

Get the id number of ET process that created this attachment (only relevant in C ET systems).

getStationId

public int getStationId()

Get the id number of the station to which this attachment belongs.

See Also:

Attachment.station, AttachmentLocal.station

getPid

public int getPid()

Get the Unix process id of the program that created this attachment (only relevant in C ET systems).

See Also:

AttachmentLocal.pid

blocked

public boolean blocked()

Indicates if this attachment is blocked waiting to read events.

See Also:

AttachmentLocal.waiting

quitting

public boolean quitting()

Indicates if this attachment has been told to quit trying to read events and return.

See Also:

AttachmentLocal.wakeUp

getEventsOwned

public int getEventsOwned()

Get the number of events owned by this attachment

getEventsPut

public long getEventsPut()

Get the number of events put back into the station.

See Also:

Attachment.getEventsPut(), AttachmentLocal.eventsPut

getEventsGet

public long getEventsGet()

Get the number of events gotten from the station.

See Also:

Attachment.getEventsGet(), AttachmentLocal.eventsGet

getEventsDump

public long getEventsDump()

Get the number of events dumped (recycled by returning to GRAND_CENTRAL) through the station.

See Also:

Attachment.getEventsDump(), AttachmentLocal.eventsDump

getEventsMake

public long getEventsMake()

Get the number of new events gotten from the station.

See Also:

Attachment.getEventsMake(), AttachmentLocal.eventsMake

getHost

public java.lang.String getHost()

Get the name of the host running this attachment.

See Also:

AttachmentLocal.host

getStationName

public java.lang.String getStationName()

Get the name of the station this attachment is associated with.

read

void read(java.io.DataInputStream dis)
    throws java.io.IOException

Reads the attachment information from a data stream which is sent out by an ET system over the network.

Parameters:

dis - data input stream

Throws:

java.io.IOException - if data stream read error