org.jlab.coda.et

Interface EtEvent

All Known Implementing Classes:

EtEventImpl

public interface EtEvent

Interface used to define methods necessary to be an Event.

Method Summary

Methods

Modifier and Type	Method and Description
org.jlab.coda.et.enums.Age	getAge() Gets the age of the event, either Age.NEW if a new event obtained through calling EtSystem.newEvents(EtAttachment, org.jlab.coda.et.enums.Mode, int, int, int) or Age.USED if obtained through calling EtSystem.getEvents(EtAttachment, org.jlab.coda.et.enums.Mode, org.jlab.coda.et.enums.Modify, int, int).
java.nio.ByteOrder	getByteOrder() Gets the event data's byte order.
int[]	getControl() Gets the event's control array.
byte[]	getData() Gets the data array which is backing the event's data buffer if there is one.
java.nio.ByteBuffer	getDataBuffer() Gets the event's data buffer.
org.jlab.coda.et.enums.DataStatus	getDataStatus() Gets the status of the data (set by the system), which can be OK DataStatus.OK, corrupted DataStatus.CORRUPT, or possibly corrupted DataStatus.POSSIBLYCORRUPT.
int	getGroup() Gets the group the event belongs to (1, 2, ...) if ET system events are divided into groups.
int	getId() Gets the event's id number.
int	getLength() Gets the length of the data in bytes.
int	getMemSize() Gets the size of the data buffer in bytes.
org.jlab.coda.et.enums.Modify	getModify() Gets the event's modify value when receiving it over the network.
int	getOwner() Gets the attachment id of the attachment which owns or got the event.
org.jlab.coda.et.enums.Priority	getPriority() Gets the event's priority, either high Priority.HIGH or low Priority.LOW.
int	getRawByteOrder() Gets the raw byte order data (0x04030201 or 0x01020304).
void	init() Initialize an event's fields.
boolean	needToSwap() Tells caller if the event data needs to be swapped in order to be the same byte order as the local JVM.
void	setByteOrder(java.nio.ByteOrder order) Set the event data's byte order.
void	setByteOrder(int endian) Set the event data's byte order by using values consistent with C-based ET systems, EtConstants.endianBig, EtConstants.endianLittle, EtConstants.endianLocal, EtConstants.endianNotLocal, or EtConstants.endianSwitch.
void	setControl(int[] con) Sets the event's control array by copying it into the event.
void	setLength(int len) Sets the event's data length in bytes.
void	setPriority(org.jlab.coda.et.enums.Priority pri) Sets the event's priority, either high Priority.HIGH or low Priority.LOW.
void	setRawByteOrder(int byteOrder) Set the event data's byte order as big with 0x04030201 or as little with 0x01020304.

Method Detail

init

void init()

Initialize an event's fields. Called for an event each time it passes through GRAND_CENTRAL station.

getId

int getId()

Gets the event's id number.

Returns:

event's id number.

getAge

org.jlab.coda.et.enums.Age getAge()

Gets the age of the event, either Age.NEW if a new event obtained through calling EtSystem.newEvents(EtAttachment, org.jlab.coda.et.enums.Mode, int, int, int) or Age.USED if obtained through calling EtSystem.getEvents(EtAttachment, org.jlab.coda.et.enums.Mode, org.jlab.coda.et.enums.Modify, int, int).

Returns:

age of the event.

getGroup

int getGroup()

Gets the group the event belongs to (1, 2, ...) if ET system events are divided into groups. If not, group = 1. Used so some producers don't hog events from others.

Returns:

the group the event belongs to.

getPriority

org.jlab.coda.et.enums.Priority getPriority()

Gets the event's priority, either high Priority.HIGH or low Priority.LOW. Low priority is normal while high priority events get placed at the front of stations' input and output event lists.

Returns:

event's priority.

getMemSize

int getMemSize()

Gets the size of the data buffer in bytes.

Returns:

size of the data buffer in bytes

getLength

int getLength()

Gets the length of the data in bytes.

Returns:

length of the data in bytes.

getDataStatus

org.jlab.coda.et.enums.DataStatus getDataStatus()

Gets the status of the data (set by the system), which can be OK DataStatus.OK, corrupted DataStatus.CORRUPT, or possibly corrupted DataStatus.POSSIBLYCORRUPT. Data is OK by default, it is never labeled as corrupt but can be labeled as possible corrupt if the process owning an event crashes and the system recovers it.

Returns:

status of the data.

getModify

org.jlab.coda.et.enums.Modify getModify()

Gets the event's modify value when receiving it over the network. This specifies whether the user wants to read the event only, will modify only the event header (everything except the data), or will modify the data and/or header. Modifying the data and/or header is Modify.ANYTHING, modifying only the header is Modify.HEADER, else the default assumed, Modify.NOTHING, is that nothing is modified resulting in this event being put back into the ET system (by remote server) immediately upon being copied and that copy sent to the user.

Returns:

event's modify value.

getControl

int[] getControl()

Gets the event's control array. This is an array of integers which can be used for any purpose by the user.

Returns:

event's control array.

getData

byte[] getData()
               throws java.lang.UnsupportedOperationException

Gets the data array which is backing the event's data buffer if there is one. Any changes to the array will be reflected in the buffer. If there is no backing data array, as is the case when a user connects to a local, C-based ET system (memory mapped buffer) then an exception is thrown.

Returns:

data array which is backing the event's data buffer

Throws:

java.lang.UnsupportedOperationException - if there is no backing array

getDataBuffer

java.nio.ByteBuffer getDataBuffer()

Gets the event's data buffer.

Returns:

event's data buffer.

getOwner

int getOwner()

Gets the attachment id of the attachment which owns or got the event. If it's owned by the system its value is EtConstants.system.

Returns:

id of owning attachment or EtConstants.system if system owns it

getByteOrder

java.nio.ByteOrder getByteOrder()

Gets the event data's byte order.

Returns:

event data's byte order

getRawByteOrder

int getRawByteOrder()

Gets the raw byte order data (0x04030201 or 0x01020304).

Returns:

raw byte order data (0x04030201 or 0x01020304).

setPriority

void setPriority(org.jlab.coda.et.enums.Priority pri)

Sets the event's priority, either high Priority.HIGH or low Priority.LOW. Low priority is normal while high priority events get placed at the front of stations' input and output event lists.

Parameters:

pri - event priority

setLength

void setLength(int len)
               throws org.jlab.coda.et.exception.EtException

Sets the event's data length in bytes.

Parameters:

len - data length

Throws:

org.jlab.coda.et.exception.EtException - if length is less than zero

setControl

void setControl(int[] con)
                throws org.jlab.coda.et.exception.EtException

Sets the event's control array by copying it into the event.

Parameters:

con - control array

Throws:

org.jlab.coda.et.exception.EtException - if control array has the wrong number of elements

setByteOrder

void setByteOrder(java.nio.ByteOrder order)

Set the event data's byte order.

Parameters:

order - data's byte order

setByteOrder

void setByteOrder(int endian)
                  throws org.jlab.coda.et.exception.EtException

Set the event data's byte order by using values consistent with C-based ET systems, EtConstants.endianBig, EtConstants.endianLittle, EtConstants.endianLocal, EtConstants.endianNotLocal, or EtConstants.endianSwitch.

Parameters:

endian - endian value

Throws:

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

setRawByteOrder

void setRawByteOrder(int byteOrder)
                     throws org.jlab.coda.et.exception.EtException

Set the event data's byte order as big with 0x04030201 or as little with 0x01020304.

Parameters:

byteOrder - data's byte order as big with 0x04030201 or as little with 0x01020304.

Throws:

org.jlab.coda.et.exception.EtException

needToSwap

boolean needToSwap()

Tells caller if the event data needs to be swapped in order to be the same byte order as the local JVM.

Returns:

true if swapping is needed, otherwise false