DataChannelAdapter

java.lang.Object
- org.jlab.coda.emu.support.codaComponent.CODAStateMachineAdapter
- - org.jlab.coda.emu.support.transport.DataChannelAdapter

All Implemented Interfaces:

CODAStateMachine, StatedObject, DataChannel

Direct Known Subclasses:

DataChannelImplCmsg, DataChannelImplEmu, DataChannelImplEt, DataChannelImplFifo, DataChannelImplFile
```
public abstract class DataChannelAdapter
extends CODAStateMachineAdapter
implements DataChannel
```
This class provides boilerplate code for the DataChannel interface (which includes the CODAStateMachine interface). Extending this class implements the DataChannel interface and frees any subclass from having to implement common methods or those that aren't used.
This class defines an object that can send and receive banks of data in the CODA evio format. It refers to a particular connection (eg. an et open or cMsg connection id).

Author:

timmer (Apr 25, 2013)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class DataChannelAdapter.ThreadState
Keep track of output channel thread's state.

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`DataChannelAdapter.ThreadState` Keep track of output channel thread's state.

Field Summary

Fields
Modifier and Type	Field and Description
`protected long[]`	`availableSequences` Maximum index of available ring items.
`protected java.lang.String[]`	`bAddrList` List of broadcast addresses corresponding to ipAddrList.
`protected double`	`buffersPerSec` Number of buffers per second of data to write over the output channel.
`protected java.nio.ByteOrder`	`byteOrder` Byte order of output data.
`protected CODAStateIF`	`channelState` Channel state.
`protected DataTransport`	`dataTransport` Object used by Emu to create this channel.
`protected Emu`	`emu` EMU object that created this channel.
`protected EmuEventNotify`	`endCallback` Object used by Emu to be notified of END event arrival.
`protected java.util.concurrent.atomic.AtomicReference<java.lang.String>`	`errorMsg` Channel error message.
`protected int`	`eventsPerBuffer` Number of events to place into one data buffer for the output channel.
`protected boolean`	`gotEndCmd` Got END command from Run Control.
`protected boolean`	`gotResetCmd` Got RESET command from Run Control.
`protected int`	`id` Channel id (corresponds to sourceId of ROCs for CODA event building).
`protected boolean`	`ignoreDataErrors` Any error reading/parsing data can be ignored if true.
`protected boolean`	`input` Is this channel an input (true) or output (false) channel?
`protected int`	`inputRingItemCount` Number of items in input ring buffer.
`protected java.lang.String[]`	`ipAddrList` List of destination IP addresses.
`protected boolean`	`isFifo` Is this channel an input or output fifo channel? Convenience variable.
`protected Logger`	`logger` Logger associated with this EMU (convenience member).
`protected EmuModule`	`module` Module to which this channel belongs.
`protected java.lang.String`	`name` Channel name
`protected long`	`nanoSecPerBuf` Number of milliseconds between each buffer being sent.
`protected long`	`nextEvent` Number of the module's buildable event produced which this channel will output next (starting at 0).
`protected long[]`	`nextSequences` Index of next ring item.
`protected int`	`outputChannelCount` Total number of module's output channels.
`protected int[]`	`outputChannelFill` Number of entries (filled slots) in each ring buffer of this output channel.
`protected int`	`outputIndex` This output channel's order in relation to the other output channels for module, starting at 0.
`protected int`	`outputModuleInternalRingCount` Number of items in output channel's internal ByteBuffer supplies.
`protected int`	`outputRingCount` Total number of module's event-building threads and therefore output ring buffers.
`protected int`	`outputRingItemCount` Number of items in output ring buffers.
`protected boolean`	`pause` Do we pause the dataThread?
`protected int`	`prescale` For ET output channel of ER, select a prescaled number of events to be sent.
`protected EmuEventNotify`	`prestartCallback` Object used by Emu to be notified of PRESTART event arrival.
`protected int`	`recordId` Record id (corresponds to evio events flowing through data channel).
`protected boolean`	`regulateBufferRate` Use both bufsPerSec and eventsPerBuffer to regulate the data flow out of this channel.
`protected com.lmax.disruptor.RingBuffer<RingItem>`	`ringBufferIn` Ring buffer - one per input channel.
`protected com.lmax.disruptor.RingBuffer<RingItem>[]`	`ringBuffersOut` Array holding all ring buffers for output.
`protected int`	`ringIndex` Ring that the next event will show up on.
`protected com.lmax.disruptor.SequenceBarrier[]`	`sequenceBarriers` One barrier for each output ring.
`protected com.lmax.disruptor.Sequence[]`	`sequences` One sequence for each output ring.
`protected boolean`	`singleEventOut` If we're a PEB or SEB and want to send 1 evio event per et-buffer/cmsg-message, then this is true.
`protected int`	`totalRingCapacity` Total number of slots in all output channel ring buffers.

Constructor Summary

Constructors
Constructor and Description
`DataChannelAdapter(java.lang.String name, DataTransport transport, java.util.Map<java.lang.String,java.lang.String> attributeMap, boolean input, Emu emu, EmuModule module, int outputIndex)` Constructor to create a new DataChannel instance.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`DataTransport`	`getDataTransport()` Get the DataTransport object used to create this data channel.
`EmuEventNotify`	`getEndCallback()` This method gets the callback object previously registered by the caller used to notify upon the arrival of an END event.
`java.lang.String`	`getError()` Get any available error information.
`int`	`getID()` Get the CODA ID number of the CODA component connected to this data channel.
`int`	`getInputLevel()` Get the relative fill level (0-100) of the ring of this input channel.
`EmuModule`	`getModule()` Get the module which created this channel.
`protected RingItem`	`getNextOutputRingItem(int ringIndex)` Gets the next ring buffer item placed there by the last module.
`long`	`getNextSequence(int ringIndex)`
`int`	`getOutputLevel()` Get the relative fill level (0-100) of all the rings of this output channel.
`int`	`getOutputRingCount()` Get the total number of data-holding output ring buffers.
`int`	`getPrescale()` Get the prescale value associated with this channel.
`EmuEventNotify`	`getPrestartCallback()` This method gets the callback object previously registered by the caller used to notify upon the arrival of a PRESTART event.
`int`	`getRecordId()` Get the record ID number of the latest event through this channel.
`com.lmax.disruptor.RingBuffer<RingItem>`	`getRingBufferIn()` Get the one and only input ring buffer of this data channel.
`com.lmax.disruptor.RingBuffer<RingItem>[]`	`getRingBuffersOut()` Get the array of output ring buffers.
`abstract TransportType`	`getTransportType()` Get the type of transport this channel implements.
`protected void`	`gotoNextRingItem(int ringIndex)` It prepares to get the next ring item after `getNextOutputRingItem(int)` is called.
`boolean`	`isInput()` Get whether this channel is an input channel (true), or it is an output channel (false).
`java.lang.String`	`name()` Get the name of this data channel.
`void`	`prestart()` This method implements the PRESTART transition of the CODA run control state machine.
`void`	`registerEndCallback(EmuEventNotify callback)` This method allows for setting a object used to notify the caller when an END event has arrived (or any other occurrence for that matter).
`void`	`registerPrestartCallback(EmuEventNotify callback)` This method allows for setting a object used to notify the caller when a PRESTART event has arrived (or any other occurrence for that matter).
`void`	`regulateOutputBufferRate(int eventsPerBuffer, double buffersPerSec)` Turn on regulation of the flow of data through an output channel.
`protected void`	`releaseCurrentAndGoToNextOutputRingItem(int ringIndex)` Releases the item obtained by calling `getNextOutputRingItem(int)`, so that it may be reused for writing into by the last module.
`protected void`	`releaseOutputRingItem(int ringIndex)` Releases the item obtained by calling `getNextOutputRingItem(int)`, so that it may be reused for writing into by the last module.
`protected void`	`sequentialReleaseOutputRingItem(byte[] ringIndexes, long[] seqs, int len)` Releases the items obtained by calling `getNextOutputRingItem(int)`, so that it may be reused for writing into by the last module.
`void`	`setDestinationBaList(java.lang.String[] baList)` Set the output channel's list of destination broadcast addresses of emu TCP server when using emu sockets to communicate - each corresponding to the same element of the IpList.
`void`	`setDestinationIpList(java.lang.String[] ipList)` Set the output channel's list of possible destination IP addresses of emu TCP server when using emu sockets to communicate.
`protected int`	`setNextEventAndRing()` Set the index of the next buildable event to get from the module and the ring it will appear on.
`void`	`setRecordId(int recordId)` Set the record ID number of the latest event through this channel.
`(package private) void`	`setupInputRingBuffers()` Setup the input channel ring buffers.
`(package private) void`	`setupOutputRingBuffers()` Setup the output channel ring buffers.
`CODAStateIF`	`state()` Get the state of this object.

Methods inherited from class org.jlab.coda.emu.support.codaComponent.CODAStateMachineAdapter
download, end, go, pause, reset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jlab.coda.emu.support.codaComponent.CODAStateMachine
download, end, go, pause, reset

- Field Detail
  - id
```
protected int id
```
    Channel id (corresponds to sourceId of ROCs for CODA event building).
  - recordId
```
protected int recordId
```
    Record id (corresponds to evio events flowing through data channel).
  - prescale
```
protected int prescale
```
    For ET output channel of ER, select a prescaled number of events to be sent.
  - singleEventOut
```
protected boolean singleEventOut
```
    If we're a PEB or SEB and want to send 1 evio event per et-buffer/cmsg-message, then this is true. If we want to cram as many evio events as possible in each et-buffer/cmsg-message, then this is false. In the EMU domain, do we send out individual events (true) or do we marshall them into one evio-file-format buffer (false)?
  - channelState
```
protected CODAStateIF channelState
```
    Channel state.
  - errorMsg
```
protected java.util.concurrent.atomic.AtomicReference<java.lang.String> errorMsg
```
    Channel error message. reset() sets it back to null. Making this an atomically settable String ensures that only 1 thread at a time can change its value. That way it's only set once per error.
  - name
```
protected final java.lang.String name
```
    Channel name
  - ignoreDataErrors
```
protected boolean ignoreDataErrors
```
    Any error reading/parsing data can be ignored if true. Currently this is only implemented for ER's ET input channel if the main data is coming over another input (presumably emu socket) channel.
  - isFifo
```
protected final boolean isFifo
```
    Is this channel an input or output fifo channel? Convenience variable.
  - input
```
protected final boolean input
```
    Is this channel an input (true) or output (false) channel?
  - emu
```
protected final Emu emu
```
    EMU object that created this channel.
  - logger
```
protected final Logger logger
```
    Logger associated with this EMU (convenience member).
  - byteOrder
```
protected java.nio.ByteOrder byteOrder
```
    Byte order of output data.
  - endCallback
```
protected EmuEventNotify endCallback
```
    Object used by Emu to be notified of END event arrival.
  - prestartCallback
```
protected EmuEventNotify prestartCallback
```
    Object used by Emu to be notified of PRESTART event arrival.
  - module
```
protected final EmuModule module
```
    Module to which this channel belongs.
  - dataTransport
```
protected final DataTransport dataTransport
```
    Object used by Emu to create this channel.
  - pause
```
protected volatile boolean pause
```
    Do we pause the dataThread?
  - gotEndCmd
```
protected volatile boolean gotEndCmd
```
    Got END command from Run Control.
  - gotResetCmd
```
protected volatile boolean gotResetCmd
```
    Got RESET command from Run Control.
  - ipAddrList
```
protected java.lang.String[] ipAddrList
```
    List of destination IP addresses.
  - bAddrList
```
protected java.lang.String[] bAddrList
```
    List of broadcast addresses corresponding to ipAddrList.
  - regulateBufferRate
```
protected boolean regulateBufferRate
```
    Use both bufsPerSec and eventsPerBuffer to regulate the data flow out of this channel.
  - buffersPerSec
```
protected double buffersPerSec
```
    Number of buffers per second of data to write over the output channel.
  - nanoSecPerBuf
```
protected long nanoSecPerBuf
```
    Number of milliseconds between each buffer being sent.
  - eventsPerBuffer
```
protected int eventsPerBuffer
```
    Number of events to place into one data buffer for the output channel.
  - outputChannelCount
```
protected int outputChannelCount
```
    Total number of module's output channels.
  - outputRingCount
```
protected int outputRingCount
```
    Total number of module's event-building threads and therefore output ring buffers.
  - outputIndex
```
protected int outputIndex
```
    This output channel's order in relation to the other output channels for module, starting at 0. First event goes to channel 0, etc.
  - ringIndex
```
protected int ringIndex
```
    Ring that the next event will show up on.
  - nextEvent
```
protected long nextEvent
```
    Number of the module's buildable event produced which this channel will output next (starting at 0). Depends on the # of output channels as well as the order of this channel (outputIndex).
  - ringBufferIn
```
protected com.lmax.disruptor.RingBuffer<RingItem> ringBufferIn
```
    Ring buffer - one per input channel.
  - inputRingItemCount
```
protected int inputRingItemCount
```
    Number of items in input ring buffer.
  - ringBuffersOut
```
protected com.lmax.disruptor.RingBuffer<RingItem>[] ringBuffersOut
```
    Array holding all ring buffers for output.
  - outputRingItemCount
```
protected int outputRingItemCount
```
    Number of items in output ring buffers.
  - outputModuleInternalRingCount
```
protected int outputModuleInternalRingCount
```
    Number of items in output channel's internal ByteBuffer supplies.
  - sequenceBarriers
```
protected com.lmax.disruptor.SequenceBarrier[] sequenceBarriers
```
    One barrier for each output ring.
  - sequences
```
protected com.lmax.disruptor.Sequence[] sequences
```
    One sequence for each output ring.
  - nextSequences
```
protected long[] nextSequences
```
    Index of next ring item.
  - availableSequences
```
protected long[] availableSequences
```
    Maximum index of available ring items.
  - outputChannelFill
```
protected int[] outputChannelFill
```
    Number of entries (filled slots) in each ring buffer of this output channel.
  - totalRingCapacity
```
protected int totalRingCapacity
```
    Total number of slots in all output channel ring buffers.
- Constructor Detail
  - DataChannelAdapter
```
public DataChannelAdapter(java.lang.String name,
                          DataTransport transport,
                          java.util.Map<java.lang.String,java.lang.String> attributeMap,
                          boolean input,
                          Emu emu,
                          EmuModule module,
                          int outputIndex)
```
    Constructor to create a new DataChannel instance. Used only by a transport's createChannel() method which is only called during PRESTART in the Emu.
    
    Parameters:
    
    name - the name of this channel
    
    transport - the DataTransport object that this channel belongs to
    
    attributeMap - the hashmap of config file attributes for this channel
    
    input - true if this is an input data channel, otherwise false
    
    emu - emu this channel belongs to
    
    module - module this channel belongs to
    
    outputIndex - order in which module's events will be sent to this output channel (0 for first output channel, 1 for next, etc.).
- Method Detail
  - setupOutputRingBuffers
```
void setupOutputRingBuffers()
```
    Setup the output channel ring buffers.
  - setupInputRingBuffers
```
void setupInputRingBuffers()
```
    Setup the input channel ring buffers.
  - prestart
```
public void prestart()
              throws CmdExecException
```
    This method implements the PRESTART transition of the CODA run control state machine.
    
    Specified by:
    
    prestart in interface CODAStateMachine
    
    Overrides:
    
    prestart in class CODAStateMachineAdapter
    
    Throws:
    
    CmdExecException - if error during command execution.
  - setNextEventAndRing
```
protected int setNextEventAndRing()
```
    Set the index of the next buildable event to get from the module and the ring it will appear on.
    NOTE: only called IFF outputRingCount > 1.
    
    Returns:
    
    index of ring that next event will be placed in
  - getTransportType
```
public abstract TransportType getTransportType()
```
    Get the type of transport this channel implements.
    
    Specified by:
    
    getTransportType in interface DataChannel
    
    Returns:
    
    type of transport this channel implements.
  - getModule
```
public EmuModule getModule()
```
    Get the module which created this channel.
    
    Specified by:
    
    getModule in interface DataChannel
    
    Returns:
    
    module which created this channel.
  - getID
```
public int getID()
```
    Get the CODA ID number of the CODA component connected to this data channel. In event building, this is used, for example, to check the ROC id of incoming event which allows consistency checking.
    
    Specified by:
    
    getID in interface DataChannel
    
    Returns:
    
    the CODA ID number the CODA component connected to this data channel.
  - getRecordId
```
public int getRecordId()
```
    Get the record ID number of the latest event through this channel. In CODA event building this is used, for example, to track the record ids for input events which allows consistency checks of incoming data.
    
    Specified by:
    
    getRecordId in interface DataChannel
    
    Returns:
    
    the record ID number of the latest event through channel.
  - setRecordId
```
public void setRecordId(int recordId)
```
    Set the record ID number of the latest event through this channel.
    
    Specified by:
    
    setRecordId in interface DataChannel
    
    Parameters:
    
    recordId - record ID number of the latest event through channel.
  - state
```
public CODAStateIF state()
```
    Get the state of this object.
    
    Specified by:
    
    state in interface StatedObject
    
    Returns:
    
    the state of this object
  - getError
```
public java.lang.String getError()
```
    Get any available error information.
    
    Specified by:
    
    getError in interface StatedObject
    
    Returns:
    
    any available error information; null if none
  - name
```
public java.lang.String name()
```
    Get the name of this data channel.
    
    Specified by:
    
    name in interface DataChannel
    
    Returns:
    
    the name of this data channel.
  - isInput
```
public boolean isInput()
```
    Get whether this channel is an input channel (true), or it is an output channel (false).
    
    Specified by:
    
    isInput in interface DataChannel
    
    Returns:
    
    true if input channel, else false
  - getDataTransport
```
public DataTransport getDataTransport()
```
    Get the DataTransport object used to create this data channel.
    
    Specified by:
    
    getDataTransport in interface DataChannel
    
    Returns:
    
    the DataTransport object used to create this data channel.
  - getOutputRingCount
```
public int getOutputRingCount()
```
    Get the total number of data-holding output ring buffers.
    
    Specified by:
    
    getOutputRingCount in interface DataChannel
    
    Returns:
    
    total number of data-holding output ring buffers.
  - getRingBufferIn
```
public com.lmax.disruptor.RingBuffer<RingItem> getRingBufferIn()
```
    Get the one and only input ring buffer of this data channel.
    
    Specified by:
    
    getRingBufferIn in interface DataChannel
    
    Returns:
    
    the input ring buffer.
  - getRingBuffersOut
```
public com.lmax.disruptor.RingBuffer<RingItem>[] getRingBuffersOut()
```
    Get the array of output ring buffers.
    
    Specified by:
    
    getRingBuffersOut in interface DataChannel
    
    Returns:
    
    array of output ring buffers.
  - registerEndCallback
```
public void registerEndCallback(EmuEventNotify callback)
```
    This method allows for setting a object used to notify the caller when an END event has arrived (or any other occurrence for that matter).
    
    Specified by:
    
    registerEndCallback in interface CODAStateMachine
    
    Overrides:
    
    registerEndCallback in class CODAStateMachineAdapter
    
    Parameters:
    
    callback - object used for notifying caller.
  - getEndCallback
```
public EmuEventNotify getEndCallback()
```
    This method gets the callback object previously registered by the caller used to notify upon the arrival of an END event.
    
    Specified by:
    
    getEndCallback in interface CODAStateMachine
    
    Overrides:
    
    getEndCallback in class CODAStateMachineAdapter
    
    Returns:
    
    object used for notifying caller.
  - registerPrestartCallback
```
public void registerPrestartCallback(EmuEventNotify callback)
```
    This method allows for setting a object used to notify the caller when a PRESTART event has arrived (or any other occurrence for that matter).
    
    Specified by:
    
    registerPrestartCallback in interface CODAStateMachine
    
    Overrides:
    
    registerPrestartCallback in class CODAStateMachineAdapter
    
    Parameters:
    
    callback - object used for notifying caller.
  - getPrestartCallback
```
public EmuEventNotify getPrestartCallback()
```
    This method gets the callback object previously registered by the caller used to notify upon the arrival of a PRESTART event.
    
    Specified by:
    
    getPrestartCallback in interface CODAStateMachine
    
    Overrides:
    
    getPrestartCallback in class CODAStateMachineAdapter
    
    Returns:
    
    object used for notifying caller.
  - getNextSequence
```
public long getNextSequence(int ringIndex)
```
  - getInputLevel
```
public int getInputLevel()
```
    Get the relative fill level (0-100) of the ring of this input channel.
    
    Specified by:
    
    getInputLevel in interface DataChannel
    
    Returns:
    
    relative fill level (0-100) of all the ring.
  - getOutputLevel
```
public int getOutputLevel()
```
    Get the relative fill level (0-100) of all the rings of this output channel. Module calls this to report its output channels' levels. (Input levels are associated directly with the module).
    
    Specified by:
    
    getOutputLevel in interface DataChannel
    
    Returns:
    
    relative fill level (0-100) of all the rings together.
  - setDestinationIpList
```
public void setDestinationIpList(java.lang.String[] ipList)
```
    Set the output channel's list of possible destination IP addresses of emu TCP server when using emu sockets to communicate.
    
    Specified by:
    
    setDestinationIpList in interface DataChannel
    
    Parameters:
    
    ipList - list of possible destination IP addresses if connecting to server.
  - setDestinationBaList
```
public void setDestinationBaList(java.lang.String[] baList)
```
    Set the output channel's list of destination broadcast addresses of emu TCP server when using emu sockets to communicate - each corresponding to the same element of the IpList.
    
    Specified by:
    
    setDestinationBaList in interface DataChannel
    
    Parameters:
    
    baList - list of destination broadcast addresses each corresponding to the same element of the IpList.
  - getPrescale
```
public int getPrescale()
```
    Get the prescale value associated with this channel. Defaults to 1. Used only for ET output of ER.
    
    Specified by:
    
    getPrescale in interface DataChannel
    
    Returns:
    
    prescale value associated with this channel.
  - regulateOutputBufferRate
```
public void regulateOutputBufferRate(int eventsPerBuffer,
                                     double buffersPerSec)
```
    Turn on regulation of the flow of data through an output channel. Currently this is implemented only for the emu socket channel - for testing purposes. It sets the rate of output buffers (typically 4MB each) and specifies the number of ROC (entangled) events per buffer.
    
    Specified by:
    
    regulateOutputBufferRate in interface DataChannel
    
    Parameters:
    
    eventsPerBuffer - events per output 4 MB buffer.
    
    buffersPerSec - desired number of buffers to be sent per second.
  - getNextOutputRingItem
```
protected RingItem getNextOutputRingItem(int ringIndex)
                                  throws java.lang.InterruptedException,
                                         EmuException
```
    Gets the next ring buffer item placed there by the last module. Only call from one thread. MUST be followed by call to releaseOutputRingItem(int) AFTER the returned item is used or nothing will work right.
    
    Parameters:
    
    ringIndex - ring buffer to take item from
    
    Returns:
    
    next ring buffer item
    
    Throws:
    
    java.lang.InterruptedException - if thread interrupted.
    
    EmuException - problem with the ring buffer.
  - releaseCurrentAndGoToNextOutputRingItem
```
protected void releaseCurrentAndGoToNextOutputRingItem(int ringIndex)
```
    Releases the item obtained by calling getNextOutputRingItem(int), so that it may be reused for writing into by the last module. And it prepares to get the next ring item when that method is called. Must NOT be used in conjunction with releaseOutputRingItem(int) and gotoNextRingItem(int).
    
    Parameters:
    
    ringIndex - ring buffer to release item to
  - releaseOutputRingItem
```
protected void releaseOutputRingItem(int ringIndex)
```
    Releases the item obtained by calling getNextOutputRingItem(int), so that it may be reused for writing into by the last module. Must NOT be used in conjunction with releaseCurrentAndGoToNextOutputRingItem(int) and must be called after gotoNextRingItem(int).
    
    Parameters:
    
    ringIndex - ring buffer to release item to
  - gotoNextRingItem
```
protected void gotoNextRingItem(int ringIndex)
```
    It prepares to get the next ring item after getNextOutputRingItem(int) is called. Must NOT be used in conjunction with releaseCurrentAndGoToNextOutputRingItem(int) and must be called before releaseOutputRingItem(int).
    
    Parameters:
    
    ringIndex - ring buffer to release item to
  - sequentialReleaseOutputRingItem
```
protected void sequentialReleaseOutputRingItem(byte[] ringIndexes,
                                               long[] seqs,
                                               int len)
```
    Releases the items obtained by calling getNextOutputRingItem(int), so that it may be reused for writing into by the last module. Must NOT be used in conjunction with releaseCurrentAndGoToNextOutputRingItem(int) or releaseOutputRingItem(int) and must be called after gotoNextRingItem(int).
    This method ensures that sequences are released in order and is thread-safe. Only works if each ring item is released individually.
    
    Parameters:
    
    ringIndexes - array of ring buffers to release item to
    
    seqs - array of sequences to release.
    
    len - number of array items to release

Class DataChannelAdapter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.jlab.coda.emu.support.codaComponent.CODAStateMachineAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface org.jlab.coda.emu.support.codaComponent.CODAStateMachine

Field Detail

id

recordId

prescale

singleEventOut

channelState

errorMsg

name

ignoreDataErrors

isFifo

input

emu

logger

byteOrder

endCallback

prestartCallback

module

dataTransport

pause

gotEndCmd

gotResetCmd

ipAddrList

bAddrList

regulateBufferRate

buffersPerSec

nanoSecPerBuf

eventsPerBuffer

outputChannelCount

outputRingCount

outputIndex

ringIndex

nextEvent

ringBufferIn

inputRingItemCount

ringBuffersOut

outputRingItemCount

outputModuleInternalRingCount

sequenceBarriers

sequences

nextSequences

availableSequences

outputChannelFill

totalRingCapacity

Constructor Detail

DataChannelAdapter

Method Detail

setupOutputRingBuffers

setupInputRingBuffers

prestart

setNextEventAndRing

getTransportType

getModule

getID

getRecordId

setRecordId

state

getError

name

isInput

getDataTransport

getOutputRingCount

getRingBufferIn

getRingBuffersOut

registerEndCallback

getEndCallback

registerPrestartCallback

getPrestartCallback

getNextSequence

getInputLevel

getOutputLevel

setDestinationIpList

setDestinationBaList